DtPrbProbabilityCoefficients Class Reference

Inheritance diagram for DtPrbProbabilityCoefficients:

List of all members.

Public Member Functions
	DtPrbProbabilityCoefficients ()
	default constructor
	DtPrbProbabilityCoefficients (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	Constructor with parameters to set up read/writability correctly.
	DtPrbProbabilityCoefficients (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtPrbProbabilityCoefficients (const DtString &name, const DtPrbProbabilityCoefficients &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtPrbProbabilityCoefficients (const DtSymbolString &name, const DtPrbProbabilityCoefficients &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtPrbProbabilityCoefficients &	operator= (const DtPrbProbabilityCoefficients &orig)
virtual	~DtPrbProbabilityCoefficients ()
	destructor
virtual DtReal &	operator[] (const int i)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
virtual void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtPrbProbabilityCoefficients *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtPrbProbabilityCoefficients *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void	setNumCoefficients (int num)
	Set numCoefficients will destroy the coefficient list (if it exists) and make a new one of the specified size.
virtual void	setCoefficients (int num, double probabilityCoefficients[])
	Destroys existing coefficient list (if it exists), makes a new one of the given size num, and populates it with the values in probabilityCoefficients.
virtual DtReal	probability (DtReal range)
virtual int	numCoefficients () const
	Returns the number of polynomial coefficients used in the probability as a function range equation.
virtual double	solveForMaximum ()
	Solves the polynomial for the maximum solution.
virtual const DtReal *	coefficients () const
	Returns array of coefficients to be used in an expression of probability versus range.
Protected Attributes
int	myNumCoefficients
DtReal *	myCoefficientList

---

Constructor & Destructor Documentation

DtPrbProbabilityCoefficients::DtPrbProbabilityCoefficients

(

)

default constructor

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

Constructor with parameters to set up read/writability correctly.

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

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

copy constructor

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

virtual DtPrbProbabilityCoefficients::~DtPrbProbabilityCoefficients

(

)

[virtual]

destructor

---

Member Function Documentation

const DtPrbProbabilityCoefficients& DtPrbProbabilityCoefficients::operator=

(

const DtPrbProbabilityCoefficients &

orig

)

virtual DtReal& DtPrbProbabilityCoefficients::operator[]

(

const int

i

)

[virtual]

virtual DtlObjPtr DtPrbProbabilityCoefficients::getData	(	DtlObjPtr	args,
		const DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)		[virtual]

virtual void DtPrbProbabilityCoefficients::putData	(	FILE *	fp,
		int	indentLevel = 0
	)		[virtual]

Deriving class overrides these to get/put class specific data.

Reimplemented from DtReaderWriter.

virtual DtPrbProbabilityCoefficients* DtPrbProbabilityCoefficients::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)		const [virtual]

virtual DtPrbProbabilityCoefficients* DtPrbProbabilityCoefficients::clone	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)		const [virtual]

virtual void DtPrbProbabilityCoefficients::setNumCoefficients

(

int

num

)

[virtual]

Set numCoefficients will destroy the coefficient list (if it exists) and make a new one of the specified size.

virtual void DtPrbProbabilityCoefficients::setCoefficients	(	int	num,
		double	probabilityCoefficients[]
	)		[virtual]

Destroys existing coefficient list (if it exists), makes a new one of the given size num, and populates it with the values in probabilityCoefficients.

probabilityCoefficients must be an array of size num.

virtual DtReal DtPrbProbabilityCoefficients::probability

(

DtReal

range

)

[virtual]

virtual int DtPrbProbabilityCoefficients::numCoefficients

(

)

const [virtual]

Returns the number of polynomial coefficients used in the probability as a function range equation.

virtual double DtPrbProbabilityCoefficients::solveForMaximum

(

)

[virtual]

Solves the polynomial for the maximum solution.

Currently only handels 2nd order and below. If you want to solve a cubic, by all means override this and add your own.

virtual const DtReal* DtPrbProbabilityCoefficients::coefficients

(

)

const [virtual]

Returns array of coefficients to be used in an expression of probability versus range.

(Note there are numCoefficients() items in the list.) The coefficients are in descending order. For example, if there are 3 coefficients, and the values returned by this call are -5.0E-008, 0.0, 1.0, then the expression for probability as a function of range would be: Probabilty(r) = (-5.0E-008.0 * r^2) + (0.0 * r) + 1.0 where r is range in meters

---

Member Data Documentation

int DtPrbProbabilityCoefficients::myNumCoefficients [protected]

DtReal* DtPrbProbabilityCoefficients::myCoefficientList [protected]

---

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

• include/vrfobjparam/probCoeff.h