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

Inheritance diagram for DtPrbCoefficientsDeterminant:

Public Member Functions
	DtPrbCoefficientsDeterminant ()
	DtPrbCoefficientsDeterminant (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor with parameters to set up read/writability correctly
	DtPrbCoefficientsDeterminant (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtPrbCoefficientsDeterminant (const DtString &name, const DtPrbCoefficientsDeterminant &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtPrbCoefficientsDeterminant (const DtSymbolString &name, const DtPrbCoefficientsDeterminant &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtPrbCoefficientsDeterminant &	operator= (const DtPrbCoefficientsDeterminant &orig)
virtual	~DtPrbCoefficientsDeterminant ()
	destructor
virtual DtPrbDeterminant *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtPrbDeterminant *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtPrbProbabilityCoefficients *	addProbabilityCoefficients (const DtPrbProbabilityCoefficients &coefficients)
	Returns newly added cloned copy.
virtual void	getProbabilities (DtReal inputValue, 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 DtPrbCoefficientList &	coefficientList () const
	Returns object containing list of polynomial coefficients used to to form the expression of probability as a function of an input value.
virtual double	solveForMaximum () const
	Given the coefficients returns the maximum range.
bool	operator== (const DtPrbCoefficientsDeterminant &) const
bool	operator!= (const DtPrbCoefficientsDeterminant &rhs) const
virtual bool	isValid () const
	Returns true if there is at least one non zero coefficient. If all are 0 this is "invalid".

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtPrbCoefficientList	myCoefficientList
	Parameter Name: coefficients Parameter Description: a coefficient probability list is a list of coefficient probability entries.

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

DtPrbCoefficientsDeterminant provides a list of kill probabilities based on an input value.

These probabilities are calculated from a set of polynomial coefficients managed by the DtPrbCoefficientList that is a member of this class.

Constructor & Destructor Documentation

DtPrbCoefficientsDeterminant::DtPrbCoefficientsDeterminant ( )

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

constructor with parameters to set up read/writability correctly

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

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

copy constructor

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

virtual DtPrbCoefficientsDeterminant::~DtPrbCoefficientsDeterminant ( )

virtual

destructor

Member Function Documentation

const DtPrbCoefficientsDeterminant& DtPrbCoefficientsDeterminant::operator= ( const DtPrbCoefficientsDeterminant & orig )

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

virtual

Implements DtPrbDeterminant.

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

virtual

Implements DtPrbDeterminant.

virtual DtPrbProbabilityCoefficients* DtPrbCoefficientsDeterminant::addProbabilityCoefficients ( const DtPrbProbabilityCoefficients & coefficients )

virtual

Returns newly added cloned copy.

virtual void DtPrbCoefficientsDeterminant::getProbabilities	(	DtReal	inputValue,
		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 DtPrbCoefficientsDeterminant::getMaximumInputValue ( ) const

virtual

Determines the maximum input value that produces any probability.

Calls myCoefficientList->maxInputValue();

Implements DtPrbDeterminant.

virtual double DtPrbCoefficientsDeterminant::getMinimumInputValue ( ) const

virtual

Determines the minimum input value that produces any probability.

Calls myCoefficientList->minInputValue();

Implements DtPrbDeterminant.

virtual const DtPrbCoefficientList& DtPrbCoefficientsDeterminant::coefficientList ( ) const

virtual

Returns object containing list of polynomial coefficients used to to form the expression of probability as a function of an input value.

virtual double DtPrbCoefficientsDeterminant::solveForMaximum ( ) const

virtual

Given the coefficients returns the maximum range.

If there are more than 3 coefficients this will return 0

bool DtPrbCoefficientsDeterminant::operator== ( const DtPrbCoefficientsDeterminant & ) const

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

inline

virtual bool DtPrbCoefficientsDeterminant::isValid ( ) const

virtual

Returns true if there is at least one non zero coefficient. If all are 0 this is "invalid".

Member Data Documentation

DtPrbCoefficientList DtPrbCoefficientsDeterminant::myCoefficientList

protected

Parameter Name: coefficients
Parameter Description: a coefficient probability list is a list of coefficient probability entries.

Each entry has a probability name and the coefficients of a standard polynomial that can be used with a given value to determine the specified probability. The order of the polynomial is determined by the number of coefficients provided. For example, an entry of: (probability -5.00000E-008 -300000E-012 1.0000) indicates that the formula to use for a given value r would be: (- 5.00000E-008 * r2) + (-300000E-012 * r) + 1.0 Values calculated will be constrained to be between 0.0 and 1.0. Zero values are factored out, for example: (probability -5.00000E-008 0.0000 1.0000) indicates that the formula to use for a given range r would be: (- 5.00000E-008 * r2) + (0.0 * r) + 1.0
Parameter Default Value:

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation