ERC CISST - cisst software

---

nmrPolynomialContainer< _TermInfo > Class Template Reference

Inheritance diagram for nmrPolynomialContainer< _TermInfo >:

[legend]Collaboration diagram for nmrPolynomialContainer< _TermInfo >:

[legend]List of all members.

---

Detailed Description

template<class _TermInfo>
class nmrPolynomialContainer< _TermInfo >

Definition at line 60 of file nmrPolynomialContainer.h.

Public Types

• typedef nmrPolynomialBase BaseType
• typedef _TermInfo TermInfoType
• typedef std::pair< nmrPolynomialTermPowerIndex,
  TermInfoType > ContainerElementType
• typedef std::list< ContainerElementType > TermContainerType
• typedef TermContainerType::value_type TermType
• typedef TermContainerType::iterator TermIteratorType
• typedef TermContainerType::const_iterator TermConstIteratorType

Public Member Functions

• nmrPolynomialContainer (VariableIndexType numVariables, PowerType minDegree, PowerType maxDegree)
• virtual ~nmrPolynomialContainer ()
• virtual TermCounterType GetNumberOfTerms () const
• virtual bool IsEmpty () const
• virtual void SetMinDegree (PowerType newMin) throw (std::runtime_error)
• virtual void SetMaxDegree (PowerType newMax) throw (std::runtime_error)
• virtual void FillAllTerms ()
• virtual bool IncludesIndex (const nmrPolynomialTermPowerIndex &target) const
• virtual TermCounterType GetIndexPosition (const nmrPolynomialTermPowerIndex &term) const
• TermIteratorType GetTermIteratorForPosition (TermCounterType position)
• TermIteratorType FirstTermIterator ()
• TermConstIteratorType FirstTermIterator () const
• TermIteratorType EndTermIterator ()
• TermConstIteratorType EndTermIterator () const
• TermIteratorType FindTerm (const nmrPolynomialTermPowerIndex &target)
• TermConstIteratorType FindTerm (const nmrPolynomialTermPowerIndex &target) const
• virtual void RemoveTerm (const nmrPolynomialTermPowerIndex &where)
• virtual void RemoveTerm (TermIteratorType &where)
• virtual void Clear ()
• virtual InsertStatus SetCoefficient (const nmrPolynomialTermPowerIndex &where, CoefficientType coefficient)=0
• virtual InsertStatus SetCoefficient (TermIteratorType &where, CoefficientType coefficient)=0
• virtual CoefficientType GetCoefficient (const TermConstIteratorType &where) const=0
• virtual CoefficientType GetCoefficient (const TermIteratorType &where) const=0
• virtual void CollectCoefficients (CoefficientType target[]) const
• virtual void RestoreCoefficients (const CoefficientType source[])
• const nmrPolynomialTermPowerIndex & GetTermPowerIndex (const TermConstIteratorType &where) const
• const nmrPolynomialTermPowerIndex & GetTermPowerIndex (const TermIteratorType &where) const
• virtual ValueType EvaluateBasis (const TermConstIteratorType &where, const nmrMultiVariablePowerBasis &variables) const=0
• virtual ValueType EvaluateBasis (const TermIteratorType &where, const nmrMultiVariablePowerBasis &variables) const=0
• ValueType EvaluateTerm (const TermConstIteratorType &where) const
• ValueType EvaluateTerm (const TermIteratorType &where) const
• ValueType EvaluateTerm (const TermConstIteratorType &where, const nmrMultiVariablePowerBasis &variables) const
• ValueType EvaluateTerm (const TermIteratorType &where, const nmrMultiVariablePowerBasis &variables) const
• virtual ValueType Evaluate (const nmrMultiVariablePowerBasis &variables) const
• virtual void EvaluateBasisVector (const nmrMultiVariablePowerBasis &variables, ValueType termBaseValues[]) const
• virtual ValueType EvaluateForCoefficients (const nmrMultiVariablePowerBasis &variables, const CoefficientType coefficients[]) const
• virtual void Scale (CoefficientType scaleFactor)
• virtual void AddConstant (CoefficientType shiftAmount)=0
• virtual void AddConstantToCoefficients (CoefficientType coefficients[], CoefficientType shiftAmount) const=0
• virtual void SerializeTermInfo (std::ostream &output, const TermConstIteratorType &termIterator) const =0
• virtual void DeserializeTermInfo (std::istream &input, TermIteratorType &termIterator)=0
• virtual void SerializeRaw (std::ostream &output) const
• virtual void DeserializeRaw (std::istream &input)

