A "Qrack::QInterface" is an abstract interface exposing qubit permutation state vector with methods to operate on it as by gates and register-like instructions. More...

#include <qinterface.hpp>

Inheritance diagram for Qrack::QInterface:

[legend]

Collaboration diagram for Qrack::QInterface:

[legend]

Public Member Functions
	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 bool	GetIsArbitraryGlobalPhase ()

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

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

virtual void	GetQuantumState (complex *outputState)=0
	Get the pure quantum state representation. More...

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

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

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

virtual void	SetPermutation (const bitCapInt &perm, const complex &phaseFac=CMPLX_DEFAULT_ARG)
	Set to a specific permutation of all 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	Compose (QInterfacePtr toCopy, bitLenInt start)
	`Compose()` a `QInterface` peer, inserting its qubit into index order at `start` index. More...

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

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

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

virtual void	Dispose (bitLenInt start, bitLenInt length, const bitCapInt &disposedPerm)=0
	Dispose a a contiguous set of qubits that are already in a permutation eigenstate. 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 void	Mtrx (const complex *mtrx, bitLenInt qubit)=0
	Apply an arbitrary single bit unitary transformation. More...

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

virtual 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...

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	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...

virtual 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...

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	CSwap (const std::vector< bitLenInt > &controls, bitLenInt qubit1, bitLenInt qubit2)
	Apply a swap with arbitrary control bits. More...

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

virtual void	CSqrtSwap (const std::vector< bitLenInt > &controls, bitLenInt qubit1, bitLenInt qubit2)
	Apply a square root of swap with arbitrary 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	CISqrtSwap (const std::vector< bitLenInt > &controls, bitLenInt qubit1, bitLenInt qubit2)
	Apply an inverse square root of swap with arbitrary 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 bool	M (bitLenInt qubit)
	Measurement gate. More...

virtual bool	ForceM (bitLenInt qubit, bool result, bool doForce=true, bool doApply=true)=0
	Act as if is a measurement was applied, except force the (usually random) result. 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	X (bitLenInt qubit)
	X 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, real1 const *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, real1 const *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	INC (const bitCapInt &toAdd, bitLenInt start, bitLenInt length)
	Add integer (without sign) More...

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

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

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

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

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

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

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

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

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

virtual 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...

virtual 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...

virtual 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...

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	MAll ()
	Measure permutation state of all coherent bits. 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	Swap (bitLenInt qubit1, bitLenInt qubit2)
	Swap values of two bits in register. More...

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

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

virtual void	SqrtSwap (bitLenInt qubit1, bitLenInt qubit2)
	Square root of Swap gate. More...

virtual void	ISqrtSwap (bitLenInt qubit1, bitLenInt qubit2)
	Inverse square root of Swap gate. More...

virtual void	FSim (real1_f theta, real1_f phi, bitLenInt qubit1, bitLenInt qubit2)=0
	The 2-qubit "fSim" gate, (useful in the simulation of particles with fermionic statistics) More...

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

virtual real1_f	Prob (bitLenInt qubit)=0
	Direct measure of bit probability to be in \|1> state. 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 real1_f	ProbAll (const bitCapInt &fullRegister)
	Direct measure of full permutation probability. 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 real1_f	SumSqrDiff (QInterfacePtr toCompare)=0
	Calculates (1 - <\psi_e\|\psi_c>) between states \|\psi_c> and \|\psi_e>. More...

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

virtual void	UpdateRunningNorm (real1_f norm_thresh=REAL1_DEFAULT_ARG)=0
	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...

virtual void	NormalizeState (real1_f nrm=REAL1_DEFAULT_ARG, real1_f norm_thresh=REAL1_DEFAULT_ARG, real1_f phaseArg=ZERO_R1_F)=0
	Apply the normalization factor found by UpdateRunningNorm() or on the fly by a single bit gate. 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	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...

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 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 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 QInterfacePtr	Clone ()=0
	Clone this QInterface. More...

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

virtual int64_t	GetDevice ()
	Get the device index. 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...

virtual bitLenInt	DepolarizingChannelStrong1Qb (bitLenInt qubit, real1_f lambda)
	Simulate a local qubit depolarizing noise channel, under a "strong simulation condition." "Strong" condition supports measurement sampling and direct queries of state, but the expression of state is in terms of one retained ancillary qubit per applied noise channel. 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
complex	GetNonunitaryPhase ()

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

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

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 real1_f	normHelper (const complex &c)

static real1_f	clampProb (real1_f toClamp)

Protected Attributes
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

Detailed Description

