#include <qbdt.hpp>

Inheritance diagram for Qrack::QBdt:

[legend]

Collaboration diagram for Qrack::QBdt:

[legend]

Public Member Functions
	QBdt (std::vector< QInterfaceEngine > eng, bitLenInt qBitCount, const bitCapInt &initState=ZERO_BCI, qrack_rand_gen_ptr rgp=nullptr, const complex &phaseFac=CMPLX_DEFAULT_ARG, bool doNorm=false, bool randomGlobalPhase=true, bool useHostMem=false, int64_t deviceId=-1, bool useHardwareRNG=true, bool useSparseStateVec=false, real1_f norm_thresh=REAL1_EPSILON, std::vector< int64_t > ignored={}, bitLenInt qubitThreshold=0, real1_f separation_thresh=_qrack_qunit_sep_thresh)

	QBdt (bitLenInt qBitCount, const bitCapInt &initState=ZERO_BCI, qrack_rand_gen_ptr rgp=nullptr, const complex &phaseFac=CMPLX_DEFAULT_ARG, bool doNorm=false, bool randomGlobalPhase=true, bool useHostMem=false, int64_t deviceId=-1, bool useHardwareRNG=true, bool useSparseStateVec=false, real1_f norm_thresh=REAL1_EPSILON, std::vector< int64_t > devList={}, bitLenInt qubitThreshold=0U, real1_f separation_thresh=_qrack_qunit_sep_thresh)

size_t	CountBranches ()

bool	isBinaryDecisionTree ()
	Returns "true" if current state representation is definitely a binary decision tree, "false" if it is definitely not, or "true" if it cannot be determined. More...

void	SetDevice (int64_t dID)
	Set the device index, if more than one device is available. More...

void	SetDeviceList (std::vector< int64_t > dIDs)
	Set the device index list, if more than one device is available. More...

int64_t	GetDevice ()
	Get the device index. More...

std::vector< int64_t >	GetDeviceList ()
	Get the device index. More...

void	UpdateRunningNorm (real1_f norm_thresh=REAL1_DEFAULT_ARG)
	Force a calculation of the norm of the state vector, in order to make it unit length before the next probability or measurement operation. More...

void	NormalizeState (real1_f nrm=REAL1_DEFAULT_ARG, real1_f norm_thresh=REAL1_DEFAULT_ARG, real1_f phaseArg=ZERO_R1_F)
	Apply the normalization factor found by UpdateRunningNorm() or on the fly by a single bit gate. More...

real1_f	SumSqrDiff (QInterfacePtr toCompare)
	Calculates (1 - <\psi_e\|\psi_c>) between states \|\psi_c> and \|\psi_e>. More...

real1_f	SumSqrDiff (QBdtPtr toCompare)

void	SetPermutation (const bitCapInt &initState, const complex &phaseFac=CMPLX_DEFAULT_ARG)
	Set to a specific permutation of all qubits. More...

QInterfacePtr	Clone ()
	Clone this QInterface. More...

void	GetQuantumState (complex *state)
	Get the pure quantum state representation. More...

void	GetQuantumState (QInterfacePtr eng)

void	SetQuantumState (const complex *state)
	Set an arbitrary pure quantum state representation. More...

void	SetQuantumState (QInterfacePtr eng)

void	GetProbs (real1 *outputProbs)
	Get the pure quantum state representation. More...

complex	GetAmplitude (const bitCapInt &perm)
	Get the representational amplitude of a full permutation. More...

void	SetAmplitude (const bitCapInt &perm, const complex &amp)
	Sets the representational amplitude of a full permutation. More...

bool	IsSeparable (bitLenInt start)
	Inexpensive check for whether the QBdt is separable between low and high qubit indices at the bipartite boundary of qubit index "start" (for "high" qubit indices). More...

bool	TryDecompose (bitLenInt start, QInterfacePtr dest, real1_f error_tol=TRYDECOMPOSE_EPSILON)
	Attempt to `Decompose()` a bit range. More...

bool	TrySeparate (const std::vector< bitLenInt > &_qubits, real1_f error_tol)
	Qrack::QUnit types maintain explicit separation of representations of qubits, which reduces memory usage and increases gate speed. More...

bool	TrySeparate (bitLenInt qubit)
	Single-qubit TrySeparate() More...

bool	TrySeparate (bitLenInt qubit1, bitLenInt qubit2)
	Two-qubit TrySeparate() More...

bitLenInt	Compose (QBdtPtr toCopy, bitLenInt start)

bitLenInt	Compose (QInterfacePtr toCopy, bitLenInt start)
	`Compose()` a `QInterface` peer, inserting its qubit into index order at `start` index. More...

void	Decompose (bitLenInt start, QInterfacePtr dest)
	Minimally decompose a set of contiguous bits from the separably composed unit, into "destination". More...

QInterfacePtr	Decompose (bitLenInt start, bitLenInt length)
	Schmidt decompose a length of qubits. More...

void	Dispose (bitLenInt start, bitLenInt length)
	Minimally decompose a set of contiguous bits from the separably composed unit, and discard the separable bits from index "start" for "length.". More...

void	Dispose (bitLenInt start, bitLenInt length, const bitCapInt &disposedPerm)
	Dispose a a contiguous set of qubits that are already in a permutation eigenstate. More...

bitLenInt	Allocate (bitLenInt start, bitLenInt length)
	Allocate new "length" count of \|0> state qubits at specified qubit index start position. More...

real1_f	Prob (bitLenInt qubitIndex)
	Direct measure of bit probability to be in \|1> state. More...

real1_f	ProbAll (const bitCapInt &fullRegister)
	Direct measure of full permutation probability. More...

bool	ForceM (bitLenInt qubit, bool result, bool doForce=true, bool doApply=true)
	Act as if is a measurement was applied, except force the (usually random) result. More...

bitCapInt	MAll ()
	Measure permutation state of all coherent bits. More...

void	Mtrx (const complex *mtrx, bitLenInt target)
	Apply an arbitrary single bit unitary transformation. More...

void	MCMtrx (const std::vector< bitLenInt > &controls, const complex *mtrx, bitLenInt target)
	Apply an arbitrary single bit unitary transformation, with arbitrary control bits. More...

void	MACMtrx (const std::vector< bitLenInt > &controls, const complex *mtrx, bitLenInt target)
	Apply an arbitrary single bit unitary transformation, with arbitrary (anti-)control bits. More...

void	MCPhase (const std::vector< bitLenInt > &controls, const complex &topLeft, const complex &bottomRight, bitLenInt target)
	Apply a single bit transformation that only effects phase, with arbitrary control bits. More...

void	MCInvert (const std::vector< bitLenInt > &controls, const complex &topRight, const complex &bottomLeft, bitLenInt target)
	Apply a single bit transformation that reverses bit probability and might effect phase, with arbitrary control bits. More...

void	FSim (real1_f theta, real1_f phi, bitLenInt qubitIndex1, bitLenInt qubitIndex2)
	The 2-qubit "fSim" gate, (useful in the simulation of particles with fermionic statistics) More...

void	Swap (bitLenInt q1, bitLenInt q2)
	Swap values of two bits in register. More...

void	ISwap (bitLenInt q1, bitLenInt q2)
	Swap values of two bits in register, and apply phase factor of i if bits are different. More...

void	IISwap (bitLenInt q1, bitLenInt q2)
	Inverse ISwap - Swap values of two bits in register, and apply phase factor of -i if bits are different. More...

void	SqrtSwap (bitLenInt q1, bitLenInt q2)
	Square root of Swap gate. More...

void	ISqrtSwap (bitLenInt q1, bitLenInt q2)
	Inverse square root of Swap gate. More...

void	CSwap (const std::vector< bitLenInt > &controls, bitLenInt q1, bitLenInt q2)
	Apply a swap with arbitrary control bits. More...

void	CSqrtSwap (const std::vector< bitLenInt > &controls, bitLenInt q1, bitLenInt q2)
	Apply a square root of swap with arbitrary control bits. More...

void	CISqrtSwap (const std::vector< bitLenInt > &controls, bitLenInt q1, bitLenInt q2)
	Apply an inverse square root of swap with arbitrary control bits. More...

real1_f	ProbParity (const bitCapInt &mask)
	Overall probability of any odd permutation of the masked set of bits. More...

void	CUniformParityRZ (const std::vector< bitLenInt > &controls, const bitCapInt &mask, real1_f angle)
	If the controls are set and the target qubit set parity is odd, this applies a phase factor of \(e^{i angle}\). More...

bool	ForceMParity (const bitCapInt &mask, bool result, bool doForce=true)
	Act as if is a measurement of parity of the masked set of qubits was applied, except force the (usually random) result. More...

bool	M (bitLenInt q)

void	X (bitLenInt q)

void	INC (const bitCapInt &toAdd, bitLenInt start, bitLenInt length)
	Add integer (without sign) More...

void	DEC (const bitCapInt &toSub, bitLenInt start, bitLenInt length)
	Add integer (without sign) More...

void	INCC (const bitCapInt &toAdd, bitLenInt start, bitLenInt length, bitLenInt carryIndex)
	Add integer (without sign, with carry) More...

void	DECC (const bitCapInt &toSub, bitLenInt start, bitLenInt length, bitLenInt carryIndex)
	Subtract classical integer (without sign, with carry) More...

void	INCS (const bitCapInt &toAdd, bitLenInt start, bitLenInt length, bitLenInt overflowIndex)
	Add a classical integer to the register, with sign and without carry. More...

void	DECS (const bitCapInt &toSub, bitLenInt start, bitLenInt length, bitLenInt overflowIndex)
	Add a classical integer to the register, with sign and without carry. More...

void	CINC (const bitCapInt &toAdd, bitLenInt inOutStart, bitLenInt length, const std::vector< bitLenInt > &controls)
	Add integer (without sign, with controls) More...

void	CDEC (const bitCapInt &toSub, bitLenInt inOutStart, bitLenInt length, const std::vector< bitLenInt > &controls)
	Subtract integer (without sign, with controls) More...

void	INCDECC (const bitCapInt &toAdd, bitLenInt start, bitLenInt length, bitLenInt carryIndex)
	Common driver method behind INCC and DECC (without sign, with carry) More...

void	MULModNOut (const bitCapInt &toMul, const bitCapInt &modN, bitLenInt inStart, bitLenInt outStart, bitLenInt length)
	Multiplication modulo N by integer, (out of place) More...

void	IMULModNOut (const bitCapInt &toMul, const bitCapInt &modN, bitLenInt inStart, bitLenInt outStart, bitLenInt length)
	Inverse of multiplication modulo N by integer, (out of place) More...

void	CMULModNOut (const bitCapInt &toMul, const bitCapInt &modN, bitLenInt inStart, bitLenInt outStart, bitLenInt length, const std::vector< bitLenInt > &controls)
	Controlled multiplication modulo N by integer, (out of place) More...

void	CIMULModNOut (const bitCapInt &toMul, const bitCapInt &modN, bitLenInt inStart, bitLenInt outStart, bitLenInt length, const std::vector< bitLenInt > &controls)
	Inverse of controlled multiplication modulo N by integer, (out of place) More...

void	PhaseFlipIfLess (const bitCapInt &greaterPerm, bitLenInt start, bitLenInt length)
	This is an expedient for an adaptive Grover's search for a function's global minimum. More...

void	CPhaseFlipIfLess (const bitCapInt &greaterPerm, bitLenInt start, bitLenInt length, bitLenInt flagIndex)
	The 6502 uses its carry flag also as a greater-than/less-than flag, for the CMP operation. More...

void	INCDECSC (const bitCapInt &toAdd, bitLenInt start, bitLenInt length, bitLenInt overflowIndex, bitLenInt carryIndex)
	Common driver method behind INCSC and DECSC (with overflow flag) More...

void	INCDECSC (const bitCapInt &toAdd, bitLenInt start, bitLenInt length, bitLenInt carryIndex)
	Common driver method behind INCSC and DECSC (without overflow flag) More...

void	INCBCD (const bitCapInt &toAdd, bitLenInt start, bitLenInt length)
	Add classical BCD integer (without sign) More...

void	INCDECBCDC (const bitCapInt &toAdd, bitLenInt start, bitLenInt length, bitLenInt carryIndex)
	Common driver method behind INCSC and DECSC (without overflow flag) More...

void	MUL (const bitCapInt &toMul, bitLenInt inOutStart, bitLenInt carryStart, bitLenInt length)
	Multiply by integer. More...

void	DIV (const bitCapInt &toDiv, bitLenInt inOutStart, bitLenInt carryStart, bitLenInt length)
	Divide by integer. More...