Protected Member Functions

• const TermInfoType & GetTermInfo (const TermConstIteratorType &termIterator) const
• TermInfoType & GetTermInfo (const TermConstIteratorType &termIterator)

Protected Attributes

• TermContainerType Terms

Classes

• class EqualityTester
• class LessOrEqualityTester

---

Member Function Documentation

template<class _TermInfo>

TermIteratorType nmrPolynomialContainer< _TermInfo >::GetTermIteratorForPosition

(

TermCounterType

position

)

[inline]

Return the iterator for a term identified by its sequential number (as in GetIndexPosition).

Definition at line 231 of file nmrPolynomialContainer.h.

template<class _TermInfo>

virtual ValueType nmrPolynomialContainer< _TermInfo >::Evaluate

(

const nmrMultiVariablePowerBasis &

variables

)

const [inline, virtual]

Evaluate the polynomial for externally given variables

Implements nmrPolynomialBase.

Definition at line 374 of file nmrPolynomialContainer.h.

template<class _TermInfo>

virtual void nmrPolynomialContainer< _TermInfo >::EvaluateBasisVector	(	const nmrMultiVariablePowerBasis &	variables,
		ValueType	termBaseValues[]
	)			const [inline, virtual]

Evaluate the basis functions of the terms as a vector of values.

Definition at line 389 of file nmrPolynomialContainer.h.

template<class _TermInfo>

virtual void nmrPolynomialContainer< _TermInfo >::Scale

(

CoefficientType

scaleFactor

)

[inline, virtual]

Overloaded from nmrPolynomialBase

Definition at line 420 of file nmrPolynomialContainer.h.

template<class _TermInfo>

virtual void nmrPolynomialContainer< _TermInfo >::AddConstant

(

CoefficientType

shiftAmount

)

[pure virtual]

Overloaded from nmrPolynomialBase and declared abstract as the implementation varies in subtypes. See subtype implementations

template<class _TermInfo>

virtual void nmrPolynomialContainer< _TermInfo >::AddConstantToCoefficients	(	CoefficientType	coefficients[],
		CoefficientType	shiftAmount
	)			const [pure virtual]

Overloaded from nmrPolynomialBase. See subtype implementations

template<class _TermInfo>

virtual void nmrPolynomialContainer< _TermInfo >::SerializeTermInfo	(	std::ostream &	output,
		const TermConstIteratorType &	termIterator
	)			const [pure virtual]

Serialize the TermInfo member associated with the power index of a term. The implementation of this function is to be specific per TermInfo concrete type, and so it should be overridden in the derived classes. This function is called from SerializeRaw().

Parameters:

	output	the output serializetion stream
	termIterator	an iterator referring to the term whose contents are being serialized.

template<class _TermInfo>

virtual void nmrPolynomialContainer< _TermInfo >::DeserializeTermInfo	(	std::istream &	input,
		TermIteratorType &	termIterator
	)			[pure virtual]

Deserialize and do other necessary initializations for the TermInfoMember associated with the power index of a term. This function should be complementart to SerializeTermInfo.

Parameters:

	input	the input deserialization stream
	termIterator	an iterator referreing to the term whose contents are being deserialized.

template<class _TermInfo>

virtual void nmrPolynomialContainer< _TermInfo >::SerializeRaw

(

std::ostream &

output

)

const [inline, virtual]

nmrPolynomialBase::SerializeRaw() plus serialize for each term the power index in nmrPolynomialTermPowerIndex::SerializeIndexRaw() format, and the specific term information by calling the abstract SerializeTermInfo for that term.

Reimplemented from nmrPolynomialBase.

Definition at line 486 of file nmrPolynomialContainer.h.

template<class _TermInfo>

virtual void nmrPolynomialContainer< _TermInfo >::DeserializeRaw

(

std::istream &

input

)

[inline, virtual]

nmrPolynomialBase::DeserializeRaw() plus deserialize all the terms. For each term we use nmrPolynomialTermPowerIndex::DeserializeIndexRaw() and then call the abstract DeserializeTermInfo() to complete the rest of the term information.

Reimplemented from nmrPolynomialBase.

Definition at line 503 of file nmrPolynomialContainer.h.

---

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

• nmrPolynomialContainer.h

---