A "Qrack::QInterface" is an abstract interface exposing qubit permutation state vector with methods to operate on it as by gates and register-like instructions.

See README.md for an overview of the algorithms Qrack employs.

Constructor & Destructor Documentation

◆ QInterface() [1/2]

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() [2/2]

Qrack::QInterface::QInterface ( )

inline

Default constructor, primarily for protected internal use.

◆ ~QInterface()

virtual Qrack::QInterface::~QInterface ( )

inlinevirtual

Member Function Documentation

◆ Allocate() [1/2]

virtual bitLenInt Qrack::QInterface::Allocate ( bitLenInt length )

inlinevirtual

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

◆ Allocate() [2/2]

virtual bitLenInt Qrack::QInterface::Allocate	(	bitLenInt	start,
		bitLenInt	length
	)

pure virtual

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

Implemented in Qrack::QUnitClifford, Qrack::QUnit, Qrack::QTensorNetwork, Qrack::QStabilizerHybrid, Qrack::QStabilizer, Qrack::QPager, Qrack::QInterfaceNoisy, Qrack::QHybrid, Qrack::QEngineOCL, Qrack::QEngineCUDA, Qrack::QEngineCPU, Qrack::QBdtHybrid, and Qrack::QBdt.

◆ clampProb()

static real1_f Qrack::QInterface::clampProb ( real1_f toClamp )

inlinestaticprotected

◆ Compose() [1/3]

virtual bitLenInt Qrack::QInterface::Compose ( QInterfacePtr toCopy )

inlinevirtual

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.

Reimplemented in Qrack::QUnitClifford, Qrack::QUnit, Qrack::QStabilizerHybrid, Qrack::QStabilizer, Qrack::QPager, Qrack::QInterfaceNoisy, Qrack::QHybrid, Qrack::QEngineOCL, Qrack::QEngineCUDA, Qrack::QEngineCPU, and Qrack::QBdtHybrid.

◆ Compose() [2/3]

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

virtual

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

Reimplemented in Qrack::QUnitClifford, Qrack::QUnit, Qrack::QTensorNetwork, Qrack::QStabilizerHybrid, Qrack::QStabilizer, Qrack::QInterfaceNoisy, Qrack::QHybrid, Qrack::QEngineOCL, Qrack::QEngineCUDA, Qrack::QEngineCPU, Qrack::QBdtHybrid, and Qrack::QBdt.

◆ Compose() [3/3]

std::map< QInterfacePtr, bitLenInt > Qrack::QInterface::Compose ( std::vector< QInterfacePtr > toCopy )

virtual

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

Reimplemented in Qrack::QEngineCPU.

◆ ComposeNoClone()

virtual bitLenInt Qrack::QInterface::ComposeNoClone ( QInterfacePtr toCopy )

inlinevirtual

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.

Reimplemented in Qrack::QStabilizerHybrid, Qrack::QPager, Qrack::QInterfaceNoisy, Qrack::QHybrid, and Qrack::QBdtHybrid.

◆ Decompose() [1/2]

virtual QInterfacePtr Qrack::QInterface::Decompose	(	bitLenInt	start,
		bitLenInt	length
	)

pure virtual

Schmidt decompose a length of qubits.

Implemented in Qrack::QUnitClifford, Qrack::QUnit, Qrack::QTensorNetwork, Qrack::QStabilizerHybrid, Qrack::QStabilizer, Qrack::QPager, Qrack::QInterfaceNoisy, Qrack::QEngine, Qrack::QBdtHybrid, and Qrack::QBdt.

◆ Decompose() [2/2]

virtual void Qrack::QInterface::Decompose	(	bitLenInt	start,
		QInterfacePtr	dest
	)

pure virtual

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.

Implemented in Qrack::QUnitClifford, Qrack::QUnit, Qrack::QTensorNetwork, Qrack::QStabilizerHybrid, Qrack::QStabilizer, Qrack::QPager, Qrack::QInterfaceNoisy, Qrack::QHybrid, Qrack::QEngineOCL, Qrack::QEngineCUDA, Qrack::QEngineCPU, Qrack::QBdtHybrid, and Qrack::QBdt.

◆ Dispose() [1/2]

virtual void Qrack::QInterface::Dispose	(	bitLenInt	start,
		bitLenInt	length
	)

pure virtual

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.

Implemented in Qrack::QUnitClifford, Qrack::QUnit, Qrack::QTensorNetwork, Qrack::QStabilizerHybrid, Qrack::QStabilizer, Qrack::QPager, Qrack::QInterfaceNoisy, Qrack::QHybrid, Qrack::QEngineOCL, Qrack::QEngineCUDA, Qrack::QEngineCPU, Qrack::QBdtHybrid, and Qrack::QBdt.

◆ Dispose() [2/2]

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

pure virtual

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

Implemented in Qrack::QStabilizer, Qrack::QUnitClifford, Qrack::QUnit, Qrack::QTensorNetwork, Qrack::QStabilizerHybrid, Qrack::QPager, Qrack::QInterfaceNoisy, Qrack::QHybrid, Qrack::QEngineOCL, Qrack::QEngineCUDA, Qrack::QEngineCPU, Qrack::QBdtHybrid, and Qrack::QBdt.

◆ ExpVarBitsAll()

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

inlineprotectedvirtual

Reimplemented in Qrack::QPager.

◆ ExpVarUnitaryAll() [1/2]

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

protectedvirtual

◆ ExpVarUnitaryAll() [2/2]

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

protectedvirtual

◆ GetAmplitude()

virtual complex Qrack::QInterface::GetAmplitude ( const bitCapInt & perm )

pure virtual

Get the representational amplitude of a full permutation.

Warning: PSEUDO-QUANTUM

Implemented in Qrack::QUnitClifford, Qrack::QUnit, Qrack::QTensorNetwork, Qrack::QStabilizerHybrid, Qrack::QStabilizer, Qrack::QPager, Qrack::QInterfaceNoisy, Qrack::QHybrid, Qrack::QEngineOCL, Qrack::QEngineCUDA, Qrack::QEngineCPU, Qrack::QBdtHybrid, and Qrack::QBdt.

◆ GetIsArbitraryGlobalPhase()

virtual bool Qrack::QInterface::GetIsArbitraryGlobalPhase ( )

inlinevirtual

◆ GetMaxQPower()

virtual bitCapInt Qrack::QInterface::GetMaxQPower ( )

inlinevirtual

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

Reimplemented in Qrack::QUnitClifford, and Qrack::QStabilizer.

◆ GetNonunitaryPhase()

complex Qrack::QInterface::GetNonunitaryPhase ( )

inlineprotected

◆ GetProbs()

virtual void Qrack::QInterface::GetProbs ( real1 * outputProbs )

pure virtual

Get the pure quantum state representation.

Warning: PSEUDO-QUANTUM

Implemented in Qrack::QUnitClifford, Qrack::QUnit, Qrack::QTensorNetwork, Qrack::QStabilizerHybrid, Qrack::QStabilizer, Qrack::QPager, Qrack::QInterfaceNoisy, Qrack::QHybrid, Qrack::QEngineOCL, Qrack::QEngineCUDA, Qrack::QEngineCPU, Qrack::QBdtHybrid, and Qrack::QBdt.

◆ GetQuantumState()

virtual void Qrack::QInterface::GetQuantumState ( complex * outputState )

pure virtual

Get the pure quantum state representation.

Warning: PSEUDO-QUANTUM

Implemented in Qrack::QUnitClifford, Qrack::QStabilizer, Qrack::QTensorNetwork, Qrack::QBdt, Qrack::QUnit, Qrack::QStabilizerHybrid, Qrack::QPager, Qrack::QInterfaceNoisy, Qrack::QHybrid, Qrack::QEngineOCL, Qrack::QEngineCUDA, Qrack::QEngineCPU, and Qrack::QBdtHybrid.

◆ GetQubitCount()

virtual bitLenInt Qrack::QInterface::GetQubitCount ( )

inlinevirtual

Get the count of bits in this register.

Reimplemented in Qrack::QUnitClifford, and Qrack::QStabilizer.

◆ MACWrapper()

template<typename Fn >

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

inlineprotected

◆ normHelper()

static real1_f Qrack::QInterface::normHelper ( const complex & c )

inlinestaticprotected

◆ Rand()

real1_f Qrack::QInterface::Rand ( )

inline

Generate a random real number between 0 and 1.

◆ SampleClone()

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

inlineprotectedvirtual

Reimplemented in Qrack::QBdt.

◆ SetAmplitude()

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

pure virtual

Sets the representational amplitude of a full permutation.

Warning: PSEUDO-QUANTUM

Implemented in Qrack::QUnitClifford, Qrack::QUnit, Qrack::QTensorNetwork, Qrack::QStabilizerHybrid, Qrack::QStabilizer, Qrack::QPager, Qrack::QInterfaceNoisy, Qrack::QHybrid, Qrack::QEngineOCL, Qrack::QEngineCUDA, Qrack::QEngineCPU, Qrack::QBdtHybrid, and Qrack::QBdt.

◆ SetConcurrency()

