Mantid
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Mantid::Kernel::QuasiRandomNumberSequence Class Reference

Defines an interface to a quasi-random number sequence. More...

#include <QuasiRandomNumberSequence.h>

Inheritance diagram for Mantid::Kernel::QuasiRandomNumberSequence:
Mantid::Kernel::NDRandomNumberGenerator Mantid::Kernel::SobolSequence

Public Member Functions

 QuasiRandomNumberSequence (const unsigned int ndims)
 
- Public Member Functions inherited from Mantid::Kernel::NDRandomNumberGenerator
 NDRandomNumberGenerator ()=delete
 Disable default constructor. More...
 
 NDRandomNumberGenerator (const NDRandomNumberGenerator &)=delete
 Disable copy operator. More...
 
 NDRandomNumberGenerator (const unsigned int ndims)
 Constructor. More...
 
const std::vector< double > & nextPoint ()
 Generate the next set of values that form a point in ND space. More...
 
unsigned int numberOfDimensions () const
 Returns the number of dimensions the point will be generated in, i.e. More...
 
NDRandomNumberGeneratoroperator= (const NDRandomNumberGenerator &)=delete
 Disable assignment operator. More...
 
virtual void restart ()=0
 Restarts the generator from the beginning of the sequence. More...
 
virtual void restore ()=0
 Restores the generator to the last saved point, or the beginning if nothing has been saved. More...
 
virtual void save ()=0
 Saves the current state of the generator. More...
 
virtual ~NDRandomNumberGenerator ()=default
 Virtual destructor to ensure that all inheriting classes have one. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Mantid::Kernel::NDRandomNumberGenerator
void cacheGeneratedValue (const size_t index, const double value)
 Cache a value for a given dimension index, i.e. 0->ND-1. More...
 
void cacheNextPoint (const std::vector< double > &nextPoint)
 Cache the while point in one go. More...
 
virtual void generateNextPoint ()=0
 Generate the next point. Override this in you concrete implementation. More...
 
std::vector< double > & getNextPointCache ()
 Some generators need direct access to the cache. More...
 

Detailed Description

Defines an interface to a quasi-random number sequence.

A quasi-random sequence progressively covers a d-dimensional space with a set of points that are uniformly distributed.

Definition at line 23 of file QuasiRandomNumberSequence.h.

Constructor & Destructor Documentation

◆ QuasiRandomNumberSequence()

Mantid::Kernel::QuasiRandomNumberSequence::QuasiRandomNumberSequence ( const unsigned int  ndims)
inline

Definition at line 25 of file QuasiRandomNumberSequence.h.


The documentation for this class was generated from the following file: