StatevectorConfiguration
public enum StatevectorConfiguration
Define performance and memory footprint of Circuit.statevector(withInitialState:)
-
Each
Gate
is expanded into aMatrix
before applying to theCircuitStatevector
for the entire circuit. Matrix expansion is performed with up toexpansionConcurrency
threads. IfexpansionConcurrency
is 0 or less, it will be defaulted to 1. This configuration has the biggest memory footprint but it is faster than the others, exceptStatevectorConfiguration.direct
.Declaration
Swift
case matrix(expansionConcurrency: Int = 1)
-
To apply a
Gate
to theCircuitStatevector
for the entire circuit, up tocalculationConcurrency
rows in theGate
are expanded at the same time and applied to the statevector as needed. In turn, each row will be expanded with up toexpansionConcurrency
threads, socalculationConcurrency
*expansionConcurrency
threads might be running concurrently at any given moment. IfcalculationConcurrency
orexpansionConcurrency
are set to 0 or less, they will be defaulted to 1.Declaration
Swift
case row(calculationConcurrency: Int = 1, expansionConcurrency: Int = 1)
-
To apply a
Gate
to theCircuitStatevector
for the entire circuit, up tocalculationConcurrency
values in the statevector are calculated simultaneously. Values inGate
are requested one by one and when needed. IfcalculationConcurrency
is 0 or less, it will be defaulted to 1. This configuration is the slowest but it has the smallest memory footprint.Declaration
Swift
case value(calculationConcurrency: Int = 1)
-
To apply a
Gate
to theCircuitStatevector
for the entire circuit, up tocalculationConcurrency
values in the statevector are calculated simultaneously. IfcalculationConcurrency
is 0 or less, it will be defaulted to 1. It is similar toStatevectorConfiguration.value
but instead of calculating all positions in aGate
, only those that are needed (not zero) are generated. If each gate only uses a few qubits in the circuit, this is the fastest option and its memory footprint is almost identical toStatevectorConfiguration.value
.Declaration
Swift
case direct(calculationConcurrency: Int = 1)