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.SamplerBaseRandom Class Reference

Base class for sampling classes that produce a desired number of sampling points with a particular arrangement in space, and which use a random generator for creation of sampling points. More...

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

Public Member Functions

 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...
 
abstract void GetSamplingPoint (ref IVector samplingPoint)
 Creates the next sampling point and stores it to the specified vector. 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...
 

Properties

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]
 

Private Attributes

IRandomGenerator _random
 

Additional Inherited Members

- Protected Attributes inherited from IG.Num.SamplerBase
int _spaceDimension
 

Detailed Description

Base class for sampling classes that produce a desired number of sampling points with a particular arrangement in space, and which use a random generator for creation of sampling points.

$A Igor xx;

Constructor & Destructor Documentation

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

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

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.

Member Function Documentation

void IG.Num.SamplerBaseRandom.SetRandomGenerator ( IRandomGenerator  rand)
inline

Sets the random generator that will be used for generation of sampling points.

Parameters
randTandom generator to be used for generation of sampling points.

Member Data Documentation

IRandomGenerator IG.Num.SamplerBaseRandom._random
private

Property Documentation

IRandomGenerator IG.Num.SamplerBaseRandom.Random
getprotected 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.


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