forked from microsoft/QuantumKatas
-
Notifications
You must be signed in to change notification settings - Fork 0
/
qsharp-quick-reference.tex
273 lines (234 loc) · 12.1 KB
/
qsharp-quick-reference.tex
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
% Copyright (c) Microsoft Corporation. All rights reserved.
% Licensed under the MIT License.
%!TEX program=xelatex
% This cheatsheet is based on the template
% provided at https://gist.github.com/alexander-yakushev/c773543bf9a957749f79.
\documentclass[10pt,english,landscape]{article}
\usepackage{multicol}
\usepackage{calc}
\usepackage[landscape]{geometry}
\usepackage{color,graphicx,overpic}
% https://tex.stackexchange.com/a/192067
\usepackage{fontawesome}
\newfontfamily{\FA}{[FontAwesome.otf]}
% Known issue in {fontspec}: https://github.com/wspr/fontspec/issues/312#issuecomment-342125206
% Since {fontspec} is included only when compiling with XeTeX, we guard
% our fix accordingly.
\usepackage{ifxetex}
\ifxetex
\let\latinencoding\relax
\usepackage{fontspec}
\setmainfont{Segoe UI}
\setmonofont{Consolas}
\fi
% \usepackage[T1]{fontenc}
% \usepackage[bitstream-charter]{mathdesign}
\usepackage[utf8]{inputenc}
\usepackage{url}
\usepackage{amsfonts}
\usepackage{array,booktabs}
\usepackage{textcomp}
\usepackage[usenames,dvipsnames,table]{xcolor}
\usepackage[most]{tcolorbox}
\usepackage{menukeys}
\usepackage{tabularx}
\usepackage{multirow}
\usepackage{colortbl}
\usepackage{tikz}
\usepackage{environ}
\usepackage{braket}
\usetikzlibrary{calc}
\pgfdeclarelayer{background}
\pgfdeclarelayer{foreground}
\pgfsetlayers{background,main,foreground}
\geometry{top=-0.5cm,left=1cm,right=1cm,bottom=1cm}
\pagestyle{empty} % Turn off header and footer
% \renewcommand\rmdefault{phv} % Arial
% \renewcommand\sfdefault{phv} % Arial
% Redefine section commands to use less space
\makeatletter
\renewcommand{\section}{\@startsection{section}{1}{0mm}%
{-1ex plus -.5ex minus -.2ex}%
{0.5ex plus .2ex}%x
{\normalfont\large\bfseries}}
\renewcommand{\subsection}{\@startsection{subsection}{2}{0mm}%
{-1explus -.5ex minus -.2ex}%
{0.5ex plus .2ex}%
{\normalfont\normalsize\bfseries}}
\renewcommand{\subsubsection}{\@startsection{subsubsection}{3}{0mm}%
{-1ex plus -.5ex minus -.2ex}%
{1ex plus .2ex}%
{\normalfont\small\bfseries}}
\makeatother
\setcounter{secnumdepth}{0} % Don't print section numbers
\setlength{\parindent}{0pt}
\setlength{\parskip}{0pt plus 0.5ex}
\definecolor{TableHead}{rgb}{0.353, 0.329, 0.667}
\definecolor{TableRow}{rgb}{0.816, 0.812, 0.902}
\NewEnviron{keysref}[1]{
% \begin{center}
\smallskip
\begin{tikzpicture}
\rowcolors{1}{}{TableRow}
\node (tbl) [inner sep=0pt] {
\begin{tabular}{p{2.5cm}p{5.05cm}}
\rowcolor{TableHead}
\multicolumn{2}{l}{\normalsize\textbf{\color{white}{#1}}}\parbox{0pt}{\rule{0pt}{0.3ex+\baselineskip}}\\
\BODY
\arrayrulecolor{TableHead}\specialrule{.17em}{0em}{.2em}
\end{tabular}};
\begin{pgfonlayer}{background}
\draw[rounded corners=2pt,top color=TableHead,bottom color=TableHead, draw=white]
($(tbl.north west)-(0,-0.05)$) rectangle ($(tbl.north east)-(0.0,0.15)$);
\draw[rounded corners=2pt,top color=TableHead,bottom color=TableHead, draw=white]
($(tbl.south west)-(0.0,-0.11)$) rectangle ($(tbl.south east)-(-0.0,-0.02)$);
\end{pgfonlayer}
\end{tikzpicture}
% \end{center}
}
% https://tex.stackexchange.com/a/102523
\newcommand{\forceindent}[1]{\leavevmode{\parindent=#1\indent}}
%% CUSTOM NOTATION %%
\newcommand{\qs}{Q\#}
\newcommand{\unixlike}{\hfill\faApple\faLinux}
\newcommand{\ctrllike}{\hfill\faWindows\faLinux}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{document}
\raggedright\
% \begin{center}
\Large{\qs~0.3 Language Quick Reference}
% \end{center}
\footnotesize
\begin{multicols}{3}
\begin{keysref}{Primitive Types}
64-bit integers & \texttt{Int} \\
Double-precision floats & \texttt{Double} \\
Booleans & \texttt{Bool} \newline
e.g.: \texttt{true} or \texttt{false} \\
Qubits & \texttt{Qubit} \\
Pauli basis & \texttt{Pauli} \newline
e.g.: \texttt{PauliI}, \texttt{PauliX}, \texttt{PauliY}, or \texttt{PauliZ} \\
Measurement \newline results & \texttt{Result} \newline
e.g.: \texttt{Zero} or \texttt{One} \\
Sequences of \newline integers & \texttt{Range} \newline
e.g.: 1..10 or 5..-1..0 \\
Strings & \texttt{String} \\
"Return no \newline information" type & \texttt{Unit} \newline e.g.: \texttt{()} \\
\end{keysref}
\begin{keysref}{Derived Types}
Arrays & \texttt{\emph{elementType}[]} \\
Tuples & \texttt{(\emph{type0}, \emph{type1}, ...)} \newline
e.g.: \texttt{(Int, Qubit)} \\
Functions & \texttt{\emph{input} -> \emph{output}} \newline
e.g.: \texttt{ArcCos : (Double) -> Double} \\
Operations & \texttt{\emph{input} => \emph{output} : \emph{variants}} \newline
e.g.: \texttt{H : (Qubit => Unit : \newline Adjoint, Controlled)} \\
\end{keysref}
\begin{keysref}{Functions, Operations and Types}
Define function \newline (classical routine)
& \texttt{function \emph{Name}(\emph{in0} : \emph{type0}, ...) : \emph{returnType} \{} \newline
\texttt{\hphantom{....}// \emph{function body}} \newline
\texttt{\}} \\
Define operation \newline (quantum routine)
& \texttt{operation \emph{Name}(\emph{in0} : \emph{type0}, ...) : \emph{returnType} \{} \newline
\texttt{\hphantom{....}body \{ ... \}} \newline
\texttt{\hphantom{....}adjoint \{ ... \}} \newline
\texttt{\hphantom{....}controlled \{ ... \}} \newline
\texttt{\hphantom{....}adjoint controlled \{ ... \}} \newline
\texttt{\}} \\
Define \newline user-defined type & \texttt{newtype \emph{TypeName} = \emph{BaseType}} \newline
e.g.: \texttt{newtype TermList = \newline (Int, Int -> (Double, Double))} \\
Call adjoint \newline operation & \texttt{Adjoint \emph{Name}(\emph{parameters})} \\
Call controlled \newline operation & \texttt{Controlled \emph{Name}(\emph{controlQubits}, \emph{parameters})} \\
\end{keysref}
\begin{keysref}{Symbols and Variables}
Declare immutable \newline symbol & \texttt{let \emph{name} = \emph{value}} \\
Declare mutable \newline symbol (variable) & \texttt{mutable \emph{name} = \emph{initialValue}} \\
Update mutable \newline symbol (variable) & \texttt{set \emph{name} = \emph{newValue}} \\
\end{keysref}
\columnbreak%\
\begin{keysref}{Arrays}
Allocation & \texttt{mutable \emph{name} = new \emph{Type}[\emph{length}]} \\
Length & \texttt{Length(\emph{name})} \\
k-th element & \texttt{\emph{name}[k]} \newline NB: indices are 0-based \\
Array literal & \texttt{[\emph{value0}, \emph{value1}, ...]} \newline
e.g.: \texttt{[true, false, true]} \\
Slicing (subarray) & \texttt{\emph{name}[\emph{start}..\emph{end}]} \\
\end{keysref}
\begin{keysref}{Control Flow}
For loop & \texttt{for (\emph{index} in \emph{range}) \{ }\newline
\texttt{\hphantom{....}//} Use integer \texttt{\emph{index}} \newline
\texttt{\}} \newline
e.g.: \texttt{for (i in 0..N-1) \{ ... \}} \\
Iterate over \newline an array & \texttt{for (\emph{val} in \emph{array}) \{ }\newline
\texttt{\hphantom{....}//} Use value \texttt{\emph{val}} \newline
\texttt{\}} \newline
e.g.: \texttt{for (q in register) \{ ... \}} \\
Repeat-until-success loop & \texttt{repeat \{ ... \} \newline until (\emph{condition}) \newline fixup \{ ... \}} \\
Conditional \newline statement & \texttt{if (\emph{cond1}) \{ ... \} \newline elif (\emph{cond2}) \{ ... \} \newline else \{ ... \}}\\
Ternary operator & \texttt{\emph{condition} ? \emph{caseTrue} | \emph{caseFalse} } \\
Return a value & \texttt{return \emph{value}} \\
Stop with an error & \texttt{fail "\emph{Error message}"} \\
\end{keysref}
\begin{keysref}{Debugging}
Print a string & \texttt{Message("Hello Quantum!")} \\
Print an \newline interpolated string
& \texttt{Message(\$"Value = \{\emph{val}\}")} \\
Assert that a qubit is in $\ket{0}$ or $\ket{1}$ state & \texttt{AssertQubit(Zero, \emph{oneQubit})}\\
Print amplitudes \newline of wave function & \texttt{DumpMachine("dump.txt")} \\
\end{keysref}
\begin{keysref}{Qubit Allocation}
Allocate qubits & \texttt{using (\emph{reg} = Qubit[\emph{length}]) \{} \newline
\texttt{\hphantom{....}//} Qubits in \texttt{\emph{reg}} start in $\ket{0}$. \newline
\texttt{\hphantom{....}...} \newline
\texttt{\hphantom{....}//} Qubits must be returned to $\ket{0}$. \newline
\texttt{\}} \\
Allocate one qubit & \texttt{using (\emph{one} = Qubit()) \{ ... \} } \\
\end{keysref}
\begin{keysref}{Measurements}
Measure qubit in Pauli $Z$ basis & \texttt{M(\emph{oneQubit})} \newline yields a \texttt{Result} (\texttt{Zero} or \texttt{One}) \\
Reset qubit to $\ket{0}$ & \texttt{Reset(\emph{oneQubit})} \\
Reset an array of \newline qubits to $\ket{0..0}$ & \texttt{ResetAll(\emph{register})} \\
\end{keysref}
\begin{keysref}{Basic Gates}
Pauli gates & \texttt{X(\emph{qubit})} : \newline
$\ket{0} \mapsto \ket{1}$, $\ket{1} \mapsto \ket{0}$ \newline
\texttt{Y(\emph{qubit})} : \newline
$\ket{0} \mapsto i \ket{1}$, $\ket{1} \mapsto -i \ket{0}$ \newline
\texttt{Z(\emph{qubit})} : \newline
$\ket{0} \mapsto \ket{0}$, $\ket{1} \mapsto -\ket{1}$ \\
Hadamard & \texttt{H(\emph{qubit})} : \newline
$\ket{0} \mapsto \ket{+} = \frac{1}{\sqrt{2}} ( \ket{0} + \ket{1} )$, \newline
$\ket{1} \mapsto \ket{-} = \frac{1}{\sqrt{2}} ( \ket{0} - \ket{1} )$ \\
Controlled-NOT & \texttt{CNOT(\emph{controlQubit}, \emph{targetQubit})} \newline
$\ket{00} \mapsto \ket{00}$, $\ket{01} \mapsto \ket{01}$, \newline
$\ket{10} \mapsto \ket{11}$, $\ket{11} \mapsto \ket{10}$ \\
Apply several gates \newline (Bell pair example) & \texttt{H(\emph{qubit1});} \newline
\texttt{CNOT(\emph{qubit1}, \emph{qubit2});} \\
\end{keysref}
\section{Resources}
\begin{keysref}{Documentation}
Quantum \newline Development Kit & \url{https://docs.microsoft.com/quantum} \\
\qs~Language \newline Reference & \url{https://docs.microsoft.com/quantum/language/} \\
\qs~Library \newline Reference & \url{https://docs.microsoft.com/qsharp/api} \\
\end{keysref}
\begin{keysref}{\qs~Code Repositories}
QDK Samples & \url{https://github.com/Microsoft/Quantum} \\
QDK Libraries & \url{https://github.com/Microsoft/QuantumLibraries} \\
Quantum Katas \newline (tutorials) & \url{https://github.com/Microsoft/QuantumKatas} \\
\end{keysref}
\begin{keysref}{Command Line Basics}
Change directory & \texttt{cd \emph{dirname}} \\
Go to home & \texttt{cd \textasciitilde} \\
Go up one directory & \texttt{cd ..} \\
Make new directory & \texttt{mkdir \emph{dirname}} \\
Open current \newline directory in VS Code & \texttt{code .} \\
\end{keysref}
\begin{keysref}{Working with \qs~Projects}
Create new project & \texttt{dotnet new console -lang Q\# --output \emph{project-dir}} \\
Change directory to \newline project directory & \texttt{cd \emph{project-dir}} \\
Build project & \texttt{dotnet build} \\
Run all unit tests & \texttt{dotnet test} \\
\end{keysref}
\end{multicols}
\end{document}