Setters

Functions for overwriting the elements of matrices. More...

Functions
void	setCompMatr (CompMatr matr, qcomp **vals)
void	setCompMatr (CompMatr matr, qcomp arr[matr.numRows][matr.numRows])
void	setCompMatr (CompMatr out, std::vector< std::vector< qcomp > > in)
void	setDiagMatr (DiagMatr out, qcomp *in)
void	setDiagMatr (DiagMatr out, std::vector< qcomp > in)
void	setDiagMatrFromMultiDimLists (DiagMatr out, void *lists, int *numQubitsPerDim, int numDims)
void	setDiagMatrFromMultiVarFunc (DiagMatr out, qcomp(*func)(qindex *), int *numQubitsPerVar, int numVars, int areSigned)
void	setFullStateDiagMatr (FullStateDiagMatr out, qindex startInd, qcomp *in, qindex numElems)
void	setFullStateDiagMatr (FullStateDiagMatr out, qindex startInd, std::vector< qcomp > in)
void	setFullStateDiagMatrFromMultiDimLists (FullStateDiagMatr out, void *lists, int *numQubitsPerDim, int numDims)
void	setFullStateDiagMatrFromMultiVarFunc (FullStateDiagMatr out, qcomp(*func)(qindex *), int *numQubitsPerVar, int numVars, int areSigned)
void	setFullStateDiagMatrFromPauliStrSum (FullStateDiagMatr out, PauliStrSum in)
void	setInlineCompMatr (CompMatr matr, int numQb, std::vector< std::vector< qcomp > > in)
void	setInlineCompMatr (CompMatr matr, int numQb, {{ matrix }})
void	setInlineDiagMatr (DiagMatr matr, int numQb, std::vector< qcomp > in)
void	setInlineDiagMatr (DiagMatr matr, int numQb, { list })
void	setInlineFullStateDiagMatr (FullStateDiagMatr matr, qindex startInd, qindex numElems, std::vector< qcomp > in)
void	setInlineFullStateDiagMatr (FullStateDiagMatr matr, qindex startInd, qindex numElems, { list })

Detailed Description

Functions for overwriting the elements of matrices.

Function Documentation

setCompMatr() [1/3]

void setCompMatr	(	CompMatr	matr,
		qcomp **	vals )

Note

Documentation for this function or struct is under construction!

See also

• setInlineCompMatr()
• reportCompMatr()
• C and C++ examples

Definition at line 421 of file matrices.cpp.

                                                      {
    validate_matrixFields(out, __func__);
    validate_matrixNewElemsPtrNotNull(in, out.numRows, __func__);
 
    setAndSyncDenseMatrElems(out, in);
}

Referenced by TEST_CASE(), and TEST_CASE().

setCompMatr() [2/3]

void setCompMatr	(	CompMatr	matr,
		qcomp	arr[matr.numRows][matr.numRows] )

Note

Documentation for this function or struct is under construction!

This entity is actually a macro.

Remarks

This function is only available in C.

See also

• setInlineCompMatr()
• reportCompMatr()
• C examples

setCompMatr() [3/3]

void setCompMatr	(	CompMatr	out,
		std::vector< std::vector< qcomp > >	in )

Note

Documentation for this function or struct is under construction!

Remarks

This function is only available in C++.

See also

• setInlineCompMatr()
• reportCompMatr()
• C++ examples

setDiagMatr() [1/2]

void setDiagMatr	(	DiagMatr	out,
		qcomp *	in )

Note

Documentation for this function or struct is under construction!

See also

• setInlineDiagMatr()
• reportDiagMatr()
• C and C++ examples

Definition at line 429 of file matrices.cpp.

                                                     {
    validate_matrixFields(out, __func__);
    validate_matrixNewElemsPtrNotNull(in, __func__);
 
    // overwrite CPU memory
    cpu_copyArray(out.cpuElems, in, out.numElems);
 
    // overwrite GPU elements; validation gauranteed to pass
    syncDiagMatr(out);
}

setDiagMatr() [2/2]

void setDiagMatr	(	DiagMatr	out,
		std::vector< qcomp >	in )

Note

Documentation for this function or struct is under construction!

Remarks

This function is only available in C++.

See also

• setInlineDiagMatr()
• reportDiagMatr()
• C++ examples

setDiagMatrFromMultiDimLists()

void setDiagMatrFromMultiDimLists	(	DiagMatr	out,
		void *	lists,
		int *	numQubitsPerDim,
		int	numDims )

Note