void	POWModNOut (const bitCapInt &base, const bitCapInt &modN, bitLenInt inStart, bitLenInt outStart, bitLenInt length)
	Raise a classical base to a quantum power, modulo N, (out of place) More...

void	CMUL (const bitCapInt &toMul, bitLenInt inOutStart, bitLenInt carryStart, bitLenInt length, const std::vector< bitLenInt > &controls)
	Controlled multiplication by integer. More...

void	CDIV (const bitCapInt &toDiv, bitLenInt inOutStart, bitLenInt carryStart, bitLenInt length, const std::vector< bitLenInt > &controls)
	Controlled division by power of integer. More...

void	CPOWModNOut (const bitCapInt &base, const bitCapInt &modN, bitLenInt inStart, bitLenInt outStart, bitLenInt length, const std::vector< bitLenInt > &controls)
	Controlled, raise a classical base to a quantum power, modulo N, (out of place) More...

bitCapInt	IndexedLDA (bitLenInt indexStart, bitLenInt indexLength, bitLenInt valueStart, bitLenInt valueLength, const unsigned char *values, bool resetValue=true)
	Set 8 bit register bits by a superposed index-offset-based read from classical memory. More...

bitCapInt	IndexedADC (bitLenInt indexStart, bitLenInt indexLength, bitLenInt valueStart, bitLenInt valueLength, bitLenInt carryIndex, const unsigned char *values)
	Add to entangled 8 bit register state with a superposed index-offset-based read from classical memory. More...

bitCapInt	IndexedSBC (bitLenInt indexStart, bitLenInt indexLength, bitLenInt valueStart, bitLenInt valueLength, bitLenInt carryIndex, const unsigned char *values)
	Subtract from an entangled 8 bit register state with a superposed index-offset-based read from classical memory. More...

void	Hash (bitLenInt start, bitLenInt length, const unsigned char *values)
	Transform a length of qubit register via lookup through a hash table. More...

virtual bool	TrySeparate (const std::vector< bitLenInt > &qubits, real1_f error_tol)
	Qrack::QUnit types maintain explicit separation of representations of qubits, which reduces memory usage and increases gate speed. More...

virtual bool	TrySeparate (bitLenInt qubit)
	Single-qubit TrySeparate() More...

virtual bool	TrySeparate (bitLenInt qubit1, bitLenInt qubit2)
	Two-qubit TrySeparate() More...

virtual bitLenInt	Compose (QInterfacePtr toCopy)
	Combine another QInterface with this one, after the last bit index of this one. More...

virtual std::map< QInterfacePtr, bitLenInt >	Compose (std::vector< QInterfacePtr > toCopy)
	`Compose()` a vector of peer `QInterface` targets, in sequence. More...

virtual bitLenInt	Compose (QInterfacePtr toCopy, bitLenInt start)
	`Compose()` a `QInterface` peer, inserting its qubit into index order at `start` index. More...

virtual bitLenInt	Allocate (bitLenInt length)
	Allocate new "length" count of \|0> state qubits at end of qubit index position. More...

virtual bitLenInt	Allocate (bitLenInt start, bitLenInt length)=0
	Allocate new "length" count of \|0> state qubits at specified qubit index start position. More...

virtual bool	M (bitLenInt qubit)
	Measurement gate. More...

virtual bitCapInt	M (const std::vector< bitLenInt > &bits)
	Measure bits with indices in array, and return a mask of the results. More...

virtual void	X (bitLenInt qubit)
	X gate. More...

virtual void	X (bitLenInt start, bitLenInt length)
	Bitwise Pauli X (or logical "NOT") operator. More...

Public Member Functions inherited from Qrack::QAlu
virtual void	INCSC (const bitCapInt &toAdd, bitLenInt start, bitLenInt length, bitLenInt overflowIndex, bitLenInt carryIndex)
	Add a classical integer to the register, with sign and with carry. More...

virtual void	INCSC (const bitCapInt &toAdd, bitLenInt start, bitLenInt length, bitLenInt carryIndex)
	Add a classical integer to the register, with sign and with (phase-based) carry. More...

virtual void	DECSC (const bitCapInt &toSub, bitLenInt start, bitLenInt length, bitLenInt overflowIndex, bitLenInt carryIndex)
	Subtract a classical integer from the register, with sign and with carry. More...

virtual void	DECSC (const bitCapInt &toSub, bitLenInt start, bitLenInt length, bitLenInt carryIndex)
	Subtract a classical integer from the register, with sign and with carry. More...

virtual void	DECBCD (const bitCapInt &toSub, bitLenInt start, bitLenInt length)
	Subtract classical BCD integer (without sign) More...

virtual void	INCBCDC (const bitCapInt &toAdd, bitLenInt start, bitLenInt length, bitLenInt carryIndex)
	Add classical BCD integer (without sign, with carry) More...

virtual void	DECBCDC (const bitCapInt &toSub, bitLenInt start, bitLenInt length, bitLenInt carryIndex)
	Subtract BCD integer (without sign, with carry) More...

Public Member Functions inherited from Qrack::QParity
virtual bool	MParity (const bitCapInt &mask)
	Measure (and collapse) parity of the masked set of qubits. More...

virtual void	UniformParityRZ (const bitCapInt &mask, real1_f angle)
	If the target qubit set parity is odd, this applies a phase factor of \(e^{i angle}\). More...

Public Member Functions inherited from Qrack::QInterface
	QInterface (bitLenInt n, qrack_rand_gen_ptr rgp=nullptr, bool doNorm=false, bool useHardwareRNG=true, bool randomGlobalPhase=true, real1_f norm_thresh=REAL1_EPSILON)

	QInterface ()
	Default constructor, primarily for protected internal use. More...

virtual	~QInterface ()

void	SetRandomSeed (uint32_t seed)

virtual void	SetQubitCount (bitLenInt qb)

virtual void	SetConcurrency (uint32_t threadsPerEngine)
	Set the number of threads in parallel for loops, per component QEngine. More...

virtual bitLenInt	GetQubitCount ()
	Get the count of bits in this register. More...

virtual bitCapInt	GetMaxQPower ()
	Get the maximum number of basis states, namely \( 2^n \) for \( n \) qubits. More...

virtual bitCapInt	GetAmplitudeCount ()
	Count of amplitudes, which might be less than state vector if sparse or compressed. More...

virtual bool	GetIsArbitraryGlobalPhase ()

real1_f	Rand ()
	Generate a random real number between 0 and 1. More...

virtual void	GetReducedDensityMatrix (const std::vector< bitLenInt > &qubits, complex *outputState)
	Get a reduced density matrix on the list of qubits. More...

virtual bitLenInt	Compose (QInterfacePtr toCopy)
	Combine another QInterface with this one, after the last bit index of this one. More...

virtual bitLenInt	ComposeNoClone (QInterfacePtr toCopy)
	This is a variant of `Compose()` for a `toCopy` argument that will definitely not be reused once "Composed," hence more aggressive optimization can be done. More...

virtual std::map< QInterfacePtr, bitLenInt >	Compose (std::vector< QInterfacePtr > toCopy)
	`Compose()` a vector of peer `QInterface` targets, in sequence. More...

virtual bitLenInt	Allocate (bitLenInt length)
	Allocate new "length" count of \|0> state qubits at end of qubit index position. More...

virtual void	UCMtrx (const std::vector< bitLenInt > &controls, const complex *mtrx, bitLenInt target, const bitCapInt &controlPerm)
	Apply an arbitrary single bit unitary transformation, with arbitrary control bits, with arbitary control permutation. More...

virtual void	Phase (const complex &topLeft, const complex &bottomRight, bitLenInt qubit)
	Apply a single bit transformation that only effects phase. More...

virtual void	Invert (const complex &topRight, const complex &bottomLeft, bitLenInt qubit)
	Apply a single bit transformation that reverses bit probability and might effect phase. More...

virtual void	MACPhase (const std::vector< bitLenInt > &controls, const complex &topLeft, const complex &bottomRight, bitLenInt target)
	Apply a single bit transformation that only effects phase, with arbitrary (anti-)control bits. More...

virtual void	MACInvert (const std::vector< bitLenInt > &controls, const complex &topRight, const complex &bottomLeft, bitLenInt target)
	Apply a single bit transformation that reverses bit probability and might effect phase, with arbitrary (anti-)control bits. More...

virtual void	UCPhase (const std::vector< bitLenInt > &controls, const complex &topLeft, const complex &bottomRight, bitLenInt target, const bitCapInt &perm)
	Apply a single bit transformation that only effects phase, with arbitrary control bits, with arbitrary control permutation. More...

virtual void	UCInvert (const std::vector< bitLenInt > &controls, const complex &topRight, const complex &bottomLeft, bitLenInt target, const bitCapInt &perm)
	Apply a single bit transformation that reverses bit probability and might effect phase, with arbitrary control bits, with arbitrary control permutation. More...

virtual void	UniformlyControlledSingleBit (const std::vector< bitLenInt > &controls, bitLenInt qubit, const complex *mtrxs)
	Apply a "uniformly controlled" arbitrary single bit unitary transformation. More...

virtual void	UniformlyControlledSingleBit (const std::vector< bitLenInt > &controls, bitLenInt qubit, const complex *mtrxs, const std::vector< bitCapInt > &mtrxSkipPowers, const bitCapInt &mtrxSkipValueMask)

virtual void	TimeEvolve (Hamiltonian h, real1_f timeDiff)
	To define a Hamiltonian, give a vector of controlled single bit gates ("HamiltonianOp" instances) that are applied by left-multiplication in low-to-high vector index order on the state vector. More...

virtual void	AntiCSwap (const std::vector< bitLenInt > &controls, bitLenInt qubit1, bitLenInt qubit2)
	Apply a swap with arbitrary (anti) control bits. More...

virtual void	AntiCSqrtSwap (const std::vector< bitLenInt > &controls, bitLenInt qubit1, bitLenInt qubit2)
	Apply a square root of swap with arbitrary (anti) control bits. More...

virtual void	AntiCISqrtSwap (const std::vector< bitLenInt > &controls, bitLenInt qubit1, bitLenInt qubit2)
	Apply an inverse square root of swap with arbitrary (anti) control bits. More...

virtual void	CCNOT (bitLenInt control1, bitLenInt control2, bitLenInt target)
	Doubly-controlled NOT gate. More...

virtual void	AntiCCNOT (bitLenInt control1, bitLenInt control2, bitLenInt target)
	Anti doubly-controlled NOT gate. More...

virtual void	CNOT (bitLenInt control, bitLenInt target)
	Controlled NOT gate. More...

virtual void	AntiCNOT (bitLenInt control, bitLenInt target)
	Anti controlled NOT gate. More...

virtual void	CY (bitLenInt control, bitLenInt target)
	Controlled Y gate. More...

virtual void	AntiCY (bitLenInt control, bitLenInt target)
	Anti controlled Y gate. More...

virtual void	CCY (bitLenInt control1, bitLenInt control2, bitLenInt target)
	Doubly-Controlled Y gate. More...

virtual void	AntiCCY (bitLenInt control1, bitLenInt control2, bitLenInt target)
	Anti doubly-controlled Y gate. More...

virtual void	CZ (bitLenInt control, bitLenInt target)
	Controlled Z gate. More...

virtual void	AntiCZ (bitLenInt control, bitLenInt target)
	Anti controlled Z gate. More...

virtual void	CCZ (bitLenInt control1, bitLenInt control2, bitLenInt target)
	Doubly-Controlled Z gate. More...

virtual void	AntiCCZ (bitLenInt control1, bitLenInt control2, bitLenInt target)
	Anti doubly-controlled Z gate. More...

virtual void	U (bitLenInt target, real1_f theta, real1_f phi, real1_f lambda)
	General unitary gate. More...

virtual void	U2 (bitLenInt target, real1_f phi, real1_f lambda)
	2-parameter unitary gate More...

virtual void	IU2 (bitLenInt target, real1_f phi, real1_f lambda)
	Inverse 2-parameter unitary gate. More...

virtual void	AI (bitLenInt target, real1_f azimuth, real1_f inclination)
	"Azimuth, Inclination" (RY-RZ) More...

virtual void	IAI (bitLenInt target, real1_f azimuth, real1_f inclination)
	Invert "Azimuth, Inclination" (RY-RZ) More...

virtual void	CAI (bitLenInt control, bitLenInt target, real1_f azimuth, real1_f inclination)
	Controlled "Azimuth, Inclination" (RY-RZ) More...

virtual void	AntiCAI (bitLenInt control, bitLenInt target, real1_f azimuth, real1_f inclination)
	(Anti-)Controlled "Azimuth, Inclination" (RY-RZ) More...

