Constructors

Functions for creating and initialising Pauli data structures. More...

Functions
PauliStrSum	createInlinePauliStrSum (const char *str)
PauliStrSum	createInlinePauliStrSum (std::string str)
PauliStrSum	createPauliStrSum (PauliStr *strings, qcomp *coeffs, qindex numTerms)
PauliStrSum	createPauliStrSum (std::vector< PauliStr > strings, std::vector< qcomp > coeffs)
PauliStrSum	createPauliStrSumFromFile (const char *fn)
PauliStrSum	createPauliStrSumFromFile (std::string fn)
PauliStrSum	createPauliStrSumFromReversedFile (const char *fn)
PauliStrSum	createPauliStrSumFromReversedFile (std::string fn)
PauliStr	getInlinePauliStr (const char *paulis, { list })
PauliStr	getPauliStr (const char *paulis, int *indices, int numPaulis)
PauliStr	getPauliStr (int *paulis, int *indices, int numPaulis)
PauliStr	getPauliStr (std::string paulis)
PauliStr	getPauliStr (std::string paulis, int *indices, int numPaulis)
PauliStr	getPauliStr (std::string paulis, std::vector< int > indices)

Detailed Description

Functions for creating and initialising Pauli data structures.

Function Documentation

createInlinePauliStrSum() [1/2]

PauliStrSum createInlinePauliStrSum

(

const char *

str

)

Note

Documentation for this function or struct is under construction!

See also

• reportPauliStrSum()
• C or C++ examples

Definition at line 428 of file paulis.cpp.

                                                                {
 
    // str must be null-terminated
    return createInlinePauliStrSum(string(str));
}

Referenced by createInlinePauliStrSum().

createInlinePauliStrSum() [2/2]

PauliStrSum createInlinePauliStrSum

(

std::string

str

)

Note

Documentation for this function or struct is under construction!

Remarks

This function is only available in C++.

See also

• createInlinePauliStrSum()
• reportPauliStrSum()
• C++ examples

createPauliStrSum() [1/2]

PauliStrSum createPauliStrSum	(	PauliStr *	strings,
		qcomp *	coeffs,
		qindex	numTerms )

Note

Documentation for this function or struct is under construction!

See also

• reportPauliStrSum()
• C or C++ examples

Definition at line 396 of file paulis.cpp.

                                                                                            {
 
    // note we do not require nor impose the strings to be unique
    validate_newPauliStrSumParams(numTerms, __func__);
 
    // prepare output PauliStrSum (avoiding C++20 designated initialiser)
    PauliStrSum out;
    out.numTerms = numTerms;
    out.strings = cpu_allocPauliStrings(numTerms);                // nullptr if failed
    out.coeffs  = cpu_allocArray(numTerms);                       // nullptr if failed
    out.isApproxHermitian = util_allocEpsilonSensitiveHeapFlag(); // nullptr if failed
 
    // if either alloc failed, clear both before validation to avoid leak
    freeAllMemoryIfAnyAllocsFailed(out);
    validate_newPauliStrSumAllocs(out, numTerms*sizeof(PauliStr), numTerms*sizeof(qcomp), __func__);
 
    // otherwise copy given data into new heap structure, and set initial flags
    cpu_copyPauliStrSum(out, strings, coeffs);
    util_setFlagToUnknown(out.isApproxHermitian);
 
    return out;
}

createPauliStrSum() [2/2]

PauliStrSum createPauliStrSum	(	std::vector< PauliStr >	strings,
		std::vector< qcomp >	coeffs )

Note

Documentation for this function or struct is under construction!

Remarks

This function is only available in C++.

See also

• createPauliStrSum()
• reportPauliStrSum()
• C++ examples

createPauliStrSumFromFile() [1/2]

PauliStrSum createPauliStrSumFromFile

(

const char *

fn

)

Note

Documentation for this function or struct is under construction!

See also

• reportPauliStrSum()
• C or C++ examples

Definition at line 441 of file paulis.cpp.

                                                                 {
 
    // fn must be null-terminated
    return createPauliStrSumFromFile(string(fn));
}

Referenced by createPauliStrSumFromFile().

createPauliStrSumFromFile() [2/2]

PauliStrSum createPauliStrSumFromFile

(

std::string

fn

)

Note

Documentation for this function or struct is under construction!

Remarks

This function is only available in C++.

See also

• createPauliStrSumFromFile()
• reportPauliStrSum()
• C++ examples

createPauliStrSumFromReversedFile() [1/2]

PauliStrSum createPauliStrSumFromReversedFile

