Lists

Testing utilities which generate lists of integers. More...

Typedefs
template<class T >
using	CatchGen = Catch::Generators::GeneratorWrapper<T>
using	listpair = std::tuple<vector<int>,vector<int>>
using	listtrio = std::tuple<vector<int>,vector<int>,vector<int>>

Functions
CatchGen< listpair >	disjointsublists (CatchGen< int > &&gen, int sublen1, int sublen2)
listpair	GENERATE_CTRLS_AND_TARGS (int numQubits, int numCtrls, int numTargs)
vector< int >	GENERATE_TARGS (int numQubits, int numTargs)
vector< int >	getComplement (vector< int > listA, vector< int > listB)
vector< int >	getRange (int endExcl)
vector< int >	getRange (int start, int endExcl)
vector< int >	getSublist (vector< int > list, int start, int len)
vector< qcomp >	getSublist (vector< qcomp > list, int start, int len)
CatchGen< vector< int > >	sublists (CatchGen< int > &&gen, int sublen)

Detailed Description

Testing utilities which generate lists of integers.

Typedef Documentation

CatchGen

template<class T >

using CatchGen = Catch::Generators::GeneratorWrapper<T>

Definition at line 34 of file lists.hpp.

listpair

using listpair = std::tuple<vector<int>,vector<int>>

Definition at line 23 of file lists.hpp.

listtrio

using listtrio = std::tuple<vector<int>,vector<int>,vector<int>>

Definition at line 24 of file lists.hpp.

Function Documentation

GENERATE_CTRLS_AND_TARGS()

listpair GENERATE_CTRLS_AND_TARGS	(	int	numQubits,
		int	numCtrls,
		int	numTargs )

Definition at line 262 of file lists.cpp.

                                                                             {
    DEMAND( numQubits >= numCtrls + numTargs );
 
    // impose a limit on the number of {ctrls,targs} to generate (max-int if none set)
    int numPerms = getNumPermutations(numQubits, numCtrls + numTargs);
    int maxPerms = TEST_MAX_NUM_QUBIT_PERMUTATIONS;
    if (maxPerms == 0)
        maxPerms = std::numeric_limits<int>::max();
 
    // if all permutations are permitted, determinstically generate each in turn.
    // note this wastefully generates all orderings of ctrl qubits, despite that
    // this has no effect on all API operations, but we carefully check anyway!
    if (numPerms < maxPerms)
        return GENERATE_COPY( disjointsublists(range(0,numQubits), numCtrls, numTargs) );
 
    // otherwise generate as many random {ctrls,targs} as permitted
    GENERATE_COPY( range(0,maxPerms) );
    return getRandomFixedNumCtrlsTargs(numQubits, numCtrls, numTargs);
}

GENERATE_TARGS()

vector< int > GENERATE_TARGS	(	int	numQubits,
		int	numTargs )

Definition at line 283 of file lists.cpp.

                                                        {
    DEMAND( numQubits >= numTargs );
 
    auto [ctrls, targs] = GENERATE_CTRLS_AND_TARGS(numQubits, 0, numTargs);
    return targs;
}

getComplement()

vector< int > getComplement	(	vector< int >	listA,
		vector< int >	listB )

Definition at line 92 of file lists.cpp.

                                                                {
 
    std::sort(listA.begin(), listA.end());
    std::sort(listB.begin(), listB.end());
 
    vector<int> out;
    std::set_difference(
        listA.begin(), listA.end(), 
        listB.begin(), listB.end(), 
        std::back_inserter(out));
 
    return out;
}

getRange() [1/2]

vector< int > getRange

(

int

endExcl

)

Definition at line 81 of file lists.cpp.

                                  {
    return getRange(0, endExcl);
}

getRange() [2/2]

vector< int > getRange	(	int	start,
		int	endExcl )

Definition at line 69 of file lists.cpp.

                                             {
    DEMAND( endExcl >= start );
 
    vector<int> out(endExcl - start);
 
    for (size_t i=0; i<out.size(); i++)
        out[i] = start + i;
 
    return out;
}

getSublist() [1/2]

vector< int > getSublist	(	vector< int >	list,
		int	start,
		int	len )

Definition at line 51 of file lists.cpp.

                                                             {
 
    return vector<int>(list.begin() + start, list.begin() + start + len);
}

getSublist() [2/2]

vector< qcomp > getSublist	(	vector< qcomp >	list,
		int	start,
		int	len )

Definition at line 57 of file lists.cpp.

                                                                 {
 
    return vector<qcomp>(list.begin() + start, list.begin() + start + len);
}