virtual void	CIAI (bitLenInt control, bitLenInt target, real1_f azimuth, real1_f inclination)
	Controlled inverse "Azimuth, Inclination" (RY-RZ) More...

virtual void	AntiCIAI (bitLenInt control, bitLenInt target, real1_f azimuth, real1_f inclination)
	(Anti-)Controlled inverse "Azimuth, Inclination" (RY-RZ) More...

virtual void	CU (const std::vector< bitLenInt > &controls, bitLenInt target, real1_f theta, real1_f phi, real1_f lambda)
	Controlled general unitary gate. More...

virtual void	AntiCU (const std::vector< bitLenInt > &controls, bitLenInt target, real1_f theta, real1_f phi, real1_f lambda)
	(Anti-)Controlled general unitary gate More...

virtual void	H (bitLenInt qubit)
	Hadamard gate. More...

virtual void	SqrtH (bitLenInt qubit)
	Square root of Hadamard gate. More...

virtual void	SH (bitLenInt qubit)
	Y-basis transformation gate. More...

virtual void	HIS (bitLenInt qubit)
	Y-basis (inverse) transformation gate. More...

virtual void	S (bitLenInt qubit)
	S gate. More...

virtual void	IS (bitLenInt qubit)
	Inverse S gate. More...

virtual void	T (bitLenInt qubit)
	T gate. More...

virtual void	IT (bitLenInt qubit)
	Inverse T gate. More...

virtual void	PhaseRootN (bitLenInt n, bitLenInt qubit)
	"PhaseRootN" gate More...

virtual void	PhaseRootNMask (bitLenInt n, const bitCapInt &mask)
	Masked PhaseRootN gate. More...

virtual void	PhaseParity (real1_f radians, const bitCapInt &mask)
	Parity phase gate. More...

virtual void	XMask (const bitCapInt &mask)
	Masked X gate. More...

virtual void	Y (bitLenInt qubit)
	Y gate. More...

virtual void	YMask (const bitCapInt &mask)
	Masked Y gate. More...

virtual void	Z (bitLenInt qubit)
	Z gate. More...

virtual void	ZMask (const bitCapInt &mask)
	Masked Z gate. More...

virtual void	SqrtX (bitLenInt qubit)
	Square root of X gate. More...

virtual void	ISqrtX (bitLenInt qubit)
	Inverse square root of X gate. More...

virtual void	SqrtY (bitLenInt qubit)
	Square root of Y gate. More...

virtual void	ISqrtY (bitLenInt qubit)
	Inverse square root of Y gate. More...

virtual void	SqrtW (bitLenInt qubit)
	Square root of W gate. More...

virtual void	ISqrtW (bitLenInt qubit)
	Inverse square root of W gate. More...

virtual void	CH (bitLenInt control, bitLenInt target)
	Controlled H gate. More...

virtual void	AntiCH (bitLenInt control, bitLenInt target)
	(Anti-)controlled H gate More...

virtual void	CS (bitLenInt control, bitLenInt target)
	Controlled S gate. More...

virtual void	AntiCS (bitLenInt control, bitLenInt target)
	(Anti-)controlled S gate More...

virtual void	CIS (bitLenInt control, bitLenInt target)
	Controlled inverse S gate. More...

virtual void	AntiCIS (bitLenInt control, bitLenInt target)
	(Anti-)controlled inverse S gate More...

virtual void	CT (bitLenInt control, bitLenInt target)
	Controlled T gate. More...

virtual void	CIT (bitLenInt control, bitLenInt target)
	Controlled inverse T gate. More...

virtual void	CPhaseRootN (bitLenInt n, bitLenInt control, bitLenInt target)
	Controlled "PhaseRootN" gate. More...

virtual void	AntiCPhaseRootN (bitLenInt n, bitLenInt control, bitLenInt target)
	(Anti-)controlled "PhaseRootN" gate More...

virtual void	CIPhaseRootN (bitLenInt n, bitLenInt control, bitLenInt target)
	Controlled inverse "PhaseRootN" gate. More...

virtual void	AntiCIPhaseRootN (bitLenInt n, bitLenInt control, bitLenInt target)
	(Anti-)controlled inverse "PhaseRootN" gate More...

virtual void	AND (bitLenInt inputBit1, bitLenInt inputBit2, bitLenInt outputBit)
	Quantum analog of classical "AND" gate. More...

virtual void	OR (bitLenInt inputBit1, bitLenInt inputBit2, bitLenInt outputBit)
	Quantum analog of classical "OR" gate. More...

virtual void	XOR (bitLenInt inputBit1, bitLenInt inputBit2, bitLenInt outputBit)
	Quantum analog of classical "XOR" gate. More...

virtual void	CLAND (bitLenInt inputQBit, bool inputClassicalBit, bitLenInt outputBit)
	Quantum analog of classical "AND" gate. More...

virtual void	CLOR (bitLenInt inputQBit, bool inputClassicalBit, bitLenInt outputBit)
	Quantum analog of classical "OR" gate. More...

virtual void	CLXOR (bitLenInt inputQBit, bool inputClassicalBit, bitLenInt outputBit)
	Quantum analog of classical "XOR" gate. More...

virtual void	NAND (bitLenInt inputBit1, bitLenInt inputBit2, bitLenInt outputBit)
	Quantum analog of classical "NAND" gate. More...

virtual void	NOR (bitLenInt inputBit1, bitLenInt inputBit2, bitLenInt outputBit)
	Quantum analog of classical "NOR" gate. More...

virtual void	XNOR (bitLenInt inputBit1, bitLenInt inputBit2, bitLenInt outputBit)
	Quantum analog of classical "XNOR" gate. More...

virtual void	CLNAND (bitLenInt inputQBit, bool inputClassicalBit, bitLenInt outputBit)
	Quantum analog of classical "NAND" gate. More...

virtual void	CLNOR (bitLenInt inputQBit, bool inputClassicalBit, bitLenInt outputBit)
	Quantum analog of classical "NOR" gate. More...

virtual void	CLXNOR (bitLenInt inputQBit, bool inputClassicalBit, bitLenInt outputBit)
	Quantum analog of classical "XNOR" gate. More...

virtual void	UniformlyControlledRY (const std::vector< bitLenInt > &controls, bitLenInt qubit, const real1 *angles)
	Apply a "uniformly controlled" rotation of a bit around the Pauli Y axis. More...

virtual void	UniformlyControlledRZ (const std::vector< bitLenInt > &controls, bitLenInt qubit, const real1 *angles)
	Apply a "uniformly controlled" rotation of a bit around the Pauli Z axis. More...

virtual void	RT (real1_f radians, bitLenInt qubit)
	Phase shift gate. More...

virtual void	RX (real1_f radians, bitLenInt qubit)
	X axis rotation gate. More...

virtual void	RY (real1_f radians, bitLenInt qubit)
	Y axis rotation gate. More...

virtual void	RZ (real1_f radians, bitLenInt qubit)
	Z axis rotation gate. More...

virtual void	CRZ (real1_f radians, bitLenInt control, bitLenInt target)
	Controlled Z axis rotation gate. More...

virtual void	CRY (real1_f radians, bitLenInt control, bitLenInt target)
	Controlled Y axis rotation gate. More...

virtual void	RTDyad (int numerator, int denomPower, bitLenInt qubit)
	Dyadic fraction phase shift gate. More...

virtual void	RXDyad (int numerator, int denomPower, bitLenInt qubit)
	Dyadic fraction X axis rotation gate. More...

virtual void	Exp (real1_f radians, bitLenInt qubit)
	(Identity) Exponentiation gate More...

virtual void	Exp (const std::vector< bitLenInt > &controls, bitLenInt qubit, const complex *matrix2x2, bool antiCtrled=false)
	Imaginary exponentiation of arbitrary 2x2 gate. More...

virtual void	ExpDyad (int numerator, int denomPower, bitLenInt qubit)
	Dyadic fraction (identity) exponentiation gate. More...

virtual void	ExpX (real1_f radians, bitLenInt qubit)
	Pauli X exponentiation gate. More...

virtual void	ExpXDyad (int numerator, int denomPower, bitLenInt qubit)
	Dyadic fraction Pauli X exponentiation gate. More...

virtual void	ExpY (real1_f radians, bitLenInt qubit)
	Pauli Y exponentiation gate. More...

virtual void	ExpYDyad (int numerator, int denomPower, bitLenInt qubit)
	Dyadic fraction Pauli Y exponentiation gate. More...

virtual void	ExpZ (real1_f radians, bitLenInt qubit)
	Pauli Z exponentiation gate. More...

virtual void	ExpZDyad (int numerator, int denomPower, bitLenInt qubit)
	Dyadic fraction Pauli Z exponentiation gate. More...

virtual void	CRX (real1_f radians, bitLenInt control, bitLenInt target)
	Controlled X axis rotation gate. More...

virtual void	CRXDyad (int numerator, int denomPower, bitLenInt control, bitLenInt target)
	Controlled dyadic fraction X axis rotation gate. More...

virtual void	RYDyad (int numerator, int denomPower, bitLenInt qubit)
	Dyadic fraction Y axis rotation gate. More...

virtual void	CRYDyad (int numerator, int denomPower, bitLenInt control, bitLenInt target)
	Controlled dyadic fraction y axis rotation gate. More...

virtual void	RZDyad (int numerator, int denomPower, bitLenInt qubit)
	Dyadic fraction Z axis rotation gate. More...

virtual void	CRZDyad (int numerator, int denomPower, bitLenInt control, bitLenInt target)
	Controlled dyadic fraction Z axis rotation gate. More...

virtual void	CRT (real1_f radians, bitLenInt control, bitLenInt target)
	Controlled "phase shift gate". More...

virtual void	CRTDyad (int numerator, int denomPower, bitLenInt control, bitLenInt target)
	Controlled dyadic fraction "phase shift gate". More...

virtual void	H (bitLenInt start, bitLenInt length)
	Bitwise Hadamard. More...

virtual void	X (bitLenInt start, bitLenInt length)
	Bitwise Pauli X (or logical "NOT") operator. More...

virtual void	ROL (bitLenInt shift, bitLenInt start, bitLenInt length)
	Circular shift left - shift bits left, and carry last bits. More...

virtual void	ROR (bitLenInt shift, bitLenInt start, bitLenInt length)
	Circular shift right - shift bits right, and carry first bits. More...

virtual void	ASL (bitLenInt shift, bitLenInt start, bitLenInt length)
	Arithmetic shift left, with last 2 bits as sign and carry. More...

virtual void	ASR (bitLenInt shift, bitLenInt start, bitLenInt length)
	Arithmetic shift right, with last 2 bits as sign and carry. More...

virtual void	LSL (bitLenInt shift, bitLenInt start, bitLenInt length)
	Logical shift left, filling the extra bits with \|0> More...

virtual void	LSR (bitLenInt shift, bitLenInt start, bitLenInt length)
	Logical shift right, filling the extra bits with \|0> More...

virtual void	FullAdd (bitLenInt inputBit1, bitLenInt inputBit2, bitLenInt carryInSumOut, bitLenInt carryOut)
	Quantum analog of classical "Full Adder" gate. More...

virtual void	IFullAdd (bitLenInt inputBit1, bitLenInt inputBit2, bitLenInt carryInSumOut, bitLenInt carryOut)
	Inverse of FullAdd. More...

virtual void	CFullAdd (const std::vector< bitLenInt > &controls, bitLenInt inputBit1, bitLenInt inputBit2, bitLenInt carryInSumOut, bitLenInt carryOut)
	Controlled quantum analog of classical "Full Adder" gate. More...

virtual void	CIFullAdd (const std::vector< bitLenInt > &controls, bitLenInt inputBit1, bitLenInt inputBit2, bitLenInt carryInSumOut, bitLenInt carryOut)
	Inverse of CFullAdd. More...

virtual void	ADC (bitLenInt input1, bitLenInt input2, bitLenInt output, bitLenInt length, bitLenInt carry)
	Add a quantum integer to a quantum integer, with carry. More...

virtual void	IADC (bitLenInt input1, bitLenInt input2, bitLenInt output, bitLenInt length, bitLenInt carry)
	Inverse of ADC. More...

virtual void	CADC (const std::vector< bitLenInt > &controls, bitLenInt input1, bitLenInt input2, bitLenInt output, bitLenInt length, bitLenInt carry)
	Add a quantum integer to a quantum integer, with carry and with controls. More...

virtual void	CIADC (const std::vector< bitLenInt > &controls, bitLenInt input1, bitLenInt input2, bitLenInt output, bitLenInt length, bitLenInt carry)
	Inverse of CADC. More...

virtual void	QFT (bitLenInt start, bitLenInt length, bool trySeparate=false)
	Quantum Fourier Transform - Apply the quantum Fourier transform to the register. More...

virtual void	QFTR (const std::vector< bitLenInt > &qubits, bool trySeparate=false)
	Quantum Fourier Transform (random access) - Apply the quantum Fourier transform to the register. More...

virtual void	IQFT (bitLenInt start, bitLenInt length, bool trySeparate=false)
	Inverse Quantum Fourier Transform - Apply the inverse quantum Fourier transform to the register. More...

virtual void	IQFTR (const std::vector< bitLenInt > &qubits, bool trySeparate=false)
	Inverse Quantum Fourier Transform (random access) - Apply the inverse quantum Fourier transform to the register. More...

virtual void	ZeroPhaseFlip (bitLenInt start, bitLenInt length)
	Reverse the phase of the state where the register equals zero. More...

virtual void	PhaseFlip ()
	Phase flip always - equivalent to Z X Z X on any bit in the QInterface. More...

virtual void	SetReg (bitLenInt start, bitLenInt length, const bitCapInt &value)
	Set register bits to given permutation. More...

virtual bitCapInt	MReg (bitLenInt start, bitLenInt length)
	Measure permutation state of a register. More...

virtual bitCapInt	ForceMReg (bitLenInt start, bitLenInt length, const bitCapInt &result, bool doForce=true, bool doApply=true)
	Act as if is a measurement was applied, except force the (usually random) result. More...

virtual bitCapInt	M (const std::vector< bitLenInt > &bits)
	Measure bits with indices in array, and return a mask of the results. More...

virtual bitCapInt	ForceM (const std::vector< bitLenInt > &bits, const std::vector< bool > &values, bool doApply=true)
	Measure bits with indices in array, and return a mask of the results. More...

virtual void	Reverse (bitLenInt first, bitLenInt last)
	Reverse all of the bits in a sequence. More...

virtual real1_f	CProb (bitLenInt control, bitLenInt target)
	Direct measure of bit probability to be in \|1> state, if control bit is \|1>. More...

virtual real1_f	ACProb (bitLenInt control, bitLenInt target)
	Direct measure of bit probability to be in \|1> state, if control bit is \|0>. More...

virtual bitCapInt	HighestProbAll ()
	Get highest probability permutation. More...

virtual std::vector< bitCapInt >	HighestProbAll (size_t n)
	Get top-n highest probability permutations. More...

virtual real1_f	ProbReg (bitLenInt start, bitLenInt length, const bitCapInt &permutation)
	Direct measure of register permutation probability. More...

virtual real1_f	ProbMask (const bitCapInt &mask, const bitCapInt &permutation)
	Direct measure of masked permutation probability. More...

virtual void	ProbMaskAll (const bitCapInt &mask, real1 *probsArray)
	Direct measure of masked permutation probability. More...

virtual void	ProbBitsAll (const std::vector< bitLenInt > &bits, real1 *probsArray)
	Direct measure of listed permutation probability. More...

virtual real1_f	VarianceBitsAll (const std::vector< bitLenInt > &bits, const bitCapInt &offset=ZERO_BCI)
	Direct measure of variance of listed permutation probability. More...

virtual real1_f	VarianceBitsAllRdm (bool roundRz, const std::vector< bitLenInt > &bits, const bitCapInt &offset=ZERO_BCI)
	Direct measure of (reduced density matrix) variance of listed permutation probability. More...

virtual real1_f	VariancePauliAll (std::vector< bitLenInt > bits, std::vector< Pauli > paulis)
	Direct measure of variance of listed Pauli tensor product probability. More...

virtual real1_f	VarianceUnitaryAll (const std::vector< bitLenInt > &bits, const std::vector< real1_f > &basisOps, std::vector< real1_f > eigenVals={})
	Direct measure of variance of listed (3-parameter) single-qubit tensor product probability. More...

virtual real1_f	VarianceUnitaryAll (const std::vector< bitLenInt > &bits, const std::vector< std::shared_ptr< complex >> &basisOps, std::vector< real1_f > eigenVals={})
	Direct measure of variance of listed (2x2 operator) single-qubit tensor product probability. More...

virtual real1_f	VarianceFloatsFactorized (const std::vector< bitLenInt > &bits, const std::vector< real1_f > &weights)
	Direct measure of variance of listed bit string probability. More...

virtual real1_f	VarianceFloatsFactorizedRdm (bool roundRz, const std::vector< bitLenInt > &bits, const std::vector< real1_f > &weights)
	Direct measure of (reduced density matrix) variance of bits, given an array of qubit weights. More...

virtual real1_f	VarianceBitsFactorized (const std::vector< bitLenInt > &bits, const std::vector< bitCapInt > &perms, const bitCapInt &offset=ZERO_BCI)
	Get expectation value of bits, given an array of qubit weights. More...

virtual real1_f	VarianceBitsFactorizedRdm (bool roundRz, const std::vector< bitLenInt > &bits, const std::vector< bitCapInt > &perms, const bitCapInt &offset=ZERO_BCI)
	Get (reduced density matrix) expectation value of bits, given an array of qubit weights. More...

virtual real1_f	ExpectationBitsAll (const std::vector< bitLenInt > &bits, const bitCapInt &offset=ZERO_BCI)
	Get permutation expectation value of bits. More...

virtual real1_f	ExpectationPauliAll (std::vector< bitLenInt > bits, std::vector< Pauli > paulis)
	Get Pauli tensor product observable. More...

virtual real1_f	ExpectationUnitaryAll (const std::vector< bitLenInt > &bits, const std::vector< std::shared_ptr< complex >> &basisOps, std::vector< real1_f > eigenVals={})
	Get single-qubit tensor product (arbitrary real) observable. More...

virtual real1_f	ExpectationUnitaryAll (const std::vector< bitLenInt > &bits, const std::vector< real1_f > &basisOps, std::vector< real1_f > eigenVals={})
	Get single-qubit (3-parameter) tensor product (arbitrary real) observable. More...

virtual real1_f	ExpectationBitsFactorized (const std::vector< bitLenInt > &bits, const std::vector< bitCapInt > &perms, const bitCapInt &offset=ZERO_BCI)
	Get expectation value of bits, given an array of qubit weights. More...

virtual real1_f	ExpectationBitsFactorizedRdm (bool roundRz, const std::vector< bitLenInt > &bits, const std::vector< bitCapInt > &perms, const bitCapInt &offset=ZERO_BCI)
	Get (reduced density matrix) expectation value of bits, given an array of qubit weights. More...

virtual real1_f	ExpectationFloatsFactorized (const std::vector< bitLenInt > &bits, const std::vector< real1_f > &weights)
	Get expectation value of bits, given a (floating-point) array of qubit weights. More...

virtual real1_f	ExpectationFloatsFactorizedRdm (bool roundRz, const std::vector< bitLenInt > &bits, const std::vector< real1_f > &weights)
	Get (reduced density matrix) expectation value of bits, given a (floating-point) array of qubit weights. More...

virtual real1_f	ProbRdm (bitLenInt qubit)
	Direct measure of bit probability to be in \|1> state, treating all ancillary qubits as post-selected T gate gadgets. More...

virtual real1_f	ProbAllRdm (bool roundRz, const bitCapInt &fullRegister)
	Direct measure of full permutation probability, treating all ancillary qubits as post-selected T gate gadgets. More...

virtual real1_f	ProbMaskRdm (bool roundRz, const bitCapInt &mask, const bitCapInt &permutation)
	Direct measure of masked permutation probability, treating all ancillary qubits as post-selected T gate gadgets. More...

virtual real1_f	ExpectationBitsAllRdm (bool roundRz, const std::vector< bitLenInt > &bits, const bitCapInt &offset=ZERO_BCI)
	Get permutation expectation value of bits, treating all ancillary qubits as post-selected T gate gadgets. More...

virtual std::map< bitCapInt, int >	MultiShotMeasureMask (const std::vector< bitCapInt > &qPowers, unsigned shots)
	Statistical measure of masked permutation probability. More...

virtual void	MultiShotMeasureMask (const std::vector< bitCapInt > &qPowers, unsigned shots, unsigned long long *shotsArray)
	Statistical measure of masked permutation probability (returned as array) More...

virtual void	SetBit (bitLenInt qubit, bool value)
	Set individual bit to pure \|0> (false) or \|1> (true) state. More...

virtual bool	ApproxCompare (QInterfacePtr toCompare, real1_f error_tol=TRYDECOMPOSE_EPSILON)
	Compare state vectors approximately, to determine whether this state vector is the same as the target. More...

virtual void	Finish ()
	If asynchronous work is still running, block until it finishes. More...

virtual bool	isFinished ()
	Returns "false" if asynchronous work is still running, and "true" if all previously dispatched asynchronous work is done. More...

virtual void	Dump ()
	If asynchronous work is still running, let the simulator know that it can be aborted. More...

virtual bool	isClifford ()
	Returns "true" if current state is identifiably within the Clifford set, or "false" if it is not or cannot be determined. More...

virtual bool	isClifford (bitLenInt qubit)
	Returns "true" if current qubit state is identifiably within the Clifford set, or "false" if it is not or cannot be determined. More...

virtual bool	isOpenCL ()
	Returns "true" if current simulation is OpenCL-based. More...

virtual double	GetUnitaryFidelity ()
	When "Schmidt-decomposition rounding parameter" ("SDRP") is being used, starting from initial 1.0 fidelity, we compound the "unitary fidelity" by successive multiplication by one minus two times the true unitary probability discarded in each single rounding event. More...

virtual void	ResetUnitaryFidelity ()
	Reset the internal fidelity calculation tracker to 1.0. More...

virtual void	SetSdrp (real1_f sdrp)
	Set the "Schmidt decomposition rounding parameter" value, (between 0 and 1) More...

virtual void	SetNcrp (real1_f ncrp)
	Set the "Near-clifford rounding parameter" value, (between 0 and 1) More...

virtual void	SetReactiveSeparate (bool isAggSep)
	Set reactive separation option (on by default if available) More...

virtual bool	GetReactiveSeparate ()
	Get reactive separation option. More...

virtual void	SetTInjection (bool useGadget)
	Set the option to use T-injection gadgets (off by default) More...

virtual bool	GetTInjection ()
	Get the option to use T-injection gadgets. More...

virtual void	SetNoiseParameter (real1_f lambda)
	Set the noise level option (only for a noisy interface) More...

virtual real1_f	GetNoiseParameter ()
	Get the noise level option (only for a noisy interface) More...

virtual void	SetAceMaxQubits (bitLenInt qb)
	Set the "automatic circuit elision" (ACE) maximum entangled subsystem qubit count. More...

virtual void	SetSparseAceMaxMb (size_t mb)
	Set the (sparse-simulation) "automatic circuit elision" (ACE) maximum memory megabytes. More...

bitCapIntOcl	GetMaxSize ()
	Get maximum number of amplitudes that can be allocated on current device. More...

virtual real1_f	FirstNonzeroPhase ()
	Get phase of lowest permutation nonzero amplitude. More...

virtual void	DepolarizingChannelWeak1Qb (bitLenInt qubit, real1_f lambda)
	Simulate a local qubit depolarizing noise channel, under a stochastic "weak simulation condition." Under "weak" condition, sampling and exact state queries are not accurate, but sampling can be achieved via repeated full execution of a noisy circuit, for each hardware-realistic measurement sample. More...

Public Member Functions inherited from Qrack::ParallelFor
	ParallelFor ()

void	SetConcurrencyLevel (unsigned num)

unsigned	GetConcurrencyLevel ()

bitCapIntOcl	GetStride ()

bitLenInt	GetPreferredConcurrencyPower ()

void	par_for_inc (const bitCapIntOcl begin, const bitCapIntOcl itemCount, IncrementFunc, ParallelFunc fn)
	Iterate through the permutations a maximum of end-begin times, allowing the caller to control the incrementation offset through 'inc'. More...

void	par_for (const bitCapIntOcl begin, const bitCapIntOcl end, ParallelFunc fn)
	Call fn once for every numerical value between begin and end. More...

void	par_for_skip (const bitCapIntOcl begin, const bitCapIntOcl end, const bitCapIntOcl skipPower, const bitLenInt skipBitCount, ParallelFunc fn)
	Skip over the skipPower bits. More...

void	par_for_mask (const bitCapIntOcl, const bitCapIntOcl, const std::vector< bitCapIntOcl > &maskArray, ParallelFunc fn)
	Skip over the bits listed in maskArray in the same fashion as par_for_skip. More...

void	par_for_set (const std::set< bitCapIntOcl > &sparseSet, ParallelFunc fn)
	Iterate over a sparse state vector. More...

void	par_for_set (const std::vector< bitCapIntOcl > &sparseSet, ParallelFunc fn)
	Iterate over a sparse state vector. More...

void	par_for_sparse_compose (const std::vector< bitCapIntOcl > &lowSet, const std::vector< bitCapIntOcl > &highSet, const bitLenInt &highStart, ParallelFunc fn)
	Iterate over the power set of 2 sparse state vectors. More...

real1_f	par_norm (const bitCapIntOcl maxQPower, const StateVectorPtr stateArray, real1_f norm_thresh=ZERO_R1_F)
	Calculate the normal for the array, (with flooring). More...

real1_f	par_norm_exact (const bitCapIntOcl maxQPower, const StateVectorPtr stateArray)
	Calculate the normal for the array, (without flooring.) More...

Protected Member Functions
QEnginePtr	MakeQEngine (bitLenInt qbCount, const bitCapInt &perm=ZERO_BCI)

template<typename Fn >
void	GetTraversal (Fn getLambda)

template<typename Fn >
void	SetTraversal (Fn setLambda)

template<typename Fn >
void	ExecuteAsStateVector (Fn operation)

template<typename Fn >
bitCapInt	BitCapIntAsStateVector (Fn operation)

template<typename Fn >
bool	BoolAsStateVector (Fn operation)

void	par_for_qbdt (const bitCapInt &end, bitLenInt maxQubit, BdtFunc fn, bool branch=true)

void	_par_for (const bitCapInt &end, ParallelFuncBdt fn)

void	DecomposeDispose (bitLenInt start, bitLenInt length, QBdtPtr dest)

void	ApplyControlledSingle (const complex *mtrx, std::vector< bitLenInt > controls, bitLenInt target, bool isAnti)

void	ApplySingle (const complex *mtrx, bitLenInt target)

void	Init ()

bitCapInt	MAllOptionalCollapse (bool isCollapsing)

bitCapInt	SampleClone (const std::vector< bitCapInt > &qPowers)

void	Copy (QInterfacePtr orig)

void	Copy (QBdtPtr orig)

virtual void	Copy (QInterfacePtr orig)
	Copy this QInterface. More...

virtual QInterfacePtr	Copy ()
	Copy this QInterface. More...

Protected Member Functions inherited from Qrack::QInterface
complex	GetNonunitaryPhase ()

template<typename Fn >
void	MACWrapper (const std::vector< bitLenInt > &controls, Fn fn)

virtual real1_f	ExpVarUnitaryAll (bool isExp, const std::vector< bitLenInt > &bits, const std::vector< std::shared_ptr< complex >> &basisOps, std::vector< real1_f > eigenVals={})

virtual real1_f	ExpVarUnitaryAll (bool isExp, const std::vector< bitLenInt > &bits, const std::vector< real1_f > &basisOps, std::vector< real1_f > eigenVals={})

virtual real1_f	ExpVarBitsAll (bool isExp, const std::vector< bitLenInt > &bits, const bitCapInt &offset=ZERO_BCI)

Static Protected Member Functions
static size_t	SelectBit (const bitCapInt &perm, bitLenInt bit)

static bitCapInt	RemovePower (const bitCapInt &perm, bitCapInt power)

Static Protected Member Functions inherited from Qrack::QInterface
static real1_f	normHelper (const complex &c)

static real1_f	clampProb (real1_f toClamp)

Protected Attributes
bitLenInt	bdtStride

int64_t	devID

QBdtNodeInterfacePtr	root

bitCapInt	bdtMaxQPower

std::vector< int64_t >	deviceIDs

std::vector< QInterfaceEngine >	engines

Protected Attributes inherited from Qrack::QInterface
bool	doNormalize

bool	randGlobalPhase

bool	useRDRAND

bitLenInt	qubitCount

uint32_t	randomSeed

real1	amplitudeFloor

bitCapInt	maxQPower

qrack_rand_gen_ptr	rand_generator

std::uniform_real_distribution< real1_s >	rand_distribution

std::shared_ptr< RdRandom >	hardware_rand_generator

Constructor & Destructor Documentation

◆ QBdt() [1/2]

Qrack::QBdt::QBdt	(	std::vector< QInterfaceEngine >	eng,
		bitLenInt	qBitCount,
		const bitCapInt &	initState = `ZERO_BCI`,
		qrack_rand_gen_ptr	rgp = `nullptr`,
		const complex &	phaseFac = `CMPLX_DEFAULT_ARG`,
		bool	doNorm = `false`,
		bool	randomGlobalPhase = `true`,
		bool	useHostMem = `false`,
		int64_t	deviceId = `-1`,
		bool	useHardwareRNG = `true`,
		bool	useSparseStateVec = `false`,
		real1_f	norm_thresh = `REAL1_EPSILON`,
		std::vector< int64_t >	ignored = `{}`,
		bitLenInt	qubitThreshold = `0`,
		real1_f	separation_thresh = `_qrack_qunit_sep_thresh`
	)

◆ QBdt() [2/2]

Qrack::QBdt::QBdt	(	bitLenInt	qBitCount,
		const bitCapInt &	initState = `ZERO_BCI`,
		qrack_rand_gen_ptr	rgp = `nullptr`,
		const complex &	phaseFac = `CMPLX_DEFAULT_ARG`,
		bool	doNorm = `false`,
		bool	randomGlobalPhase = `true`,
		bool	useHostMem = `false`,
		int64_t	deviceId = `-1`,
		bool	useHardwareRNG = `true`,
		bool	useSparseStateVec = `false`,
		real1_f	norm_thresh = `REAL1_EPSILON`,
		std::vector< int64_t >	devList = `{}`,
		bitLenInt	qubitThreshold = `0U`,
		real1_f	separation_thresh = `_qrack_qunit_sep_thresh`
	)

inline

Member Function Documentation

◆ _par_for()

void Qrack::QBdt::_par_for	(	const bitCapInt &	end,
		ParallelFuncBdt	fn
	)

protected

◆ Allocate() [1/3]

virtual bitLenInt Qrack::QInterface::Allocate

inline

Allocate new "length" count of |0> state qubits at end of qubit index position.

◆ Allocate() [2/3]

bitLenInt Qrack::QBdt::Allocate	(	bitLenInt	start,
		bitLenInt	length
	)

virtual

Allocate new "length" count of |0> state qubits at specified qubit index start position.

Implements Qrack::QInterface.

◆ Allocate() [3/3]

virtual bitLenInt Qrack::QInterface::Allocate

Allocate new "length" count of |0> state qubits at specified qubit index start position.

◆ ApplyControlledSingle()

void Qrack::QBdt::ApplyControlledSingle	(	const complex *	mtrx,
		std::vector< bitLenInt >	controls,
		bitLenInt	target,
		bool	isAnti
	)

protected

◆ ApplySingle()

void Qrack::QBdt::ApplySingle	(	const complex *	mtrx,
		bitLenInt	target
	)

protected

◆ BitCapIntAsStateVector()

template<typename Fn >

bitCapInt Qrack::QBdt::BitCapIntAsStateVector ( Fn operation )

inlineprotected

◆ BoolAsStateVector()

template<typename Fn >

bool Qrack::QBdt::BoolAsStateVector ( Fn operation )

inlineprotected

◆ CDEC()

void Qrack::QBdt::CDEC	(	const bitCapInt &	toSub,
		bitLenInt	start,
		bitLenInt	length,
		const std::vector< bitLenInt > &	controls
	)

inlinevirtual

Subtract integer (without sign, with controls)

Reimplemented from Qrack::QAlu.

◆ CDIV()

void Qrack::QBdt::CDIV	(	const bitCapInt &	toDiv,
		bitLenInt	start,
		bitLenInt	carryStart,
		bitLenInt	length,
		const std::vector< bitLenInt > &	controls
	)

inlinevirtual

Controlled division by power of integer.

Implements Qrack::QAlu.

◆ CIMULModNOut()

void Qrack::QBdt::CIMULModNOut	(	const bitCapInt &	toMul,
		const bitCapInt &	modN,
		bitLenInt	inStart,
		bitLenInt	outStart,
		bitLenInt	length,
		const std::vector< bitLenInt > &	controls
	)

inlinevirtual

Inverse of controlled multiplication modulo N by integer, (out of place)

Implements Qrack::QAlu.

◆ CINC()

void Qrack::QBdt::CINC	(	const bitCapInt &	toAdd,
		bitLenInt	start,
		bitLenInt	length,
		const std::vector< bitLenInt > &	controls
	)

inlinevirtual

Add integer (without sign, with controls)

Implements Qrack::QAlu.

◆ CISqrtSwap()

void Qrack::QBdt::CISqrtSwap	(	const std::vector< bitLenInt > &	controls,
		bitLenInt	qubit1,
		bitLenInt	qubit2
	)

inlinevirtual

Apply an inverse square root of swap with arbitrary control bits.

Reimplemented from Qrack::QInterface.

◆ Clone()

QInterfacePtr Qrack::QBdt::Clone ( )

virtual

Clone this QInterface.

Implements Qrack::QInterface.

◆ CMUL()

void Qrack::QBdt::CMUL	(	const bitCapInt &	toMul,
		bitLenInt	start,
		bitLenInt	carryStart,
		bitLenInt	length,
		const std::vector< bitLenInt > &	controls
	)

inlinevirtual

Controlled multiplication by integer.

Implements Qrack::QAlu.

◆ CMULModNOut()

void Qrack::QBdt::CMULModNOut	(	const bitCapInt &	toMul,
		const bitCapInt &	modN,
		bitLenInt	inStart,
		bitLenInt	outStart,
		bitLenInt	length,
		const std::vector< bitLenInt > &	controls
	)

inlinevirtual

Controlled multiplication modulo N by integer, (out of place)

Implements Qrack::QAlu.

◆ Compose() [1/5]

bitLenInt Qrack::QBdt::Compose	(	QBdtPtr	toCopy,
		bitLenInt	start
	)

◆ Compose() [2/5]

virtual bitLenInt Qrack::QInterface::Compose

inline

Combine another QInterface with this one, after the last bit index of this one.

"Compose" combines the quantum description of state of two independent QInterface objects into one object, containing the full permutation basis of the full object. The "inputState" bits are added after the last qubit index of the QInterface to which we "Compose." Informally, "Compose" is equivalent to "just setting another group of qubits down next to the first" without interacting them. Schroedinger's equation can form a description of state for two independent subsystems at once or "separable quantum subsystems" without interacting them. Once the description of state of the independent systems is combined, we can interact them, and we can describe their entanglements to each other, in which case they are no longer independent. A full entangled description of quantum state is not possible for two independent quantum subsystems until we "Compose" them.

"Compose" multiplies the probabilities of the indepedent permutation states of the two subsystems to find the probabilites of the entire set of combined permutations, by simple combinatorial reasoning. If the probablity of the "left-hand" subsystem being in |00> is 1/4, and the probablity of the "right-hand" subsystem being in |101> is 1/8, than the probability of the combined |00101> permutation state is 1/32, and so on for all permutations of the new combined state.

If the programmer doesn't want to "cheat" quantum mechanically, then the original copy of the state which is duplicated into the larger QInterface should be "thrown away" to satisfy "no clone theorem." This is not semantically enforced in Qrack, because optimization of an emulator might be acheived by "cloning" "under-the-hood" while only exposing a quantum mechanically consistent API or instruction set.

Returns the quantum bit offset that the QInterface was appended at, such that bit 5 in toCopy is equal to offset+5 in this object.

◆ Compose() [3/5]

bitLenInt Qrack::QInterface::Compose

Compose() a QInterface peer, inserting its qubit into index order at start index.

◆ Compose() [4/5]

bitLenInt Qrack::QBdt::Compose	(	QInterfacePtr	toCopy,
		bitLenInt	start
	)

inlinevirtual

Compose() a QInterface peer, inserting its qubit into index order at start index.

Reimplemented from Qrack::QInterface.

◆ Compose() [5/5]

std::map< QInterfacePtr, bitLenInt > Qrack::QInterface::Compose

Compose() a vector of peer QInterface targets, in sequence.

◆ Copy() [1/4]

virtual QInterfacePtr Qrack::QInterface::Copy

inlineprotectedvirtual

Copy this QInterface.

Reimplemented from Qrack::QInterface.

◆ Copy() [2/4]

void Qrack::QBdt::Copy ( QBdtPtr orig )

