Functions for seeding QuEST's random generators. More...

Functions
int	getNumSeeds ()

std::vector< unsigned >	getSeeds ()

void	getSeeds (unsigned *seeds)

void	setSeeds (std::vector< unsigned > seeds)

void	setSeeds (unsigned *seeds, int numSeeds)

void	setSeedsToDefault ()

Detailed Description

Functions for seeding QuEST's random generators.

Re-seeding with identical seeds will determine all of QuEST's subsequent random outputs (such as measurement and random state preparation), and can be done at any stage of execution. When seeding is not explicitly performed, QuEST will attempt to use a cryptographically secure pseudorandom number generator (CSPRNG) if locally available, else fall back to a standard PRNG, via using the standard C++ random_device class.

Function Documentation

◆ getNumSeeds()

int getNumSeeds ( )

Note: Documentation for this function or struct is under construction!

Definition at line 52 of file debug.cpp.

                  {
    validate_envIsInit(__func__);
 
    return rand_getNumSeeds();
}

Referenced by getSeeds().

◆ getSeeds() [1/2]

std::vector< unsigned > getSeeds ( )

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!

Remarks: This function is only available in C++.

Definition at line 197 of file debug.cpp.

                            {
    validate_envIsInit(__func__);
 
    // allocate temp vector, and pedantically validate successful
    vector<unsigned> out;
    int numSeeds = getNumSeeds();
    auto callback = [&]() { validate_tempAllocSucceeded(false, numSeeds, sizeof(unsigned), __func__); };
    util_tryAllocVector(out, numSeeds, callback);
 
    getSeeds(out.data());
    return out;
}

Referenced by getSeeds(), and setRandomTestStateSeeds().

◆ getSeeds() [2/2]

void getSeeds ( unsigned * seeds )

Note: Documentation for this function or struct is under construction!

Definition at line 58 of file debug.cpp.

                               {
    validate_envIsInit(__func__);
 
    auto vec = rand_getSeeds();
    auto num = rand_getNumSeeds();
 
    for (int i=0; i<num; i++)
        seeds[i] = vec[i];
}

◆ setSeeds() [1/2]

void setSeeds ( std::vector< unsigned > seeds )

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!

Remarks: This function is only available in C++.

◆ setSeeds() [2/2]

void setSeeds	(	unsigned *	seeds,
		int	numSeeds )

Note: Documentation for this function or struct is under construction!

Definition at line 37 of file debug.cpp.

                                             {
    validate_envIsInit(__func__);
    validate_randomSeeds(seeds, numSeeds, __func__);
 
    // consults only root-node seeds
    rand_setSeeds(vector<unsigned>(seeds, seeds+numSeeds));
}

Referenced by setRandomTestStateSeeds().

◆ setSeedsToDefault()

void setSeedsToDefault ( )

Note: Documentation for this function or struct is under construction!

Definition at line 45 of file debug.cpp.

                         {
    validate_envIsInit(__func__);
 
    rand_setSeedsToDefault();
}