Documentation for this function or struct is under construction!

Warning

This function has not yet been unit tested and may contain bugs. Please use with caution!

Definition at line 702 of file matrices.cpp.

                                                                                                           {
    validate_matrixFields(out, __func__);
    validate_multiVarFuncQubits(out.numQubits, numQubitsPerDim, numDims, __func__);
 
    vector<qindex> listInds(numDims);
 
    // set each element of the diagonal in-turn, which is embarrassingly parallel, 
    // although we do not parallelise - the DiagMatr is intendedly small
    for (qindex elemInd=0; elemInd<out.numElems; elemInd++) {
 
        // nested list indices = unsigned integer values of variables
        fast_getSubQuregValues(elemInd, numQubitsPerDim, numDims, false, listInds.data());
 
        // update only the CPU elems
        out.cpuElems[elemInd] = util_getElemFromNestedPtrs(lists, listInds.data(), numDims);
    }
 
    // overwrite all GPU elems
    syncDiagMatr(out);
}

setDiagMatrFromMultiVarFunc()

void setDiagMatrFromMultiVarFunc	(	DiagMatr	out,
		qcomp(*	func )(qindex *),
		int *	numQubitsPerVar,
		int	numVars,
		int	areSigned )

Note

Documentation for this function or struct is under construction!

Warning

This function has not yet been unit tested and may contain bugs. Please use with caution!

Definition at line 668 of file matrices.cpp.

                                                                                                                                            {
    validate_matrixFields(out, __func__);
    validate_multiVarFuncQubits(out.numQubits, numQubitsPerVar, numVars, __func__);
    validate_funcVarSignedFlag(areSigned, __func__);
 
    vector<qindex> varValues(numVars);
 
    // set each element of the diagonal in-turn; user's callback might not be thread-safe
    for (qindex elemInd=0; elemInd<out.numElems; elemInd++) {
        fast_getSubQuregValues(elemInd, numQubitsPerVar, numVars, areSigned, varValues.data());
 
        // call user function, and update only the CPU elems
        out.cpuElems[elemInd] = callbackFunc(varValues.data());
    }
 
    // overwrite all GPU elems
    syncDiagMatr(out);
}

setFullStateDiagMatr() [1/2]

void setFullStateDiagMatr	(	FullStateDiagMatr	out,
		qindex	startInd,
		qcomp *	in,
		qindex	numElems )

Note

Documentation for this function or struct is under construction!

Warning

This function has not yet been unit tested and may contain bugs. Please use with caution!

See also

• setInlineFullStateDiagMatr()
• reportFullStateDiagMatr()
• C and C++ examples

Definition at line 441 of file matrices.cpp.

                                                                                                         {
    validate_matrixFields(out, __func__);
    validate_fullStateDiagMatrNewElems(out, startInd, numElems, __func__);
    validate_matrixNewElemsPtrNotNull(in, __func__);
 
    // overwrites both the CPU and GPU memory (if it exists), maintaining consistency.
    // note that cpu_copyArray() isn't called directly here like setDiagMatr() above
    // because we must handle when 'out' is and isn't distributed
    localiser_fullstatediagmatr_setElems(out, startInd, in, numElems);
 
    // even though we have not necessarily overwritten every element, we must mark
    // the matrix as synced so that it can be subsequently used without error
    markMatrixAsSynced(out);
}

setFullStateDiagMatr() [2/2]

void setFullStateDiagMatr	(	FullStateDiagMatr	out,
		qindex	startInd,
		std::vector< qcomp >	in )

Note

Documentation for this function or struct is under construction!

Warning

This function has not yet been unit tested and may contain bugs. Please use with caution!

Remarks

This function is only available in C++.

See also

• setInlineFullStateDiagMatr()
• reportFullStateDiagMatr()
• C++ examples

setFullStateDiagMatrFromMultiDimLists()

void setFullStateDiagMatrFromMultiDimLists	(	FullStateDiagMatr	out,
		void *	lists,
		int *	numQubitsPerDim,
		int	numDims )

Note

Documentation for this function or struct is under construction!

Warning

This function has not yet been unit tested and may contain bugs. Please use with caution!

Definition at line 724 of file matrices.cpp.

                                                                                                                             {
    validate_matrixFields(out, __func__);
    validate_multiVarFuncQubits(out.numQubits, numQubitsPerDim, numDims, __func__);
 
    // possibly use multithreading, but never GPU acceleration, due to the
    // arbitrarily nested nature of the input lists
    cpu_fullstatediagmatr_setElemsFromMultiDimLists(out, lists, numQubitsPerDim, numDims);
 
    // overwrite all GPU elems
    syncFullStateDiagMatr(out);
}