inlineprotected

◆ Copy() [3/4]

virtual void Qrack::QInterface::Copy

inlineprotectedvirtual

Copy this QInterface.

Reimplemented from Qrack::QInterface.

◆ Copy() [4/4]

void Qrack::QBdt::Copy ( QInterfacePtr orig )

inlineprotectedvirtual

Reimplemented from Qrack::QInterface.

◆ CountBranches()

size_t Qrack::QBdt::CountBranches ( )

◆ CPhaseFlipIfLess()

void Qrack::QBdt::CPhaseFlipIfLess	(	const bitCapInt &	greaterPerm,
		bitLenInt	start,
		bitLenInt	length,
		bitLenInt	flagIndex
	)

inlinevirtual

The 6502 uses its carry flag also as a greater-than/less-than flag, for the CMP operation.

Implements Qrack::QAlu.

◆ CPOWModNOut()

void Qrack::QBdt::CPOWModNOut	(	const bitCapInt &	base,
		const bitCapInt &	modN,
		bitLenInt	inStart,
		bitLenInt	outStart,
		bitLenInt	length,
		const std::vector< bitLenInt > &	controls
	)

inlinevirtual

Controlled, raise a classical base to a quantum power, modulo N, (out of place)

Implements Qrack::QAlu.

◆ CSqrtSwap()

void Qrack::QBdt::CSqrtSwap	(	const std::vector< bitLenInt > &	controls,
		bitLenInt	qubit1,
		bitLenInt	qubit2
	)

inlinevirtual

Apply a square root of swap with arbitrary control bits.

Reimplemented from Qrack::QInterface.

◆ CSwap()

void Qrack::QBdt::CSwap	(	const std::vector< bitLenInt > &	controls,
		bitLenInt	qubit1,
		bitLenInt	qubit2
	)

inlinevirtual

Apply a swap with arbitrary control bits.

Reimplemented from Qrack::QInterface.

◆ CUniformParityRZ()

void Qrack::QBdt::CUniformParityRZ	(	const std::vector< bitLenInt > &	controls,
		const bitCapInt &	mask,
		real1_f	angle
	)

inlinevirtual

If the controls are set and the target qubit set parity is odd, this applies a phase factor of \(e^{i angle}\).

If the controls are set and the target qubit set parity is even, this applies the conjugate, \(e^{-i angle}\). Otherwise, do nothing if any control is not set.

Implements Qrack::QParity.

◆ DEC()

void Qrack::QBdt::DEC	(	const bitCapInt &	toSub,
		bitLenInt	start,
		bitLenInt	length
	)

inlinevirtual

Add integer (without sign)

Subtract integer (without sign)

Implements Qrack::QAlu.

◆ DECC()

void Qrack::QBdt::DECC	(	const bitCapInt &	toSub,
		bitLenInt	start,
		bitLenInt	length,
		bitLenInt	carryIndex
	)

inlinevirtual

Subtract classical integer (without sign, with carry)

Subtract integer (without sign, with carry)

Reimplemented from Qrack::QAlu.

◆ Decompose() [1/2]

QInterfacePtr Qrack::QBdt::Decompose	(	bitLenInt	start,
		bitLenInt	length
	)

virtual

Schmidt decompose a length of qubits.

Implements Qrack::QInterface.

◆ Decompose() [2/2]

void Qrack::QBdt::Decompose	(	bitLenInt	start,
		QInterfacePtr	dest
	)

inlinevirtual

Minimally decompose a set of contiguous bits from the separably composed unit, into "destination".

Minimally decompose a set of contigious bits from the separably composed unit. The length of this separable unit is reduced by the length of bits decomposed, and the bits removed are output in the destination QInterface pointer. The destination object must be initialized to the correct number of bits, in 0 permutation state. For quantum mechanical accuracy, the bit set removed and the bit set left behind should be quantum mechanically "separable."

Like how "Compose" is like "just setting another group of qubits down next to the first," if two sets of qubits are not entangled, then "Decompose" is like "just moving a few qubits away from the rest." Schroedinger's equation does not require bits to be explicitly interacted in order to describe their permutation basis, and the descriptions of state of separable subsystems, those which are not entangled with other subsystems, are just as easily removed from the description of state. (This is equivalent to a "Schmidt decomposition.")

If we have for example 5 qubits, and we wish to separate into "left" and "right" subsystems of 3 and 2 qubits, we sum probabilities of one permutation of the "left" three over ALL permutations of the "right" two, for all permutations, and vice versa, like so:

\( P(|1000>|xy>) = P(|1000 00>) + P(|1000 10>) + P(|1000 01>) + P(|1000 11>). \)

If the subsystems are not "separable," i.e. if they are entangled, this operation is not well-motivated, and its output is not necessarily defined. (The summing of probabilities over permutations of subsytems will be performed as described above, but this is not quantum mechanically meaningful.) To ensure that the subsystem is "separable," i.e. that it has no entanglements to other subsystems in the QInterface, it can be measured with M(), or else all qubits other than the subsystem can be measured.

Implements Qrack::QInterface.

◆ DecomposeDispose()

void Qrack::QBdt::DecomposeDispose	(	bitLenInt	start,
		bitLenInt	length,
		QBdtPtr	dest
	)

protected

◆ DECS()

void Qrack::QBdt::DECS	(	const bitCapInt &	toSub,
		bitLenInt	start,
		bitLenInt	length,
		bitLenInt	overflowIndex
	)

inlinevirtual

Add a classical integer to the register, with sign and without carry.

Subtract an integer from the register, with sign and without carry.

Because the register length is an arbitrary number of bits, the sign bit position on the integer to add is variable. Hence, the integer to add is specified as cast to an unsigned format, with the sign bit assumed to be set at the appropriate position before the cast.

Implements Qrack::QAlu.

◆ Dispose() [1/2]

void Qrack::QBdt::Dispose	(	bitLenInt	start,
		bitLenInt	length
	)

inlinevirtual

Minimally decompose a set of contiguous bits from the separably composed unit, and discard the separable bits from index "start" for "length.".

Minimally decompose a set of contigious bits from the separably composed unit. The length of this separable unit is reduced by the length of bits decomposed, and the bits removed are output in the destination QInterface pointer. The destination object must be initialized to the correct number of bits, in 0 permutation state. For quantum mechanical accuracy, the bit set removed and the bit set left behind should be quantum mechanically "separable."

Like how "Compose" is like "just setting another group of qubits down next to the first," if two sets of qubits are not entangled, then "Decompose" is like "just moving a few qubits away from the rest." Schroedinger's equation does not require bits to be explicitly interacted in order to describe their permutation basis, and the descriptions of state of separable subsystems, those which are not entangled with other subsystems, are just as easily removed from the description of state. (This is equivalent to a "Schmidt decomposition.")

If we have for example 5 qubits, and we wish to separate into "left" and "right" subsystems of 3 and 2 qubits, we sum probabilities of one permutation of the "left" three over ALL permutations of the "right" two, for all permutations, and vice versa, like so:

\( P(|1000>|xy>) = P(|1000 00>) + P(|1000 10>) + P(|1000 01>) + P(|1000 11>). \)

If the subsystems are not "separable," i.e. if they are entangled, this operation is not well-motivated, and its output is not necessarily defined. (The summing of probabilities over permutations of subsytems will be performed as described above, but this is not quantum mechanically meaningful.) To ensure that the subsystem is "separable," i.e. that it has no entanglements to other subsystems in the QInterface, it can be measured with M(), or else all qubits other than the subsystem can be measured.

Implements Qrack::QInterface.

◆ Dispose() [2/2]

void Qrack::QBdt::Dispose	(	bitLenInt	start,
		bitLenInt	length,
		const bitCapInt &	disposedPerm
	)

inlinevirtual

Dispose a a contiguous set of qubits that are already in a permutation eigenstate.

Implements Qrack::QInterface.

◆ DIV()

void Qrack::QBdt::DIV	(	const bitCapInt &	toDiv,
		bitLenInt	start,
		bitLenInt	carryStart,
		bitLenInt	length
	)

inlinevirtual

Divide by integer.

Implements Qrack::QAlu.

◆ ExecuteAsStateVector()

template<typename Fn >

void Qrack::QBdt::ExecuteAsStateVector ( Fn operation )

inlineprotected

◆ ForceM()

bool Qrack::QBdt::ForceM	(	bitLenInt	qubit,
		bool	result,
		bool	doForce = `true`,
		bool	doApply = `true`
	)

inlinevirtual

Act as if is a measurement was applied, except force the (usually random) result.

Warning: PSEUDO-QUANTUM

Implements Qrack::QInterface.

◆ ForceMParity()

bool Qrack::QBdt::ForceMParity	(	const bitCapInt &	mask,
		bool	result,
		bool	doForce = `true`
	)

inlinevirtual

Act as if is a measurement of parity of the masked set of qubits was applied, except force the (usually random) result.

Warning: PSEUDO-QUANTUM

Implements Qrack::QParity.

◆ FSim()

void Qrack::QBdt::FSim	(	real1_f	theta,
		real1_f	phi,
		bitLenInt	qubit1,
		bitLenInt	qubit2
	)

virtual

The 2-qubit "fSim" gate, (useful in the simulation of particles with fermionic statistics)

Reimplemented from Qrack::QInterface.

◆ GetAmplitude()

complex Qrack::QBdt::GetAmplitude ( const bitCapInt & perm )

virtual

Get the representational amplitude of a full permutation.

Warning: PSEUDO-QUANTUM

Implements Qrack::QInterface.

◆ GetDevice()

int64_t Qrack::QBdt::GetDevice ( )

inlinevirtual

Get the device index.

("-1" is default).

Reimplemented from Qrack::QInterface.

◆ GetDeviceList()

std::vector<int64_t> Qrack::QBdt::GetDeviceList ( )

inlinevirtual

Get the device index.

Reimplemented from Qrack::QInterface.

◆ GetProbs()

void Qrack::QBdt::GetProbs ( real1 * outputProbs )

inlinevirtual

Get the pure quantum state representation.

Implements Qrack::QInterface.

◆ GetQuantumState() [1/2]

void Qrack::QBdt::GetQuantumState ( complex * outputState )

inlinevirtual

Get the pure quantum state representation.

Warning: PSEUDO-QUANTUM

Implements Qrack::QInterface.

◆ GetQuantumState() [2/2]

void Qrack::QBdt::GetQuantumState ( QInterfacePtr eng )

inline

◆ GetTraversal()

template<typename Fn >

void Qrack::QBdt::GetTraversal ( Fn getLambda )

inlineprotected

◆ Hash()

void Qrack::QBdt::Hash	(	bitLenInt	start,
		bitLenInt	length,
		const unsigned char *	values
	)

inlinevirtual

Transform a length of qubit register via lookup through a hash table.

The hash table must be a one-to-one function, otherwise the behavior of this method is undefined. The value array definition convention is the same as IndexedLDA(). Essentially, this is an IndexedLDA() operation that replaces the index register with the value register, but the lookup table must therefore be one-to-one, for this operation to be unitary, as required.

Implements Qrack::QAlu.

◆ IISwap()

void Qrack::QBdt::IISwap	(	bitLenInt	qubit1,
		bitLenInt	qubit2
	)

inlinevirtual

Inverse ISwap - Swap values of two bits in register, and apply phase factor of -i if bits are different.

Reimplemented from Qrack::QInterface.

◆ IMULModNOut()

void Qrack::QBdt::IMULModNOut	(	const bitCapInt &	toMul,
		const bitCapInt &	modN,
		bitLenInt	inStart,
		bitLenInt	outStart,
		bitLenInt	length
	)

inlinevirtual

Inverse of multiplication modulo N by integer, (out of place)

Implements Qrack::QAlu.

◆ INC()

void Qrack::QBdt::INC	(	const bitCapInt &	toAdd,
		bitLenInt	start,
		bitLenInt	length
	)

inlinevirtual

Add integer (without sign)

Implements Qrack::QAlu.

◆ INCBCD()

void Qrack::QBdt::INCBCD	(	const bitCapInt &	toAdd,
		bitLenInt	start,
		bitLenInt	length
	)

inlinevirtual

Add classical BCD integer (without sign)

Implements Qrack::QAlu.

◆ INCC()

void Qrack::QBdt::INCC	(	const bitCapInt &	toAdd,
		bitLenInt	start,
		bitLenInt	length,
		bitLenInt	carryIndex
	)

inlinevirtual

Add integer (without sign, with carry)

Reimplemented from Qrack::QAlu.

◆ INCDECBCDC()

