Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members  

ValueGenerator_Correlate Template Class Reference

Distribute value around a master value located elsewhere, using a supplied uncorrelation factor plus upper and lower bounds. More...

#include <valuegen.h>

Inheritance diagram for ValueGenerator_Correlate

Inheritance graph

[legend]
Collaboration diagram for ValueGenerator_Correlate:

Collaboration graph

[legend]
List of all members.

Public Methods

 ValueGenerator_Correlate (T* master_value_ptr, T* uncorrelation_ptr, T lower_bound, T upper_bound)
 master_value_ptr and uncorrelation_ptr should be const. More...

 ValueGenerator_Correlate (StringArgs& args, T* ref=0)
 ValueGenerator_Correlate (const ValueGenerator_Correlate& other)
 Copy constructor. More...

virtual bool next ()
 Advance to the next state (whatever that means for this object). More...

virtual void reset ()
 Reset to the starting state. More...

virtual ValueGenerator<T>* clone () const
 Constructs an identical copy of self and returns it. More...


Detailed Description

template<class T = double, randomgen_fnPtr random_fn = uniform_distribution, bool crop = true> template class ValueGenerator_Correlate

Distribute value around a master value located elsewhere, using a supplied uncorrelation factor plus upper and lower bounds.

If using a uniform distribution, the value is cropped to the given bounds, but it is not otherwise since the cropping would either change the distribution or would require generating a number (possibly infinite) of different values from the distribution before finding one in the right range.

Definition at line 202 of file valuegen.h.


Constructor & Destructor Documentation

template<classT = double, randomgen_fnPtrrandom_fn = uniform_distribution, boolcrop = true>
ValueGenerator_Correlate<T, random_fn, crop>::ValueGenerator_Correlate<T, random_fn, crop> ( T * master_value_ptr,
T * uncorrelation_ptr,
T lower_bound,
T upper_bound )
 

master_value_ptr and uncorrelation_ptr should be const.

Definition at line 210 of file valuegen.h.

Referenced by clone().

template<classT = double, randomgen_fnPtrrandom_fn = uniform_distribution, boolcrop = true>
ValueGenerator_Correlate<T, random_fn, crop>::ValueGenerator_Correlate<T, random_fn, crop> ( StringArgs & args,
T * ref = 0 )
 

Definition at line 217 of file valuegen.h.

template<classT = double, randomgen_fnPtrrandom_fn = uniform_distribution, boolcrop = true>
ValueGenerator_Correlate<T, random_fn, crop>::ValueGenerator_Correlate<T, random_fn, crop> ( const ValueGenerator_Correlate<T, random_fn, crop> & other )
 

Copy constructor.

Definition at line 240 of file valuegen.h.


Member Function Documentation

template<classT = double, randomgen_fnPtrrandom_fn = uniform_distribution, boolcrop = true>
ValueGenerator< T >* ValueGenerator_Correlate<T, random_fn, crop>::clone<T> ( ) const [inline, virtual]
 

Constructs an identical copy of self and returns it.

Reimplemented from ValueGenerator.

Definition at line 263 of file valuegen.h.

template<classT = double, randomgen_fnPtrrandom_fn = uniform_distribution, boolcrop = true>
bool ValueGenerator_Correlate<T, random_fn, crop>::next ( void ) [inline, virtual]
 

Advance to the next state (whatever that means for this object).

Reimplemented from ValueGenerator.

Definition at line 244 of file valuegen.h.

template<classT = double, randomgen_fnPtrrandom_fn = uniform_distribution, boolcrop = true>
void ValueGenerator_Correlate<T, random_fn, crop>::reset ( ) [inline, virtual]
 

Reset to the starting state.

Reimplemented from ValueGenerator.

Definition at line 261 of file valuegen.h.


The documentation for this class was generated from the following file:
Generated at Mon Aug 21 00:31:28 2000 for RF-LISSOM by doxygen1.2.1 written by Dimitri van Heesch, © 1997-2000