C

enum QBlazeError

Errors.

Upon failure, most operations return one of the following error codes:

enumerator QBLAZE_ERR_MEMORY

Not enough memory.

enumerator QBLAZE_ERR_DOMAIN

Parameter outside domain.

enumerator QBLAZE_ERR_QUBIT_INDEX

Invalid qubit index.

enumerator QBLAZE_ERR_QUBIT_USAGE

Invalid qubit usage.

enum QBlazeOpt

Options.

enumerator QBLAZE_OPT_END

Special option used to terminate an array of options.

enumerator QBLAZE_OPT_DUMP_CONFIG

Dumps the simulator configuration to stderr. Default: no.

enumerator QBLAZE_OPT_QUBIT_COUNT

Hint about how many qubits will be used. This option determines how many bits are used to represent qubit indices. The representation is changed automatically when a qubit with a higher index is used. The maximum supported qubit count is returned by by qblaze_max_qubit_count(). Default: 1.

enumerator QBLAZE_OPT_THREAD_COUNT

The number of threads in the thread pool. Default: nproc.

enumerator QBLAZE_OPT_CHUNK_SIZE

The chunk size for processing superposition-free gates (in bytes). If set to SIZE_MAX, then a single chunk is used. Default: smallest L2 cache size.

enumerator QBLAZE_OPT_NONTEMPORAL_THRESHOLD

The state vector size after which non-temporal stores will be used (in bytes). Default: 2 * total L3 cache size.

enumerator QBLAZE_OPT_MULTITHREADING_THRESHOLD

The state vector size after which multiple threads will be used (in bytes). Default: 64 KiB.

enumerator QBLAZE_OPT_WORK_ITEM_MIN_SIZE

The minimum size of a thread work item (in bytes). Use to ensure that the work per item is larger that the communication overhead. Default: 1 KiB.

enumerator QBLAZE_OPT_WORK_ITEM_MAX_SIZE

The maximum size of a thread work item (in bytes). Use to ensure that there are enough items for threads that finish early. Default: 16 MiB.

struct QBlazeConfig

An option configuration.

enum QBlazeOpt option

union value

int as_size_t

void *as_ptr

struct QBlazeComplex

A complex number. ABI compatible with double _Complex.

double real

double imag

struct QBlazeControl

Specifies a control condition.

The condition is satisfied when the specified qubit has the specified value.

int qubit

int value

size_t qblaze_max_qubit_count(void)

Return the maxumum supported qubit count.

QBlazeSimulator *qblaze_new(const struct QBlazeConfig *opts)

Create a new simulator instance.

The option configurations must be terminated by an QBLAZE_OPT_END.

On error, return NULL.

void qblaze_del(QBlazeSimulator *sim)

Delete a simulator instance.

QBlazeSimulator *qblaze_clone(QBlazeSimulator *sim)

Clone a simulator instance.

On error, return NULL, leaving the state of the original simulator is undefined.

int qblaze_flush(QBlazeSimulator *sim)

Apply all enqueued gates.

int qblaze_dump(QBlazeSimulator *sim)

Dump the state vector to stderr.

int qblaze_apply_u3(QBlazeSimulator *sim, size_t target, double theta, double phi, double lambda)

Apply a general single-qubit gate.

The definition is equivalent up to global phase to the OpenQASM u gate.

int qblaze_apply_mcx(QBlazeSimulator *sim, const struct QBlazeControl *controls, size_t count, size_t target)

Apply a multiply controlled X gate.

int qblaze_apply_mcphase(QBlazeSimulator *sim, const struct QBlazeControl *controls, size_t count, double lambda)

Apply a multiply controlled phase gate.

int qblaze_apply_mcswap(QBlazeSimulator *sim, const struct QBlazeControl *controls, size_t count, size_t target1, size_t target2)

Apply a multiply controlled swap gate.

int qblaze_measure(QBlazeSimulator *sim, size_t target, uint64_t random, double *p0, double *p1)

Measure the target qubit.

The state vector is probabilistically collapsed based on a random 64-bit input. The probability for 0 is stored in ‘p0’, and the probability for 1 is stored in ‘p1’.

Return the measured value if successful, and an error code otherwise.

int qblaze_qubit_probs(QBlazeSimulator *sim, size_t target, double *p0, double *p1)

Compute the measurement probabilities for the target qubit without measuring it.

The probability for 0 is stored in ‘p0’, and the probability for 1 is stored in ‘p1’.

int qblaze_copy_amplitudes(QBlazeSimulator *sim, QBlazeComplex *buffer, size_t length)

Copy the state vector amplitudes to ‘buf’ but no more than ‘len’ of them.

The amplitude of the ‘i’th state vector is stored at position ‘i’, where the ‘k’th bit of ‘i’ equals the basis value of the ‘k’th qubit.

struct QBlazeIterator

Basis vector iterator.

QBlazeComplex amplitude

int qubit_count

uint8_t bitmap[]

struct QBlazeIterator *qblaze_iter_new(QBlazeSimulator *sim)

Create a new iterator over the state vector. The iterator is uninitialized, so qblaze_iter_next must be called.

On error, return NULL.

bool qblaze_iter_next(struct QBlazeIterator *iter)

Advance the iterator to the next element of the state vector. The iterator must have been obtained from qblaze_iter_new(). No operations can be applied on the state vector during iteration. The iteration order is undefined.

Returns true on success or false if the end of the state vector has been reached.

void qblaze_iter_del(struct QBlazeIterator *iter)

Free an iterator.