Constructors

Functions for creating channel data structures. More...

Functions
KrausMap	createInlineKrausMap (int numQb, int numOps, {{{ matrices }}})
KrausMap	createInlineKrausMap (int numQubits, int numOperators, std::vector< std::vector< std::vector< qcomp > > > matrices)
SuperOp	createInlineSuperOp (int numQb, {{ matrix }})
SuperOp	createInlineSuperOp (int numQubits, std::vector< std::vector< qcomp > > matrix)
KrausMap	createKrausMap (int numQubits, int numOperators)
SuperOp	createSuperOp (int numQubits)

Detailed Description

Functions for creating channel data structures.

Function Documentation

createInlineKrausMap() [1/2]

KrausMap createInlineKrausMap	(	int	numQb,
		int	numOps,
		{{{ matrices }}}	)

Note

Documentation for this function or struct is under construction!

This entity is actually a macro.

See also

• createKrausMap()
• setKrausMap()
• syncKrausMap()
• C examples

createInlineKrausMap() [2/2]

KrausMap createInlineKrausMap	(	int	numQubits,
		int	numOperators,
		std::vector< std::vector< std::vector< qcomp > > >	matrices )

Note

Documentation for this function or struct is under construction!

Remarks

This function is only available in C++.

See also

• createKrausMap()
• setKrausMap()
• syncKrausMap()
• C++ examples

Referenced by TEST_CASE().

createInlineSuperOp() [1/2]

SuperOp createInlineSuperOp	(	int	numQb,
		{{ matrix }}	)

Note

Documentation for this function or struct is under construction!

This entity is actually a macro.

See also

• createSuperOp()
• setSuperOp()
• syncSuperOp()
• C examples

createInlineSuperOp() [2/2]

SuperOp createInlineSuperOp	(	int	numQubits,
		std::vector< std::vector< qcomp > >	matrix )

Note

Documentation for this function or struct is under construction!

Remarks

This function is only available in C++.

See also

• createSuperOp()
• setSuperOp()
• syncSuperOp()
• C++ examples

createKrausMap()

KrausMap createKrausMap	(	int	numQubits,
		int	numOperators )

Note

Documentation for this function or struct is under construction!

See also

• createInlineKrausMap
• createSuperOp()
• setKrausMap()
• setInlineKrausMap
• C or C++ examples

Definition at line 176 of file channels.cpp.

                                                                    {
    validate_envIsInit(__func__);
    validate_newKrausMapParams(numQubits, numOperators, __func__);
 
    // validation ensures this never overflows
    qindex numRows = powerOf2(numQubits);
 
    // attempt to allocate output KrausMap fields (avoiding C++20 designated initialiser)
    KrausMap out;
    out.numQubits = numQubits,
    out.numMatrices = numOperators,
    out.numRows = numRows,
    out.matrices = cpu_allocMatrixList(numRows, numOperators); // is or contains nullptr if failed
    out.superop = allocSuperOp(numQubits); // heap fields are or contain nullptr if failed
    out.isApproxCPTP = util_allocEpsilonSensitiveHeapFlag(); // nullptr if failed
 
    // free memory before throwing validation error to avoid memory leaks
    freeAllMemoryIfAnyAllocsFailed(out); // sets out.matrices=nullptr if failed
    validate_newKrausMapAllocs(out, __func__);
 
    // mark CPTP as unknown; it will be lazily evaluated whene a function asserts CPTP-ness
    util_setFlagToUnknown(out.isApproxCPTP);
 
    return out;
}

Referenced by TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), and TEST_CASE().

createSuperOp()

SuperOp createSuperOp

(

int

numQubits

)

Note

Documentation for this function or struct is under construction!

See also

• createInlineSuperOp()
• createKrausMap()
• setSuperOp()
• setInlineSuperOp()
• C or C++ examples

Definition at line 162 of file channels.cpp.

                                                {
    validate_envIsInit(__func__);
    validate_newSuperOpParams(numQubits, __func__);
 
    SuperOp out = allocSuperOp(numQubits); // fields may be or contain nullptr if failed
 
    // free all memory before we throw validation errors to avoid leaks
    freeAllMemoryIfAnyAllocsFailed(out);
    validate_newSuperOpAllocs(out, __func__);
 
    return out;
}

Referenced by TEST_CASE(), TEST_CASE(), TEST_CASE(), and TEST_CASE().