Environment

Data structures for managing the QuEST execution environment. More...

Classes
struct	QuESTEnv

Functions
void	finalizeQuESTEnv ()
QuESTEnv	getQuESTEnv ()
void	initCustomQuESTEnv (int useDistrib, int useGpuAccel, int useMultithread)
void	initQuESTEnv ()
int	isQuESTEnvInit ()
void	reportQuESTEnv ()
void	syncQuESTEnv ()

Detailed Description

Data structures for managing the QuEST execution environment.

Function Documentation

finalizeQuESTEnv()

void finalizeQuESTEnv

(

)

Note

Documentation for this function or struct is under construction!

Definition at line 409 of file environment.cpp.

                        {
    validate_envIsInit(__func__);
 
    // NOTE:
    // calling this will not automatically
    // free the memory of existing Quregs
 
    if (globalEnvPtr->isGpuAccelerated)
        gpu_clearCache(); // syncs first
 
    if (globalEnvPtr->isGpuAccelerated && gpu_isCuQuantumCompiled())
        gpu_finalizeCuQuantum();
 
    if (globalEnvPtr->isDistributed) {
        comm_sync();
        comm_end();
    }
 
    // free global env's heap memory and flag it as unallocated
    free(globalEnvPtr);
    globalEnvPtr = nullptr;
 
    // flag that the environment was finalised, to ensure it is never re-initialised
    hasEnvBeenFinalized = true;
}

getQuESTEnv()

QuESTEnv getQuESTEnv

(

)

Note

Documentation for this function or struct is under construction!

Definition at line 401 of file environment.cpp.

                       {
    validate_envIsInit(__func__);
 
    // returns a copy, so cheeky users calling memcpy() upon const struct still won't mutate
    return *globalEnvPtr;
}

Referenced by clearGpuCache(), createCompMatr(), createDiagMatr(), createForcedDensityQureg(), createForcedQureg(), deleteFilesWithPrefixSynch(), getEnvironmentString(), getGpuCacheSize(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), and writeToFileSynch().

initCustomQuESTEnv()

void initCustomQuESTEnv	(	int	useDistrib,
		int	useGpuAccel,
		int	useMultithread )

Note

Documentation for this function or struct is under construction!

See also

• C and C++ examples

Definition at line 383 of file environment.cpp.

                                                                             {
 
    validateAndInitCustomQuESTEnv(useDistrib, useGpuAccel, useMultithread, __func__);
}

initQuESTEnv()

void initQuESTEnv

(

)

Note

Documentation for this function or struct is under construction!

Definition at line 389 of file environment.cpp.

                    {
 
    validateAndInitCustomQuESTEnv(modeflag::USE_AUTO, modeflag::USE_AUTO, modeflag::USE_AUTO, __func__);
}

Referenced by TEST_CASE().

isQuESTEnvInit()

int isQuESTEnvInit

(

)

Note

Documentation for this function or struct is under construction!

Definition at line 395 of file environment.cpp.

                     {
 
    return (int) (globalEnvPtr != nullptr);
}

Referenced by setRandomTestStateSeeds().

reportQuESTEnv()

void reportQuESTEnv

(

)

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

• C and C++ examples

Definition at line 447 of file environment.cpp.

                      {
    validate_envIsInit(__func__);
    validate_numReportedNewlinesAboveZero(__func__); // because trailing newline mandatory
 
    /// @todo add function to write this output to file (useful for HPC debugging)
 
    print_label("QuEST execution environment");
 
    bool statevec = false;
    bool densmatr = true;
 
    // we attempt to report properties of available hardware facilities
    // (e.g. number of CPU cores, number of GPUs) even if the environment is not
    // making use of them, to inform the user how they might change deployment.
    printPrecisionInfo();
    printCompilationInfo();
    printDeploymentInfo();
    printCpuInfo();
    printGpuInfo();
    printDistributionInfo();
    printQuregSizeLimits(statevec);
    printQuregSizeLimits(densmatr);
    printQuregAutoDeployments(statevec);
    printQuregAutoDeployments(densmatr);
 
    // exclude mandatory newline above
    print_oneFewerNewlines();
}

syncQuESTEnv()

void syncQuESTEnv

(

)

Note

Documentation for this function or struct is under construction!

Definition at line 436 of file environment.cpp.

                    {
    validate_envIsInit(__func__);
 
    if (globalEnvPtr->isGpuAccelerated)
        gpu_sync();
 
    if (globalEnvPtr->isDistributed)
        comm_sync();
}

Referenced by areEqual(), areEqual(), areEqual(), deleteFilesWithPrefixSynch(), toQMatrix(), toQureg(), toQureg(), toQVector(), and writeToFileSynch().