Environment

	TEST_CASE ("initQuESTEnv", TEST_CATEGORY)
	TEST_CASE ("initCustomQuESTEnv", TEST_CATEGORY)
	TEST_CASE ("finalizeQuESTEnv", TEST_CATEGORY)
	TEST_CASE ("syncQuESTEnv", TEST_CATEGORY)
	TEST_CASE ("isQuESTEnvInit", TEST_CATEGORY)
	TEST_CASE ("getQuESTEnv", TEST_CATEGORY)

Detailed Description

Function Documentation

TEST_CASE() [1/6]

TEST_CASE	(	"finalizeQuESTEnv"	,
		TEST_CATEGORY	)

Definition at line 86 of file environment.cpp.

                                               {
 
    SECTION( LABEL_CORRECTNESS ) {
 
        // cannot be meaningfully tested since calling
        // mid-tests will break subsequent testing
        SUCCEED( );
    }
 
    SECTION( LABEL_VALIDATION ) {
 
        // cannot be validated since calling it once
        // is always valid but would break subsequent tests
        SUCCEED( );
    }
}

TEST_CASE() [2/6]

TEST_CASE	(	"getQuESTEnv"	,
		TEST_CATEGORY	)

Definition at line 137 of file environment.cpp.

                                          {
 
    SECTION( LABEL_CORRECTNESS ) {
 
        QuESTEnv env = getQuESTEnv();
 
        REQUIRE( (env.isMultithreaded     == 0 || env.isMultithreaded     == 1) );
        REQUIRE( (env.isGpuAccelerated    == 0 || env.isGpuAccelerated    == 1) );
        REQUIRE( (env.isDistributed       == 0 || env.isDistributed       == 1) );
        REQUIRE( (env.isCuQuantumEnabled  == 0 || env.isCuQuantumEnabled  == 1) );
        REQUIRE( (env.isGpuSharingEnabled == 0 || env.isGpuSharingEnabled == 1) );
        
        REQUIRE( env.rank     >= 0 );
        REQUIRE( env.numNodes >= 0 );
        
        if (!env.isDistributed) {
            REQUIRE( env.rank     == 0 );
            REQUIRE( env.numNodes == 1 );
        }
 
        bool isNumNodesPow2 = ((env.numNodes & (env.numNodes - 1)) == 0);
        REQUIRE( isNumNodesPow2 );
    }
 
    SECTION( LABEL_VALIDATION ) {
 
        // performs no validation
        SUCCEED( );
    }
}

TEST_CASE() [3/6]

TEST_CASE	(	"initCustomQuESTEnv"	,
		TEST_CATEGORY	)

Definition at line 68 of file environment.cpp.

                                                 {
 
    SECTION( LABEL_CORRECTNESS ) {
 
        // cannot be meaningfully tested since env already active
        SUCCEED( );
    }
 
    SECTION( LABEL_VALIDATION ) {
 
        REQUIRE_THROWS_WITH( initCustomQuESTEnv(0,0,0), ContainsSubstring( "already been initialised") );
 
        // cannot check arguments since env-already-initialised
        // validation is performed first
    }
}

TEST_CASE() [4/6]

TEST_CASE	(	"initQuESTEnv"	,
		TEST_CATEGORY	)

TESTS

Definition at line 46 of file environment.cpp.

                                           {
 
    SECTION( LABEL_CORRECTNESS ) {
 
        // cannot be meaningfully tested since env already active
        SUCCEED( );
    }
 
    SECTION( LABEL_VALIDATION ) {
 
        REQUIRE_THROWS_WITH( initQuESTEnv(), ContainsSubstring( "already been initialised") );
 
        // cannot automatically check other validations, such as:
        // - has env been previously initialised then finalised?
        // - is env distributed over power-of-2 nodes?
        // - are environment-variables valid?
        // - is max 1 MPI process bound to each GPU?
        // - is GPU compatible with cuQuantum (if enabled)?
    }
}

TEST_CASE() [5/6]

TEST_CASE	(	"isQuESTEnvInit"	,
		TEST_CATEGORY	)

Definition at line 121 of file environment.cpp.

                                             {
 
    SECTION( LABEL_CORRECTNESS ) {
 
        // cannot test for other outcome
        REQUIRE( isQuESTEnvInit() == 1 );
    }
 
    SECTION( LABEL_VALIDATION ) {
 
        // performs no validation
        SUCCEED( );
    }
}

TEST_CASE() [6/6]

TEST_CASE	(	"syncQuESTEnv"	,
		TEST_CATEGORY	)

Definition at line 104 of file environment.cpp.

                                           {
 
    SECTION( LABEL_CORRECTNESS ) {
 
        // always legal to call
        REQUIRE_NOTHROW( syncQuESTEnv() );
    }
 
    SECTION( LABEL_VALIDATION ) {
 
        // cannot test validation (that env is already
        // created) since we cannot call before initQuESTEnv
        SUCCEED( );
    }
}