setFullStateDiagMatrFromMultiVarFunc()

void setFullStateDiagMatrFromMultiVarFunc	(	FullStateDiagMatr	out,
		qcomp(*	func )(qindex *),
		int *	numQubitsPerVar,
		int	numVars,
		int	areSigned )

Note

Documentation for this function or struct is under construction!

Warning

This function has not yet been unit tested and may contain bugs. Please use with caution!

Definition at line 688 of file matrices.cpp.

                                                                                                                                                              {
    validate_matrixFields(out, __func__);
    validate_multiVarFuncQubits(out.numQubits, numQubitsPerVar, numVars, __func__);
    validate_funcVarSignedFlag(areSigned, __func__);
 
    // we assume callbackFunc is thread-safe (!!!!) and possibly use multithreading, but never 
    // GPU acceleration, since we cannot invoke user callback functions from GPU kernels
    cpu_fullstatediagmatr_setElemsFromMultiVarFunc(out, callbackFunc, numQubitsPerVar, numVars, areSigned);
 
    // overwrite all GPU elems
    syncFullStateDiagMatr(out);
}

setFullStateDiagMatrFromPauliStrSum()

void setFullStateDiagMatrFromPauliStrSum	(	FullStateDiagMatr	out,
		PauliStrSum	in )

Note

Documentation for this function or struct is under construction!

Warning

This function has not yet been unit tested and may contain bugs. Please use with caution!

Definition at line 635 of file matrices.cpp.

                                                                                           {
    validate_matrixFields(out, __func__);
    validate_pauliStrSumFields(in, __func__);
    validate_pauliStrSumCanInitMatrix(out, in, __func__);
 
    // permit 'in' to be non-Hermitian since it does not determine 'out' unitarity
 
    // unlike other FullStateDiagMatr initialisers, we employ an accelerated
    // backend since the input data 'in' is expectedly significantly smaller
    // than the created data in 'out', making parallelisation worthwhile as
    // the memory-movement costs of copying 'in' to a GPU are small
    localiser_fullstatediagmatr_setElemsToPauliStrSum(out, in);
 
    markMatrixAsSynced(out);
}

setInlineCompMatr() [1/2]

void setInlineCompMatr	(	CompMatr	matr,
		int	numQb,
		std::vector< std::vector< qcomp > >	in )

Note

Documentation for this function or struct is under construction!

Remarks

This function is only available in C++.

See also

• reportCompMatr()
• createInlineCompMatr()
• C++ examples

Referenced by TEST_CASE().

setInlineCompMatr() [2/2]

void setInlineCompMatr	(	CompMatr	matr,
		int	numQb,
		{{ matrix }}	)

Note

Documentation for this function or struct is under construction!

This entity is actually a macro.

See also

• reportCompMatr()
• createInlineCompMatr()
• C examples

setInlineDiagMatr() [1/2]

void setInlineDiagMatr	(	DiagMatr	matr,
		int	numQb,
		std::vector< qcomp >	in )

Note

Documentation for this function or struct is under construction!

Remarks

This function is only available in C++.

See also

• reportDiagMatr()
• createInlineDiagMatr()
• C++ examples

Referenced by TEST_CASE().

setInlineDiagMatr() [2/2]

void setInlineDiagMatr	(	DiagMatr	matr,
		int	numQb,
		{ list }	)

Note

Documentation for this function or struct is under construction!

This entity is actually a macro.

See also

• reportDiagMatr()
• createInlineDiagMatr()
• C examples

setInlineFullStateDiagMatr() [1/2]

void setInlineFullStateDiagMatr	(	FullStateDiagMatr	matr,
		qindex	startInd,
		qindex	numElems,
		std::vector< qcomp >	in )

Note

Documentation for this function or struct is under construction!

Warning

This function has not yet been unit tested and may contain bugs. Please use with caution!

Remarks

This function is only available in C++.

See also

• reportFullStateDiagMatr()
• C++ examples

setInlineFullStateDiagMatr() [2/2]

void setInlineFullStateDiagMatr	(	FullStateDiagMatr	matr,
		qindex	startInd,
		qindex	numElems,
		{ list }	)

Warning

This function has not yet been unit tested and may contain bugs. Please use with caution!

Note

Documentation for this function or struct is under construction!

This entity is actually a macro.

See also

• reportFullStateDiagMatr()
• C examples