(

const char *

fn

)

Note

Documentation for this function or struct is under construction!

See also

• reportPauliStrSum()
• C or C++ examples

Definition at line 458 of file paulis.cpp.

                                                                         {
 
    // fn must be null-terminated
    return createPauliStrSumFromReversedFile(string(fn));
}

Referenced by createPauliStrSumFromReversedFile(), and TEST_CASE().

createPauliStrSumFromReversedFile() [2/2]

PauliStrSum createPauliStrSumFromReversedFile

(

std::string

fn

)

Note

Documentation for this function or struct is under construction!

Remarks

This function is only available in C++.

See also

• createPauliStrSumFromReversedFile()
• reportPauliStrSum()
• C++ examples

getInlinePauliStr()

PauliStr getInlinePauliStr	(	const char *	paulis,
		{ list }	)

Note

Documentation for this function or struct is under construction!

This entity is actually a macro.

See also

• reportPauliStr()
• C and C++examples

getPauliStr() [1/5]

PauliStr getPauliStr	(	const char *	paulis,
		int *	indices,
		int	numPaulis )

Note

Documentation for this function or struct is under construction!

See also

• reportPauliStr()
• C or C++ examples

Definition at line 306 of file paulis.cpp.

                                                                                 {
    validate_newPauliStrParams(paulis, indices, numPaulis, MAX_NUM_PAULIS_PER_STR, __func__);
 
    // begin masks at all-identity 'I' = 0
    PAULI_MASK_TYPE lowPaulis = 0;
    PAULI_MASK_TYPE highPaulis = 0;
 
    // change targeted indices to the given Paulis
    for (int i=0; i<numPaulis; i++) {
 
        // cast single Pauli to full precision mask to enable below shifts
        auto pauli = (PAULI_MASK_TYPE) parser_getPauliIntFromChar(paulis[i]);
 
        // add the Pauli to either the lower or upper pauli masks
        if (indices[i] < MAX_NUM_PAULIS_PER_MASK)
            lowPaulis  |= pauli << (2*indices[i]);
        else
            highPaulis |= pauli << (2*(indices[i] - MAX_NUM_PAULIS_PER_MASK));
    }
 
    // return a new stack PauliStr instance (avoiding C++20 initialiser)
    PauliStr out;
    out.lowPaulis = lowPaulis;
    out.highPaulis = highPaulis;
    return out;
}

Referenced by applyMultiStateControlledMultiQubitNot(), applyMultiStateControlledPauliX(), applyMultiStateControlledPauliY(), applyMultiStateControlledRotateX(), applyMultiStateControlledRotateY(), applyMultiStateControlledRotateZ(), getPauliStr(), multiplyMultiQubitNot(), and TEST_CASE().

getPauliStr() [2/5]

PauliStr getPauliStr	(	int *	paulis,
		int *	indices,
		int	numPaulis )

Note

Documentation for this function or struct is under construction!

See also

• reportPauliStr()
• C or C++ examples

Definition at line 334 of file paulis.cpp.

                                                               {
    validate_newPauliStrParams(paulis, indices, numPaulis, MAX_NUM_PAULIS_PER_STR, __func__);
 
    // validation ensures never causes stack overflow
    char pauliChars[MAX_NUM_PAULIS_PER_STR + 1]; // +1 for null-terminal
 
    // make a char array from the pauli codes, using an arbitrary 
    // choice of the Pauli characters accepted by the API (like IXYZ)
    for (int i=0; i<numPaulis; i++)
        pauliChars[i] = "IXYZ"[paulis[i]];
 
    // including the trailing null char, used to infer string end/length
    pauliChars[numPaulis] = '\0';
 
    return getPauliStr(pauliChars, indices, numPaulis);
}

getPauliStr() [3/5]

PauliStr getPauliStr

(

std::string

paulis

)

Note

Documentation for this function or struct is under construction!

Remarks

This function is only available in C++.

See also

• reportPauliStr()
• C++ examples

getPauliStr() [4/5]

PauliStr getPauliStr	(	std::string	paulis,
		int *	indices,
		int	numPaulis )

Note

Documentation for this function or struct is under construction!

Remarks

This function is only available in C++.

See also

• getPauliStr()
• reportPauliStr()
• C++ examples

getPauliStr() [5/5]

PauliStr getPauliStr	(	std::string	paulis,
		std::vector< int >	indices )

Note

Documentation for this function or struct is under construction!

Remarks

This function is only available in C++.

See also

• reportPauliStr()
• C++ examples