This is the quilc Reference Manual, version 1.26.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon May 15 06:17:45 2023 GMT+0.
The main system appears first, followed by any subsystem dependency.
quilcA CLI front-end for the Quil compiler
Eric Peterson <eric@rigetti.com>
Apache License 2.0 (See LICENSE.txt)
1.26.0
cl-ppcre (system).
split-sequence (system).
command-line-arguments (system).
yason (system).
magicl (system)., at least version "0.7.0"
cl-quil (system).
cl-quil-benchmarking (system).
uiop (system).
bordeaux-threads (system).
cl-syslog (system).
rpcq (system).
drakma (system).
trivial-features (system).
alexandria (system).
swank (system).
package.lisp (file).
globals.lisp (file).
versions.lisp (file).
impl/sbcl.lisp (file).
chip-cache.lisp (file).
rpc-server.lisp (file).
printers.lisp (file).
options.lisp (file).
entry-point.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
quilc/quilc.asdquilc/package.lispquilc/globals.lispquilc/versions.lispquilc/impl/sbcl.lispquilc/chip-cache.lispquilc/rpc-server.lispquilc/printers.lispquilc/options.lispquilc/entry-point.lispquilc/globals.lisppackage.lisp (file).
quilc (system).
*human-readable-stream* (special variable).
*log-level* (special variable).
*logger* (special variable).
*program-name* (special variable).
*protoquil* (special variable).
*quil-stream* (special variable).
*state-aware* (special variable).
*without-pretty-printing* (special variable).
quilc/versions.lispglobals.lisp (file).
quilc (system).
+git-hash+ (constant).
+quilc-version+ (constant).
asynchronously-indicate-update-availability (function).
git-hash (function).
query-latest-sdk-version (function).
sdk-update-available-p (function).
system-version (function).
quilc/impl/sbcl.lispversions.lisp (file).
quilc (system).
disable-debugger (function).
enable-debugger (function).
interactive-interrupt (type).
quilc/chip-cache.lispimpl/sbcl.lisp (file).
quilc (system).
*chip-cache* (special variable).
*chip-cache-max-size* (special variable).
cached-chip (class).
cached-chip-addresser-state (reader method).
(setf cached-chip-addresser-state) (writer method).
cached-chip-chip (reader method).
(setf cached-chip-chip) (writer method).
cached-chip-last-accessed (reader method).
(setf cached-chip-last-accessed) (writer method).
chip-cache-or-create (function).
chip-cache-purge (function).
get-internal-real-time-seconds (function).
quilc/rpc-server.lispchip-cache.lisp (file).
quilc (system).
conjugate-pauli-by-clifford-handler (function).
ensure-optional-real (function).
generate-rb-sequence-handler (function).
get-version-info-handler (function).
native-quil-to-binary-handler (function).
quil-to-native-quil-handler (function).
rewrite-arithmetic-handler (function).
runtime-estimation (function).
start-rpc-server (function).
statistics-to-metadata (function).
quilc/printers.lisprpc-server.lisp (file).
quilc (system).
print-matrix-comparision (function).
print-program (function).
print-statistics (function).
quilc/options.lispprinters.lisp (file).
quilc (system).
*deprecated-option-spec* (special variable).
*ignored-option-spec* (special variable).
*option-spec* (special variable).
*retired-option-spec* (special variable).
quilc/entry-point.lispoptions.lisp (file).
quilc (system).
%entry-point (function).
*nick-banner* (special variable).
backend-compile-program (function).
benchmarks (function).
check-libraries (function).
command-line-debugger (function).
compute-statistics (function).
entry-point (function).
log-level-string-to-symbol (function).
lookup-isa-descriptor-for-name (function).
parse-backend-options (function).
print-matrix-with-comment-hashes (function).
process-options (function).
process-program (function).
reload-foreign-libraries (function).
setup-debugger (function).
show-backends (function).
show-banner (function).
show-help (function).
show-version (function).
slurp-lines (function).
special-bindings-let* (macro).
strip-final-halt-respecting-rewirings (function).
warn-deprecated-options (function).
warn-ignored-options (function).
Packages are listed by definition order.
quilccl-quil.
common-lisp.
%entry-point (function).
*chip-cache* (special variable).
*chip-cache-max-size* (special variable).
*deprecated-option-spec* (special variable).
*human-readable-stream* (special variable).
*ignored-option-spec* (special variable).
*log-level* (special variable).
*logger* (special variable).
*nick-banner* (special variable).
*option-spec* (special variable).
*program-name* (special variable).
*protoquil* (special variable).
*quil-stream* (special variable).
*retired-option-spec* (special variable).
*state-aware* (special variable).
*without-pretty-printing* (special variable).
+git-hash+ (constant).
+quilc-version+ (constant).
asynchronously-indicate-update-availability (function).
backend-compile-program (function).
benchmarks (function).
cached-chip (class).
cached-chip-addresser-state (generic reader).
(setf cached-chip-addresser-state) (generic writer).
cached-chip-chip (generic reader).
(setf cached-chip-chip) (generic writer).
cached-chip-last-accessed (generic reader).
(setf cached-chip-last-accessed) (generic writer).
check-libraries (function).
chip-cache-or-create (function).
chip-cache-purge (function).
command-line-debugger (function).
compute-statistics (function).
conjugate-pauli-by-clifford-handler (function).
disable-debugger (function).
enable-debugger (function).
ensure-optional-real (function).
entry-point (function).
generate-rb-sequence-handler (function).
get-internal-real-time-seconds (function).
get-version-info-handler (function).
git-hash (function).
interactive-interrupt (type).
log-level-string-to-symbol (function).
lookup-isa-descriptor-for-name (function).
native-quil-to-binary-handler (function).
parse-backend-options (function).
print-matrix-comparision (function).
print-matrix-with-comment-hashes (function).
print-program (function).
print-statistics (function).
process-options (function).
process-program (function).
query-latest-sdk-version (function).
quil-to-native-quil-handler (function).
reload-foreign-libraries (function).
rewrite-arithmetic-handler (function).
runtime-estimation (function).
sdk-update-available-p (function).
setup-debugger (function).
show-backends (function).
show-banner (function).
show-help (function).
show-version (function).
slurp-lines (function).
special-bindings-let* (macro).
start-rpc-server (function).
statistics-to-metadata (function).
strip-final-halt-respecting-rewirings (function).
system-version (function).
warn-deprecated-options (function).
warn-ignored-options (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
The git hash of the quilc repo.
The version of the quilc application.
Cached chip specifications. Pair of values (hash-table . lock). Large chips have a significant construction overhead, and caching chips between requests reduces or eliminates that overhead. The hash value for a given key is a pair (last-access . chip-spec). Note: use the lock when accessing.
The maximum number of entries in the cache.
Supported and deprecated options.
Inactive and deprecated options.
Supported and non-deprecated options.
Invalid options.
Bind LET-DEFS as in LET, and add those LET-DEFS to bordeaux-threads:*default-special-bindings* in the same LET.
Write to the logger the state of the software version (whether it’s the latest, if there’s an update, if an update couldn’t be queried).
Compile the processed program PROGRAM for BACKEND, writing to OUTPUT.
Check that the foreign libraries are adequate. Exits with status 0 if so, 1 if not.
Look up the chip described by QPU-HASH in the chip spec cache if it exists, otherwise create and cache it.
This function has the added side-effect that it will purge old chips according to *CHIP-CACHE-MAX-SIZE*
Purge the least recently used entries in *CHIP-CACHE* according to *CHIP-CACHE-MAX-SIZE*.
After calling this function, *CHIP-CACHE* has at most *CHIP-CACHE-MAX-SIZE* entries.
Compute statistics about protoquil program PROCESSED-PROGRAM.
This function will have undefined behavior when PROCESSED-PROGRAM is not protoquil.
Conjugates a Pauli operator by a Clifford operator, as specified by REQUEST.
Generates a randomized benchmarking sequence according to REQUEST.
Get the short git hash of the system SYSTEM.
Dummy invocation: this QUILC binary returns something QVM-executable, which is just the program again.
Parse backend options to keyword init-args for making backend.
Compile PROGRAM for the chip CHIP-SPECIFICATION. Optionally calculate statistics described by the keyword arguments. All require :PROTOQUIL T.
Note: PROGRAM is mutated by the compilation process. To avoid this, use COPY-INSTANCE.
Returns a values tuple (PROCESSED-PROGRAM, STATISTICS), where PROCESSED-PROGRAM is the compiled program, and STATISTICS is a HASH-TABLE whose keys are the slots of the RPCQ::|NativeQuilMetadata| class.
Get the latest SDK quilc version, or NIL if unavailable.
Traditional QUILC invocation: compiles a Quil program to native Quil, as specified by an ISA.
Rewrites the request program without arithmetic in gate parameters.
Estimated QPU runtime of PARSED-PROTOQUIL-PROGRAM. Likely to be an over-estimate for small depth programs, where runtime is dominated by network latency and compilation, etc. Take these results with a grain of salt.
Test whether the current SDK version is the latest SDK version. Second value returned indicates the latest version.
Remove the final HALT instruction, if any, from PROCESSED-PROGRAM, retaining any attached rewiring comments.
Print a warning message if the server is started with deprecated options (see *DEPRECATED-OPTION-SPEC*).
Print a warning message if the server is started with deprecated options (see *DEPRECATED-OPTION-SPEC*).
cached-chip)) ¶automatically generated reader method
cached-chip)) ¶automatically generated writer method
cached-chip)) ¶automatically generated reader method
chip.
cached-chip)) ¶automatically generated writer method
chip.
cached-chip)) ¶automatically generated reader method
cached-chip)) ¶automatically generated writer method
Represents chip and addresser state cached between server requests.
| Jump to: | %
(
A B C D E F G L M N P Q R S W |
|---|
| Jump to: | %
(
A B C D E F G L M N P Q R S W |
|---|
| Jump to: | *
+
A C L S |
|---|
| Jump to: | *
+
A C L S |
|---|
| Jump to: | C E F G I O P Q R S T V |
|---|
| Jump to: | C E F G I O P Q R S T V |
|---|