void Qrack::QBdt::INCDECBCDC	(	const bitCapInt &	toMod,
		bitLenInt	start,
		bitLenInt	length,
		bitLenInt	carryIndex
	)

inlinevirtual

Common driver method behind INCSC and DECSC (without overflow flag)

Implements Qrack::QAlu.

◆ INCDECC()

void Qrack::QBdt::INCDECC	(	const bitCapInt &	toMod,
		bitLenInt	start,
		bitLenInt	length,
		bitLenInt	carryIndex
	)

inlinevirtual

Common driver method behind INCC and DECC (without sign, with carry)

Implements Qrack::QAlu.

◆ INCDECSC() [1/2]

void Qrack::QBdt::INCDECSC	(	const bitCapInt &	toMod,
		bitLenInt	start,
		bitLenInt	length,
		bitLenInt	carryIndex
	)

inlinevirtual

Common driver method behind INCSC and DECSC (without overflow flag)

Implements Qrack::QAlu.

◆ INCDECSC() [2/2]

void Qrack::QBdt::INCDECSC	(	const bitCapInt &	toMod,
		bitLenInt	start,
		bitLenInt	length,
		bitLenInt	overflowIndex,
		bitLenInt	carryIndex
	)

inlinevirtual

Common driver method behind INCSC and DECSC (with overflow flag)

Implements Qrack::QAlu.

◆ INCS()

void Qrack::QBdt::INCS	(	const bitCapInt &	toAdd,
		bitLenInt	start,
		bitLenInt	length,
		bitLenInt	overflowIndex
	)

inlinevirtual

Add a classical integer to the register, with sign and without carry.

Implements Qrack::QAlu.

◆ IndexedADC()

bitCapInt Qrack::QBdt::IndexedADC	(	bitLenInt	indexStart,
		bitLenInt	indexLength,
		bitLenInt	valueStart,
		bitLenInt	valueLength,
		bitLenInt	carryIndex,
		const unsigned char *	values
	)

inlinevirtual

Add to entangled 8 bit register state with a superposed index-offset-based read from classical memory.

"inputStart" is the start index of 8 qubits that act as an index into the 256 byte "values" array. The "outputStart" bits would usually already be entangled with the "inputStart" bits via a IndexedLDA() operation. With the "inputStart" bits being a "key" and the "outputStart" bits being a value, the permutation state |key, value> is mapped to |key, value + values[key]>. This is similar to classical parallel addition of two arrays. However, when either of the registers are measured, both registers will collapse into one random VALID key-value pair, with any addition or subtraction done to the "value." See IndexedLDA() for context.

FOR BEST EFFICIENCY, the "values" array should be allocated aligned to a 64-byte boundary. (See the unit tests suite code for an example of how to align the allocation.)

While a QInterface represents an interacting set of qubit-based registers, or a virtual quantum chip, the registers need to interact in some way with (classical or quantum) RAM. IndexedLDA is a RAM access method similar to the X addressing mode of the MOS 6502 chip, if the X register can be in a state of coherent superposition when it loads from RAM. "IndexedADC" and "IndexedSBC" perform add and subtract (with carry) operations on a state usually initially prepared with IndexedLDA().

Implements Qrack::QAlu.

◆ IndexedLDA()

bitCapInt Qrack::QBdt::IndexedLDA	(	bitLenInt	indexStart,
		bitLenInt	indexLength,
		bitLenInt	valueStart,
		bitLenInt	valueLength,
		const unsigned char *	values,
		bool	resetValue = `true`
	)

inlinevirtual

Set 8 bit register bits by a superposed index-offset-based read from classical memory.

"inputStart" is the start index of 8 qubits that act as an index into the 256 byte "values" array. The "outputStart" bits are first cleared, then the separable |input, 00000000> permutation state is mapped to |input, values[input]>, with "values[input]" placed in the "outputStart" register. FOR BEST EFFICIENCY, the "values" array should be allocated aligned to a 64-byte boundary. (See the unit tests suite code for an example of how to align the allocation.)

While a QInterface represents an interacting set of qubit-based registers, or a virtual quantum chip, the registers need to interact in some way with (classical or quantum) RAM. IndexedLDA is a RAM access method similar to the X addressing mode of the MOS 6502 chip, if the X register can be in a state of coherent superposition when it loads from RAM.

The physical motivation for this addressing mode can be explained as follows: say that we have a superconducting quantum interface device (SQUID) based chip. SQUIDs have already been demonstrated passing coherently superposed electrical currents. In a sufficiently quantum-mechanically isolated qubit chip with a classical cache, with both classical RAM and registers likely cryogenically isolated from the environment, SQUIDs could (hopefully) pass coherently superposed electrical currents into the classical RAM cache to load values into a qubit register. The state loaded would be a superposition of the values of all RAM to which coherently superposed electrical currents were passed.

In qubit system similar to the MOS 6502, say we have qubit-based "accumulator" and "X index" registers, and say that we start with a superposed X index register. In (classical) X addressing mode, the X index register value acts an offset into RAM from a specified starting address. The X addressing mode of a LoaD Accumulator (LDA) instruction, by the physical mechanism described above, should load the accumulator in quantum parallel with the values of every different address of RAM pointed to in superposition by the X index register. The superposed values in the accumulator are entangled with those in the X index register, by way of whatever values the classical RAM pointed to by X held at the time of the load. (If the RAM at index "36" held an unsigned char value of "27," then the value "36" in the X index register becomes entangled with the value "27" in the accumulator, and so on in quantum parallel for all superposed values of the X index register, at once.) If the X index register or accumulator are then measured, the two registers will both always collapse into a random but valid key-value pair of X index offset and value at that classical RAM address.

Note that a "superposed store operation in classical RAM" is not possible by analagous reasoning. Classical RAM would become entangled with both the accumulator and the X register. When the state of the registers was collapsed, we would find that only one "store" operation to a single memory address had actually been carried out, consistent with the address offset in the collapsed X register and the byte value in the collapsed accumulator. It would not be possible by this model to write in quantum parallel to more than one address of classical memory at a time.

Implements Qrack::QAlu.

◆ IndexedSBC()

bitCapInt Qrack::QBdt::IndexedSBC	(	bitLenInt	indexStart,
		bitLenInt	indexLength,
		bitLenInt	valueStart,
		bitLenInt	valueLength,
		bitLenInt	carryIndex,
		const unsigned char *	values
	)

inlinevirtual

Subtract from an entangled 8 bit register state with a superposed index-offset-based read from classical memory.

"inputStart" is the start index of 8 qubits that act as an index into the 256 byte "values" array. The "outputStart" bits would usually already be entangled with the "inputStart" bits via a IndexedLDA() operation. With the "inputStart" bits being a "key" and the "outputStart" bits being a value, the permutation state |key, value> is mapped to |key, value - values[key]>. This is similar to classical parallel addition of two arrays. However, when either of the registers are measured, both registers will collapse into one random VALID key-value pair, with any addition or subtraction done to the "value." See QInterface::IndexedLDA for context.

FOR BEST EFFICIENCY, the "values" array should be allocated aligned to a 64-byte boundary. (See the unit tests suite code for an example of how to align the allocation.)

While a QInterface represents an interacting set of qubit-based registers, or a virtual quantum chip, the registers need to interact in some way with (classical or quantum) RAM. IndexedLDA is a RAM access method similar to the X addressing mode of the MOS 6502 chip, if the X register can be in a state of coherent superposition when it loads from RAM. "IndexedADC" and "IndexedSBC" perform add and subtract (with carry) operations on a state usually initially prepared with IndexedLDA().

Implements Qrack::QAlu.

◆ Init()

void Qrack::QBdt::Init ( )

protected

◆ isBinaryDecisionTree()

bool Qrack::QBdt::isBinaryDecisionTree ( )

inlinevirtual

Returns "true" if current state representation is definitely a binary decision tree, "false" if it is definitely not, or "true" if it cannot be determined.

Reimplemented from Qrack::QInterface.

◆ ISqrtSwap()

void Qrack::QBdt::ISqrtSwap	(	bitLenInt	qubit1,
		bitLenInt	qubit2
	)

inlinevirtual

Inverse square root of Swap gate.

Reimplemented from Qrack::QInterface.

◆ IsSeparable()

bool Qrack::QBdt::IsSeparable ( bitLenInt start )

Inexpensive check for whether the QBdt is separable between low and high qubit indices at the bipartite boundary of qubit index "start" (for "high" qubit indices).

◆ ISwap()

void Qrack::QBdt::ISwap	(	bitLenInt	qubit1,
		bitLenInt	qubit2
	)

inlinevirtual

Swap values of two bits in register, and apply phase factor of i if bits are different.

Reimplemented from Qrack::QInterface.

◆ M() [1/3]

bool Qrack::QBdt::M ( bitLenInt q )

inlinevirtual

Implements Qrack::QAlu.

◆ M() [2/3]

virtual bool Qrack::QInterface::M

inline

Measurement gate.

Measures the qubit at "qubit" and returns either "true" or "false." (This "gate" breaks unitarity.)

All physical evolution of a quantum state should be "unitary," except measurement. Measurement of a qubit "collapses" the quantum state into either only permutation states consistent with a |0> state for the bit, or else only permutation states consistent with a |1> state for the bit. Measurement also effectively multiplies the overall quantum state vector of the system by a random phase factor, equiprobable over all possible phase angles.

Effectively, when a bit measurement is emulated, Qrack calculates the norm of all permutation state components, to find their respective probabilities. The probabilities of all states in which the measured bit is "0" can be summed to give the probability of the bit being "0," and separately the probabilities of all states in which the measured bit is "1" can be summed to give the probability of the bit being "1." To simulate measurement, a random float between 0 and 1 is compared to the sum of the probability of all permutation states in which the bit is equal to "1". Depending on whether the random float is higher or lower than the probability, the qubit is determined to be either |0> or |1>, (up to phase). If the bit is determined to be |1>, then all permutation eigenstates in which the bit would be equal to |0> have their probability set to zero, and vice versa if the bit is determined to be |0>. Then, all remaining permutation states with nonzero probability are linearly rescaled so that the total probability of all permutation states is again "normalized" to exactly 100% or 1, (within double precision rounding error). Physically, the act of measurement should introduce an overall random phase factor on the state vector, which is emulated by generating another constantly distributed random float to select a phase angle between 0 and 2 * Pi.

Measurement breaks unitary evolution of state. All quantum gates except measurement should generally act as a unitary matrix on a permutation state vector. (Note that Boolean comparison convenience methods in Qrack such as "AND," "OR," and "XOR" employ the measurement operation in the act of first clearing output bits before filling them with the result of comparison, and these convenience methods therefore break unitary evolution of state, but in a physically realistic way. Comparable unitary operations would be performed with a combination of X and CCNOT gates, also called "Toffoli" gates, but the output bits would have to be assumed to be in a known fixed state, like all |0>, ahead of time to produce unitary logical comparison operations.)

◆ M() [3/3]

virtual bitCapInt Qrack::QInterface::M

inline

Measure bits with indices in array, and return a mask of the results.

◆ MACMtrx()

void Qrack::QBdt::MACMtrx	(	const std::vector< bitLenInt > &	controls,
		const complex *	mtrx,
		bitLenInt	target
	)

virtual

Apply an arbitrary single bit unitary transformation, with arbitrary (anti-)control bits.

Reimplemented from Qrack::QInterface.

◆ MakeQEngine()

QEnginePtr Qrack::QBdt::MakeQEngine	(	bitLenInt	qbCount,
		const bitCapInt &	perm = `ZERO_BCI`
	)

protected

◆ MAll()

bitCapInt Qrack::QBdt::MAll ( )

inlinevirtual

Measure permutation state of all coherent bits.

Reimplemented from Qrack::QInterface.

◆ MAllOptionalCollapse()

bitCapInt Qrack::QBdt::MAllOptionalCollapse ( bool isCollapsing )

protected

◆ MCInvert()

void Qrack::QBdt::MCInvert	(	const std::vector< bitLenInt > &	controls,
		const complex &	topRight,
		const complex &	bottomLeft,
		bitLenInt	target
	)

virtual

Apply a single bit transformation that reverses bit probability and might effect phase, with arbitrary control bits.

Reimplemented from Qrack::QInterface.

◆ MCMtrx()

void Qrack::QBdt::MCMtrx	(	const std::vector< bitLenInt > &	controls,
		const complex *	mtrx,
		bitLenInt	target
	)

virtual

Apply an arbitrary single bit unitary transformation, with arbitrary control bits.

Implements Qrack::QInterface.

◆ MCPhase()

