DtPrbStepFunctionDeterminant Class Reference

DtPrbStepFunctionDeterminant provides a list of probabilities based on an input value. More...

Inheritance diagram for DtPrbStepFunctionDeterminant:

Public Member Functions
	DtPrbStepFunctionDeterminant ()
	DtPrbStepFunctionDeterminant (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor with parameters to set up read/writability correctly
	DtPrbStepFunctionDeterminant (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtPrbStepFunctionDeterminant (const DtString &name, const DtPrbStepFunctionDeterminant &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtPrbStepFunctionDeterminant (const DtSymbolString &name, const DtPrbStepFunctionDeterminant &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtPrbStepFunctionDeterminant &	operator= (const DtPrbStepFunctionDeterminant &orig)
virtual	~DtPrbStepFunctionDeterminant ()
	destructor
virtual DtPrbDeterminant *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtPrbDeterminant *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void	addTableEntry (const DtPrbValueList &tableEntry)
	Adds a table entry in sorted (ascending) order.
virtual void	getProbabilities (DtReal value, DtPrbValueList *entry) const
	The caller provides a pointer to a DtPrbValueList, which is filled in with the appropriate set of probabilities.
virtual double	getMaximumInputValue () const
	Determines the maximum input value that produces any probability.
virtual double	getMinimumInputValue () const
	Determines the minimum input value that produces any probability.
virtual const DtPrbStepFunction &	stepFunction () const
	Accessor for myStepFunction.
bool	operator== (const DtPrbStepFunctionDeterminant &) const
bool	operator!= (const DtPrbStepFunctionDeterminant &rhs) const
virtual double	solveForMaximum () const
	Returns the maximum range.
virtual bool	isValid () const
	Returns true if there is at least one range item that has a hit probability > 0.
virtual bool	removeValue (double)
	Removes the given value and returns true if found.
virtual double	value (int index) const
	Returns the value at the given index.
virtual DtPrbValueList *	changeValue (double oldValue, double newValue, int *newColumn=0)
	Changes the value from the current value to the new value.
virtual DtPrbValueList *	changeValueForColumn (int col, double newRange, int *newColumn=0)
	Changes the range from the current range as the current range position to the new range and reorders as necessary.
virtual int	indexOfValue (double) const
	Returns the "column" of this value. Returns -1 if does not exist.
virtual void	setStepFunction (const DtPrbStepFunction &)
	Sets the step function into the determinant.
virtual void	setRoundDown (bool)
	Accessor/mutator for myStepFunction round down.
virtual bool	roundDown () const

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtPrbStepFunction	myStepFunction
	Parameter Name: step-function Parameter Description: List of value/probability entries, in order of increasing value.

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream.
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static void	setOutputStream (DtOutputStream *stream)
static DtOutputStream &	outputStream ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
Protected Member Functions inherited from DtPrbDeterminant
	DtPrbDeterminant ()
	default constructor
	DtPrbDeterminant (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	Constructor with parameters to set up read/writability correctly.
	DtPrbDeterminant (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtPrbDeterminant (const DtString &name, const DtPrbDeterminant &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtPrbDeterminant (const DtSymbolString &name, const DtPrbDeterminant &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtPrbDeterminant &	operator= (const DtPrbDeterminant &orig)
virtual	~DtPrbDeterminant ()
	destructor
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn
static bool	thePutIndent
static DtOutputStream *	theOutputStream

Detailed Description

DtPrbStepFunctionDeterminant provides a list of probabilities based on an input value.

These probabilities are looked up in a table that is managed by the DtPrbStepFunction that is a member of this class.

Constructor & Destructor Documentation

DtPrbStepFunctionDeterminant::DtPrbStepFunctionDeterminant

(

)

DtPrbStepFunctionDeterminant::DtPrbStepFunctionDeterminant	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

constructor with parameters to set up read/writability correctly

DtPrbStepFunctionDeterminant::DtPrbStepFunctionDeterminant	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtPrbStepFunctionDeterminant::DtPrbStepFunctionDeterminant	(	const DtString &	name,
		const DtPrbStepFunctionDeterminant &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

DtPrbStepFunctionDeterminant::DtPrbStepFunctionDeterminant	(	const DtSymbolString &	name,
		const DtPrbStepFunctionDeterminant &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

virtual DtPrbStepFunctionDeterminant::~DtPrbStepFunctionDeterminant ( )

virtual

destructor

Member Function Documentation

const DtPrbStepFunctionDeterminant& DtPrbStepFunctionDeterminant::operator=

(

const DtPrbStepFunctionDeterminant &

orig

)

virtual DtPrbDeterminant* DtPrbStepFunctionDeterminant::clone ( const DtString &  name, DtReaderWriterRegistry *  parentRegistry = NULL  ) const

virtual

Implements DtPrbDeterminant.

virtual DtPrbDeterminant* DtPrbStepFunctionDeterminant::clone ( const DtSymbolString &  name, DtReaderWriterRegistry *  parentRegistry = NULL  ) const

virtual

Implements DtPrbDeterminant.

virtual void DtPrbStepFunctionDeterminant::addTableEntry ( const DtPrbValueList &  tableEntry )

virtual

Adds a table entry in sorted (ascending) order.

virtual void DtPrbStepFunctionDeterminant::getProbabilities ( DtReal  value, DtPrbValueList *  entry  ) const

virtual

The caller provides a pointer to a DtPrbValueList, which is filled in with the appropriate set of probabilities.

Implements DtPrbDeterminant.

virtual double DtPrbStepFunctionDeterminant::getMaximumInputValue ( ) const

virtual

Determines the maximum input value that produces any probability.

Implements DtPrbDeterminant.

virtual double DtPrbStepFunctionDeterminant::getMinimumInputValue ( ) const

virtual

Determines the minimum input value that produces any probability.

Implements DtPrbDeterminant.

virtual const DtPrbStepFunction& DtPrbStepFunctionDeterminant::stepFunction ( ) const

virtual

Accessor for myStepFunction.

bool DtPrbStepFunctionDeterminant::operator==

(

const DtPrbStepFunctionDeterminant &

)

const

bool DtPrbStepFunctionDeterminant::operator!= ( const DtPrbStepFunctionDeterminant &  rhs ) const

inline

virtual double DtPrbStepFunctionDeterminant::solveForMaximum ( ) const

virtual

Returns the maximum range.

virtual void DtPrbStepFunctionDeterminant::setRoundDown ( bool  )

virtual

Accessor/mutator for myStepFunction round down.

virtual bool DtPrbStepFunctionDeterminant::roundDown ( ) const

virtual

virtual bool DtPrbStepFunctionDeterminant::isValid ( ) const

virtual

Returns true if there is at least one range item that has a hit probability > 0.

virtual bool DtPrbStepFunctionDeterminant::removeValue ( double  )

virtual

Removes the given value and returns true if found.

virtual double DtPrbStepFunctionDeterminant::value ( int  index ) const

virtual

Returns the value at the given index.

virtual DtPrbValueList* DtPrbStepFunctionDeterminant::changeValue ( double  oldValue, double  newValue, int *  newColumn = 0  )

virtual

Changes the value from the current value to the new value.

If the new range exists then will reset that range to the current ranges values

virtual DtPrbValueList* DtPrbStepFunctionDeterminant::changeValueForColumn ( int  col, double  newRange, int *  newColumn = 0  )

virtual

Changes the range from the current range as the current range position to the new range and reorders as necessary.

virtual int DtPrbStepFunctionDeterminant::indexOfValue ( double  ) const

virtual

Returns the "column" of this value. Returns -1 if does not exist.

virtual void DtPrbStepFunctionDeterminant::setStepFunction ( const DtPrbStepFunction &  )

virtual

Sets the step function into the determinant.

Member Data Documentation

DtPrbStepFunction DtPrbStepFunctionDeterminant::myStepFunction

protected

Parameter Name: step-function
Parameter Description: List of value/probability entries, in order of increasing value.

The probability for a given entry applies to a value interval going from the value in the previous entry to the current entry value. For the first item in the list, the probability applies to a value of zero to the value specified in the entry.
Parameter Default Value:

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjparam/prbStepFunctionDeterminant.h