IGLib  1.7.2
The IGLib base library EXTENDED - with other lilbraries and applications.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
IG.Num.SamplerCubeRandomUniform Class Reference

Uniformly distributed random sampling within the coordinate origin-centered cube. More...

+ Inheritance diagram for IG.Num.SamplerCubeRandomUniform:
+ Collaboration diagram for IG.Num.SamplerCubeRandomUniform:

Public Member Functions

 SamplerCubeRandomUniform (int spaceDimension, IRandomGenerator rand)
 Construct a new sampling object with the specified random generator that is used for creating new sampling points. More...
 
 SamplerCubeRandomUniform (int spaceDimension, IRandomGenerator rand, double sideLength)
 Construct a new sampling object with the specified random generator that is used for creating new sampling points. More...
 
override void GetSamplingPoint (ref IVector samplingPoint)
 Creates the next sampling point and stores it to the specified vector. More...
 
- Public Member Functions inherited from IG.Num.SamplerBaseRandom
 SamplerBaseRandom (int spaceDimension, IRandomGenerator rand)
 Construct a new sampling object with the specified random generator that is used for creating new sampling points. More...
 
void SetRandomGenerator (IRandomGenerator rand)
 Sets the random generator that will be used for generation of sampling points. More...
 
- Public Member Functions inherited from IG.Num.SamplerBase
 SamplerBase (int spaceDimension)
 Constructs a new sampling point generator for the specified dimension of sampling space. More...
 
virtual void GetSamplingPoints (int numPoints, ref IVector[] samplingPoints)
 Creates the specified number of next sampling points and stores it to the specified array of vectors. More...
 
void ResizeSamplingPoints (int numPoints, ref IVector[] samplingPoints)
 Auxiliary method that resizes the array of sampling points, and also the vectors contained in it, as necessary. More...
 

Protected Attributes

double _sideLength = 1.0
 
- Protected Attributes inherited from IG.Num.SamplerBase
int _spaceDimension
 

Properties

double SideLength [get, protected set]
 
- Properties inherited from IG.Num.SamplerBaseRandom
IRandomGenerator Random [get, protected set]
 The random generator that will be used for generation of sampling points. If it is null, the next call to getter will automatically assign it to the global random generator. More...
 
- Properties inherited from IG.Num.SamplerBase
object Lock [get]
 This object's central lock object to be used by other object. Do not use this object for locking in class' methods, for this you should use InternalLock. More...
 
int SpaceDimension [get, protected set]
 
- Properties inherited from IG.Num.ISampler
int SpaceDimension [get]
 
- Properties inherited from IG.Lib.ILockable
object Lock [get]
 

Detailed Description

Uniformly distributed random sampling within the coordinate origin-centered cube.

Cube side lengths can be specified, and are 1 by default.

$A Igor xx;

Constructor & Destructor Documentation

IG.Num.SamplerCubeRandomUniform.SamplerCubeRandomUniform ( int  spaceDimension,
IRandomGenerator  rand 
)
inline

Construct a new sampling object with the specified random generator that is used for creating new sampling points.

Constructed sampler object generates uniformly distributed random samples within a cube centered around coordinate origin with side lengths equal to 1.

Random generator can be null, in which case a global random generator will be used.

Parameters
spaceDimensionDimension of the sampled space.
randThe random generator that will be used for generation of sampling points. It can be null, in which case the global random generator will be used.
IG.Num.SamplerCubeRandomUniform.SamplerCubeRandomUniform ( int  spaceDimension,
IRandomGenerator  rand,
double  sideLength 
)
inline

Construct a new sampling object with the specified random generator that is used for creating new sampling points.

Constructed sampler object generates uniformly distributed random samples within a cube centered around coordinate origin with specified side length.

Random generator can be null, in which case a global random generator will be used.

Parameters
spaceDimensionDimension of the sampled space.
randThe random generator that will be used for generation of sampling points. It can be null, in which case the global random generator will be used.
sideLengthSide length of the coordinate-origin centered unit cube that defines the sampling region.

Member Function Documentation

override void IG.Num.SamplerCubeRandomUniform.GetSamplingPoint ( ref IVector  samplingPoint)
inline

Creates the next sampling point and stores it to the specified vector.

Parameters
samplingPointVector where the generated sampling point is stored.

Implements IG.Num.ISampler.

References IG.Num.IRandomGenerator.NextDouble(), and IG.Num.VectorBase.Resize().

Member Data Documentation

double IG.Num.SamplerCubeRandomUniform._sideLength = 1.0
protected

Property Documentation

double IG.Num.SamplerCubeRandomUniform.SideLength
getprotected set

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