void Qrack::QBdt::MCPhase	(	const std::vector< bitLenInt > &	controls,
		const complex &	topLeft,
		const complex &	bottomRight,
		bitLenInt	target
	)

virtual

Apply a single bit transformation that only effects phase, with arbitrary control bits.

Reimplemented from Qrack::QInterface.

◆ Mtrx()

void Qrack::QBdt::Mtrx	(	const complex *	mtrx,
		bitLenInt	qubit
	)

virtual

Apply an arbitrary single bit unitary transformation.

Implements Qrack::QInterface.

◆ MUL()

void Qrack::QBdt::MUL	(	const bitCapInt &	toMul,
		bitLenInt	start,
		bitLenInt	carryStart,
		bitLenInt	length
	)

inlinevirtual

Multiply by integer.

Implements Qrack::QAlu.

◆ MULModNOut()

void Qrack::QBdt::MULModNOut	(	const bitCapInt &	toMul,
		const bitCapInt &	modN,
		bitLenInt	inStart,
		bitLenInt	outStart,
		bitLenInt	length
	)

inlinevirtual

Multiplication modulo N by integer, (out of place)

Implements Qrack::QAlu.

◆ NormalizeState()

void Qrack::QBdt::NormalizeState	(	real1_f	nrm = `REAL1_DEFAULT_ARG`,
		real1_f	norm_thresh = `REAL1_DEFAULT_ARG`,
		real1_f	phaseArg = `ZERO_R1_F`
	)

inlinevirtual

Apply the normalization factor found by UpdateRunningNorm() or on the fly by a single bit gate.

(On an actual quantum computer, the state should never require manual normalization.)

Warning: PSEUDO-QUANTUM

Implements Qrack::QInterface.

◆ par_for_qbdt()

void Qrack::QBdt::par_for_qbdt	(	const bitCapInt &	end,
		bitLenInt	maxQubit,
		BdtFunc	fn,
		bool	branch = `true`
	)

protected

◆ PhaseFlipIfLess()

void Qrack::QBdt::PhaseFlipIfLess	(	const bitCapInt &	greaterPerm,
		bitLenInt	start,
		bitLenInt	length
	)

inlinevirtual

This is an expedient for an adaptive Grover's search for a function's global minimum.

Implements Qrack::QAlu.

◆ POWModNOut()

void Qrack::QBdt::POWModNOut	(	const bitCapInt &	base,
		const bitCapInt &	modN,
		bitLenInt	inStart,
		bitLenInt	outStart,
		bitLenInt	length
	)

inlinevirtual

Raise a classical base to a quantum power, modulo N, (out of place)

Implements Qrack::QAlu.

◆ Prob()

real1_f Qrack::QBdt::Prob ( bitLenInt qubit )

virtual

Direct measure of bit probability to be in |1> state.

Implements Qrack::QInterface.

◆ ProbAll()

real1_f Qrack::QBdt::ProbAll ( const bitCapInt & fullRegister )

virtual

Direct measure of full permutation probability.

Reimplemented from Qrack::QInterface.

◆ ProbParity()

real1_f Qrack::QBdt::ProbParity ( const bitCapInt & mask )

inlinevirtual

Overall probability of any odd permutation of the masked set of bits.

Implements Qrack::QParity.

◆ RemovePower()

static bitCapInt Qrack::QBdt::RemovePower	(	const bitCapInt &	perm,
		bitCapInt	power
	)

inlinestaticprotected

◆ SampleClone()

bitCapInt Qrack::QBdt::SampleClone ( const std::vector< bitCapInt > & qPowers )

inlineprotectedvirtual

Reimplemented from Qrack::QInterface.

◆ SelectBit()

static size_t Qrack::QBdt::SelectBit	(	const bitCapInt &	perm,
		bitLenInt	bit
	)

inlinestaticprotected

◆ SetAmplitude()

void Qrack::QBdt::SetAmplitude	(	const bitCapInt &	perm,
		const complex &	amp
	)

inlinevirtual

Sets the representational amplitude of a full permutation.

Warning: PSEUDO-QUANTUM

Implements Qrack::QInterface.

◆ SetDevice()

void Qrack::QBdt::SetDevice ( int64_t dID )

inlinevirtual

Set the device index, if more than one device is available.

Reimplemented from Qrack::QInterface.

◆ SetDeviceList()

void Qrack::QBdt::SetDeviceList ( std::vector< int64_t > dIDs )

inlinevirtual

Set the device index list, if more than one device is available.

Reimplemented from Qrack::QInterface.

◆ SetPermutation()

void Qrack::QBdt::SetPermutation	(	const bitCapInt &	perm,
		const complex &	phaseFac = `CMPLX_DEFAULT_ARG`
	)

virtual

Set to a specific permutation of all qubits.

Reimplemented from Qrack::QInterface.

◆ SetQuantumState() [1/2]

void Qrack::QBdt::SetQuantumState ( const complex * inputState )

inlinevirtual

Set an arbitrary pure quantum state representation.

Warning: PSEUDO-QUANTUM

Implements Qrack::QInterface.

◆ SetQuantumState() [2/2]

void Qrack::QBdt::SetQuantumState ( QInterfacePtr eng )

inline

◆ SetTraversal()

template<typename Fn >

void Qrack::QBdt::SetTraversal ( Fn setLambda )

inlineprotected

◆ SqrtSwap()

void Qrack::QBdt::SqrtSwap	(	bitLenInt	qubit1,
		bitLenInt	qubit2
	)

inlinevirtual

Square root of Swap gate.

Reimplemented from Qrack::QInterface.

◆ SumSqrDiff() [1/2]

real1_f Qrack::QBdt::SumSqrDiff ( QBdtPtr toCompare )

◆ SumSqrDiff() [2/2]

real1_f Qrack::QBdt::SumSqrDiff ( QInterfacePtr toCompare )

inlinevirtual

Calculates (1 - <\psi_e|\psi_c>) between states |\psi_c> and |\psi_e>.

Warning: PSEUDO-QUANTUM

Implements Qrack::QInterface.

◆ Swap()

void Qrack::QBdt::Swap	(	bitLenInt	qubit1,
		bitLenInt	qubit2
	)

inlinevirtual

Swap values of two bits in register.

Reimplemented from Qrack::QInterface.

◆ TryDecompose()

bool Qrack::QBdt::TryDecompose	(	bitLenInt	start,
		QInterfacePtr	dest,
		real1_f	error_tol = `TRYDECOMPOSE_EPSILON`
	)

inlinevirtual

Attempt to Decompose() a bit range.

If the result can Compose() again to the original state vector with (1 - <\psi_e|\psi_c>) <= error_tol, return "true" and complete Decompose(); otherwise, restore the original state and return "false."

Reimplemented from Qrack::QInterface.

◆ TrySeparate() [1/6]

virtual bool Qrack::QInterface::TrySeparate

inline

Single-qubit TrySeparate()

◆ TrySeparate() [2/6]

bool Qrack::QBdt::TrySeparate ( bitLenInt qubit )

inlinevirtual

Single-qubit TrySeparate()

Reimplemented from Qrack::QInterface.

◆ TrySeparate() [3/6]

virtual bool Qrack::QInterface::TrySeparate

inline

Two-qubit TrySeparate()

◆ TrySeparate() [4/6]

bool Qrack::QBdt::TrySeparate	(	bitLenInt	qubit1,
		bitLenInt	qubit2
	)

inlinevirtual

Two-qubit TrySeparate()

Reimplemented from Qrack::QInterface.

◆ TrySeparate() [5/6]

bool Qrack::QBdt::TrySeparate	(	const std::vector< bitLenInt > &	qubits,
		real1_f	error_tol
	)

inlinevirtual

Qrack::QUnit types maintain explicit separation of representations of qubits, which reduces memory usage and increases gate speed.

This method is used to manually attempt internal separation of a QUnit subsytem. We attempt a Decompose() operation, on a state which might not be separable. If the state is not separable, we abort and return false. Otherwise, we complete the operation, add the separated subsystem back in place into the QUnit "shards," and return true.

Warning: PSEUDO-QUANTUM

This should never change the logical/physical state of the QInterface, only possibly its internal representation, for simulation optimization purposes. This is not a truly quantum computational operation, but it also does not lead to nonphysical effects.

Reimplemented from Qrack::QInterface.

◆ TrySeparate() [6/6]

virtual bool Qrack::QInterface::TrySeparate

inline

Qrack::QUnit types maintain explicit separation of representations of qubits, which reduces memory usage and increases gate speed.

This method is used to manually attempt internal separation of a QUnit subsytem. We attempt a Decompose() operation, on a state which might not be separable. If the state is not separable, we abort and return false. Otherwise, we complete the operation, add the separated subsystem back in place into the QUnit "shards," and return true.

Warning: PSEUDO-QUANTUM

This should never change the logical/physical state of the QInterface, only possibly its internal representation, for simulation optimization purposes. This is not a truly quantum computational operation, but it also does not lead to nonphysical effects.

◆ UpdateRunningNorm()

void Qrack::QBdt::UpdateRunningNorm ( real1_f norm_thresh = REAL1_DEFAULT_ARG )

inlinevirtual

Force a calculation of the norm of the state vector, in order to make it unit length before the next probability or measurement operation.

(On an actual quantum computer, the state should never require manual normalization.)

Warning: PSEUDO-QUANTUM

Implements Qrack::QInterface.

◆ X() [1/3]

void Qrack::QBdt::X ( bitLenInt q )

inlinevirtual

Implements Qrack::QAlu.

◆ X() [2/3]

virtual void Qrack::QInterface::X

inline

X gate.

Applies the Pauli "X" operator to the qubit at "qubit." The Pauli "X" operator is equivalent to a logical "NOT."

◆ X() [3/3]

virtual void Qrack::QInterface::X

inline

Bitwise Pauli X (or logical "NOT") operator.

Member Data Documentation

◆ bdtMaxQPower

bitCapInt Qrack::QBdt::bdtMaxQPower

protected

◆ bdtStride

bitLenInt Qrack::QBdt::bdtStride

protected

◆ deviceIDs

std::vector<int64_t> Qrack::QBdt::deviceIDs

protected

◆ devID

int64_t Qrack::QBdt::devID

protected

◆ engines

std::vector<QInterfaceEngine> Qrack::QBdt::engines

protected

◆ root

QBdtNodeInterfacePtr Qrack::QBdt::root

protected

The documentation for this class was generated from the following files:

include/qbdt.hpp
src/qbdt/tree.cpp

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ QBdt() [1/2]

◆ QBdt() [2/2]

Member Function Documentation

◆ _par_for()

◆ Allocate() [1/3]

◆ Allocate() [2/3]

◆ Allocate() [3/3]

◆ ApplyControlledSingle()

◆ ApplySingle()

◆ BitCapIntAsStateVector()

◆ BoolAsStateVector()

◆ CDEC()

◆ CDIV()

◆ CIMULModNOut()

◆ CINC()

◆ CISqrtSwap()

◆ Clone()

◆ CMUL()

◆ CMULModNOut()

◆ Compose() [1/5]

◆ Compose() [2/5]

◆ Compose() [3/5]

◆ Compose() [4/5]

◆ Compose() [5/5]

◆ Copy() [1/4]

◆ Copy() [2/4]

◆ Copy() [3/4]

◆ Copy() [4/4]

◆ CountBranches()

◆ CPhaseFlipIfLess()

◆ CPOWModNOut()

◆ CSqrtSwap()

◆ CSwap()

◆ CUniformParityRZ()

◆ DEC()

◆ DECC()

◆ Decompose() [1/2]

◆ Decompose() [2/2]

◆ DecomposeDispose()

◆ DECS()

◆ Dispose() [1/2]

◆ Dispose() [2/2]

◆ DIV()

◆ ExecuteAsStateVector()

◆ ForceM()

◆ ForceMParity()

◆ FSim()

◆ GetAmplitude()

◆ GetDevice()

◆ GetDeviceList()

◆ GetProbs()

◆ GetQuantumState() [1/2]

◆ GetQuantumState() [2/2]

◆ GetTraversal()

◆ Hash()

◆ IISwap()

◆ IMULModNOut()

◆ INC()

◆ INCBCD()

◆ INCC()

◆ INCDECBCDC()

◆ INCDECC()

◆ INCDECSC() [1/2]

◆ INCDECSC() [2/2]

◆ INCS()

◆ IndexedADC()

◆ IndexedLDA()

◆ IndexedSBC()

◆ Init()

◆ isBinaryDecisionTree()

◆ ISqrtSwap()

◆ IsSeparable()

◆ ISwap()

◆ M() [1/3]

◆ M() [2/3]