virtual void Qrack::QInterface::SetConcurrency ( uint32_t threadsPerEngine )

inlinevirtual

Set the number of threads in parallel for loops, per component QEngine.

Reimplemented in Qrack::QUnit, Qrack::QPager, Qrack::QStabilizerHybrid, Qrack::QInterfaceNoisy, Qrack::QHybrid, and Qrack::QBdtHybrid.

◆ SetPermutation()

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

virtual

Set to a specific permutation of all qubits.

Reimplemented in Qrack::QUnitClifford, Qrack::QUnit, Qrack::QStabilizerHybrid, Qrack::QStabilizer, Qrack::QPager, Qrack::QInterfaceNoisy, Qrack::QHybrid, Qrack::QEngineOCL, Qrack::QEngineCUDA, Qrack::QEngineCPU, Qrack::QBdtHybrid, Qrack::QTensorNetwork, and Qrack::QBdt.

◆ SetQuantumState()

virtual void Qrack::QInterface::SetQuantumState ( const complex * inputState )

pure virtual

Set an arbitrary pure quantum state representation.

Warning: PSEUDO-QUANTUM

Implemented in Qrack::QTensorNetwork, Qrack::QBdt, Qrack::QUnitClifford, Qrack::QUnit, Qrack::QStabilizerHybrid, Qrack::QStabilizer, Qrack::QPager, Qrack::QInterfaceNoisy, Qrack::QHybrid, Qrack::QEngineOCL, Qrack::QEngineCUDA, Qrack::QEngineCPU, and Qrack::QBdtHybrid.

◆ SetQubitCount()

virtual void Qrack::QInterface::SetQubitCount ( bitLenInt qb )

inlinevirtual

Reimplemented in Qrack::QPager, Qrack::QInterfaceNoisy, Qrack::QHybrid, and Qrack::QEngine.

◆ SetRandomSeed()

void Qrack::QInterface::SetRandomSeed ( uint32_t seed )

inline

Member Data Documentation

◆ amplitudeFloor

real1 Qrack::QInterface::amplitudeFloor

protected

◆ doNormalize

bool Qrack::QInterface::doNormalize

protected

◆ hardware_rand_generator

std::shared_ptr<RdRandom> Qrack::QInterface::hardware_rand_generator

protected

◆ maxQPower

bitCapInt Qrack::QInterface::maxQPower

protected

◆ qubitCount

bitLenInt Qrack::QInterface::qubitCount

protected

◆ rand_distribution

std::uniform_real_distribution<real1_s> Qrack::QInterface::rand_distribution

protected

◆ rand_generator

qrack_rand_gen_ptr Qrack::QInterface::rand_generator

protected

◆ randGlobalPhase

bool Qrack::QInterface::randGlobalPhase

protected

◆ randomSeed

uint32_t Qrack::QInterface::randomSeed

protected

◆ useRDRAND

bool Qrack::QInterface::useRDRAND

protected

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

include/qinterface.hpp
src/qinterface/arithmetic.cpp
src/qinterface/gates.cpp
src/qinterface/logic.cpp
src/qinterface/qinterface.cpp
src/qinterface/rotational.cpp

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ QInterface() [1/2]

◆ QInterface() [2/2]

◆ ~QInterface()

Member Function Documentation

◆ Allocate() [1/2]

◆ Allocate() [2/2]

◆ clampProb()

◆ Compose() [1/3]

◆ Compose() [2/3]

◆ Compose() [3/3]

◆ ComposeNoClone()

◆ Decompose() [1/2]

◆ Decompose() [2/2]

◆ Dispose() [1/2]

◆ Dispose() [2/2]

◆ ExpVarBitsAll()

◆ ExpVarUnitaryAll() [1/2]

◆ ExpVarUnitaryAll() [2/2]

◆ GetAmplitude()

◆ GetIsArbitraryGlobalPhase()

◆ GetMaxQPower()

◆ GetNonunitaryPhase()

◆ GetProbs()

◆ GetQuantumState()

◆ GetQubitCount()

◆ MACWrapper()

◆ normHelper()

◆ Rand()

◆ SampleClone()

◆ SetAmplitude()

◆ SetConcurrency()

◆ SetPermutation()

◆ SetQuantumState()

◆ SetQubitCount()

◆ SetRandomSeed()

Member Data Documentation

◆ amplitudeFloor

◆ doNormalize

◆ hardware_rand_generator

◆ maxQPower

◆ qubitCount

◆ rand_distribution

◆ rand_generator

◆ randGlobalPhase

◆ randomSeed

◆ useRDRAND