Cache

Testing utilities which create Quregs across all available hardware deployments. More...

Typedefs
using	deployInfo = std::vector<std::tuple<std::string,int,int,int>>
using	matrixCache = std::unordered_map<std::string,FullStateDiagMatr>
using	quregCache = std::unordered_map<std::string,Qureg>

Functions
void	createCachedFullStateDiagMatrs ()
void	createCachedQuregs ()
void	destroyCachedFullStateDiagMatrs ()
void	destroyCachedQuregs ()
quregCache	getAltCachedDensmatrs ()
quregCache	getAltCachedStatevecs ()
quregCache	getCachedDensmatrs ()
matrixCache	getCachedFullStateDiagMatrs ()
quregCache	getCachedStatevecs ()
int	getNumCachedQubits ()
qmatrix	getRefDensmatr ()
qvector	getRefStatevec ()
deployInfo	getSupportedDeployments ()

Detailed Description

Testing utilities which create Quregs across all available hardware deployments.

Typedef Documentation

deployInfo

using deployInfo = std::vector<std::tuple<std::string,int,int,int>>

Definition at line 27 of file cache.hpp.

matrixCache

using matrixCache = std::unordered_map<std::string,FullStateDiagMatr>

Definition at line 26 of file cache.hpp.

quregCache

using quregCache = std::unordered_map<std::string,Qureg>

Definition at line 25 of file cache.hpp.

Function Documentation

createCachedFullStateDiagMatrs()

void createCachedFullStateDiagMatrs

(

)

Definition at line 177 of file cache.cpp.

                                      {
 
    // must not be called twice
    DEMAND( matrices.empty() );
 
    // only add supported-deployment matrices to the cache
    for (auto [label, mpi, gpu, omp] : getSupportedDeployments())
        matrices[label] = createCustomFullStateDiagMatr(getNumCachedQubits(), mpi, gpu, omp);
}

createCachedQuregs()

void createCachedQuregs

(

)

Definition at line 105 of file cache.cpp.

                          {
 
    // must not be called twice nor pre-creation
    DEMAND( statevecs1.empty() );
    DEMAND( statevecs2.empty() );
    DEMAND( densmatrs1.empty() );
    DEMAND( densmatrs2.empty() );
 
    statevecs1 = createCachedStatevecsOrDensmatrs(false);
    statevecs2 = createCachedStatevecsOrDensmatrs(false);
    densmatrs1 = createCachedStatevecsOrDensmatrs(true);
    densmatrs2 = createCachedStatevecsOrDensmatrs(true);
}

destroyCachedFullStateDiagMatrs()

void destroyCachedFullStateDiagMatrs

(

)

Definition at line 187 of file cache.cpp.

                                       {
 
    // must not be called twice
    DEMAND( !matrices.empty() );
 
    for (auto& [label, matrix]: matrices)
        destroyFullStateDiagMatr(matrix);
 
    matrices.clear();
}

destroyCachedQuregs()

void destroyCachedQuregs

(

)

Definition at line 119 of file cache.cpp.

                           {
 
    // must not be called twice nor pre-creation
    DEMAND( ! statevecs1.empty() );
    DEMAND( ! statevecs2.empty() );
    DEMAND( ! densmatrs1.empty() );
    DEMAND( ! densmatrs2.empty() );
 
    auto caches = {
        statevecs1, statevecs2, 
        densmatrs1, densmatrs2};
 
    for (auto& cache : caches)
        for (auto& [label, qureg]: cache)
            destroyQureg(qureg);
 
    statevecs1.clear();
    statevecs2.clear();
    densmatrs1.clear();
    densmatrs2.clear();
}

getAltCachedDensmatrs()

quregCache getAltCachedDensmatrs

(

)

Definition at line 163 of file cache.cpp.

                                   {
 
    // must not be called pre-creation nor post-destruction
    DEMAND( !densmatrs2.empty() );
 
    return densmatrs2;
}

getAltCachedStatevecs()

quregCache getAltCachedStatevecs

(

)

Definition at line 156 of file cache.cpp.

                                   {
 
    // must not be called pre-creation nor post-destruction
    DEMAND( !statevecs2.empty() );
 
    return statevecs2;
}

getCachedDensmatrs()

quregCache getCachedDensmatrs

(

)

Definition at line 148 of file cache.cpp.

                                {
 
    // must not be called pre-creation nor post-destruction
    DEMAND( !densmatrs1.empty() );
 
    return densmatrs1;
}

getCachedFullStateDiagMatrs()

matrixCache getCachedFullStateDiagMatrs

(

)

Definition at line 198 of file cache.cpp.

                                          {
 
    // must not be called pre-creation nor post-destruction
    DEMAND( !matrices.empty() );
 
    return matrices;
}

getCachedStatevecs()

quregCache getCachedStatevecs

(

)

Definition at line 141 of file cache.cpp.

                                {
 
    // must not be called pre-creation nor post-destruction
    DEMAND( !statevecs1.empty() );
 
    return statevecs1;
}

getNumCachedQubits()

int getNumCachedQubits

(

)

Definition at line 40 of file cache.cpp.

                         {
 
    // we are merely aliasing the below env-var fetching function
    // to minimise a diff since pre-runtime controlling the tested
    // Qureg sizes is experimental and not fully designed (we may
    // eventually wish to specify different sizes for statevectors
    // vs density matrices, or control integration test Qureg sizes
    // also through environment variables, etc)
    return getNumQubitsInUnitTestedQuregs();
}

getRefDensmatr()

qmatrix getRefDensmatr

(

)

Definition at line 215 of file cache.cpp.

                         {
    return getZeroMatrix(getPow2(getNumCachedQubits()));
}

getRefStatevec()

qvector getRefStatevec

(

)

Definition at line 212 of file cache.cpp.

                         {
    return getZeroVector(getPow2(getNumCachedQubits()));
}

getSupportedDeployments()

deployInfo getSupportedDeployments

(

)

Definition at line 57 of file cache.cpp.

                                     {
 
    deployInfo out;
 
    // determine which Qureg deployments are supported
    QuESTEnv env = getQuESTEnv();
    bool omp = env.isMultithreaded;
    bool mpi = env.isDistributed;
    bool gpu = env.isGpuAccelerated;
 
    // return only the "most-accelerated" deployment, unless all are desired
    bool one = ! getWhetherToTestAllDeployments();
 
    // add only those supported to the output list, in order of preference.
    // flag order is (MPI, GPU, OMP), matching createCustomQureg
    if (gpu && omp && mpi) { out.push_back({"GPU + OMP + MPI", 1, 1, 1}); if (one) return out; }
    if (gpu && mpi)        { out.push_back({"GPU + MPI",       1, 1, 0}); if (one) return out; }
    if (gpu && omp)        { out.push_back({"GPU + OMP",       0, 1, 1}); if (one) return out; }
    if (gpu)               { out.push_back({"GPU",             0, 1, 0}); if (one) return out; }
    if (mpi && omp)        { out.push_back({"CPU + OMP + MPI", 1, 0, 1}); if (one) return out; }
    if (mpi)               { out.push_back({"CPU + MPI",       1, 0, 0}); if (one) return out; }
    if (omp)               { out.push_back({"CPU + OMP",       0, 0, 1}); if (one) return out; }
    if (true)              { out.push_back({"CPU",             0, 0, 0}); if (one) return out; }
 
    // always contains CPU obviously, but this makes it explicit
    DEMAND( !out.empty() );
    
    // return all supported deployments
    return out;
}