ACF $AcfVersion:0$
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
imath::TMultidimensionalPolynomial< Dimensions, Element > Class Template Reference

Multidimensional polynomial function. More...

#include <TMultidimensionalPolynomial.h>

Inheritance diagram for imath::TMultidimensionalPolynomial< Dimensions, Element >:
imath::TIMathFunction< Argument, Result > iser::ISerializable istd::IPolymorphic istd::IChangeable istd::IPolymorphic

Public Types

typedef imath::TIMathFunction< TVector< Dimensions >, Element > BaseClass
 
typedef istd::TArray< Element, Dimensions > Coefficients
 
typedef Coefficients::SizesType CoeffGridSize
 
- Public Types inherited from imath::TIMathFunction< Argument, Result >
typedef Argument ArgumentType
 
typedef Result ResultType
 
- Public Types inherited from istd::IChangeable
enum  ChangeFlags {
  CF_ACF_INTERNAL = 0 , CF_ALL_DATA , CF_ANY , CF_DESTROYING ,
  CF_DELEGATED , CF_NO_UNDO
}
 Data model change notification flags. More...
 
enum  SupportedOperations {
  SO_NONE = 0 , SO_OBSERVE = 1 << 0 , SO_COPY = 1 << 1 , SO_CLONE = 1 << 2 ,
  SO_COMPARE = 1 << 3 , SO_RESET = 1 << 4
}
 Flags for supported operations. More...
 
enum  CompatibilityMode { CM_STRICT , CM_WITHOUT_REFS , CM_WITH_REFS , CM_CONVERT }
 Control how relationship betweeen objects are interpreted. More...
 
typedef QMultiMap< QByteArray, QVariant > ChangeInfoMap
 

Public Member Functions

 TMultidimensionalPolynomial ()
 
 TMultidimensionalPolynomial (const Coefficients &coefficients)
 
const CoefficientsGetCoefficients () const
 
void SetCoefficients (const Coefficients &coefficients)
 
bool ApproximateCoefficientsFromFulcrums (const CoeffGridSize &coeffGridSize, const ArgumentType *arguments, const ResultType *destValues, int count)
 
virtual bool GetValueAt (const ArgumentType &argument, ResultType &result) const override
 Get function value for specified argument value.
 
virtual ResultType GetValueAt (const ArgumentType &argument) const override
 Get function value for specified argument value.
 
virtual bool Serialize (iser::IArchive &archive) override
 Load or store state of this object as a archive stream.
 
TMultidimensionalPolynomial< 1, double >::ResultType GetValueAt (const ArgumentType &argument) const
 Get function value for specified argument value.
 
TMultidimensionalPolynomial< 2, double >::ResultType GetValueAt (const ArgumentType &argument) const
 Get function value for specified argument value.
 
TMultidimensionalPolynomial< 3, double >::ResultType GetValueAt (const ArgumentType &argument) const
 Get function value for specified argument value.
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 
- Public Member Functions inherited from iser::ISerializable
virtual quint32 GetMinimalVersion (int versionId) const
 Get minimal needed version to correct storing of this data.
 
- Public Member Functions inherited from istd::IChangeable
virtual int GetSupportedOperations () const
 Get set of flags for supported operations.
 
virtual bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 Copy this object from another one.
 
virtual bool IsEqual (const IChangeable &object) const
 Compare this object with another object.
 
virtual istd::TUniqueInterfacePtr< istd::IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
 Make a copy of this object.
 
virtual bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
 Reset data to its default state.
 
virtual void BeginChanges (const ChangeSet &changeSet)
 Starts the change transaction.
 
virtual void EndChanges (const ChangeSet &changeSet)
 Ends the change transaction.
 
virtual void BeginChangeGroup (const ChangeSet &changeSet)
 Starts group of changes.
 
virtual void EndChangeGroup (const ChangeSet &changeSet)
 Ends group of changes.
 

Static Public Member Functions

static double GetBaseFunctionValue (const ArgumentType &argument, const istd::TIndex< Dimensions > &coeffIndex)
 Get value of base function for single coefficient.
 
- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes.
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set.
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set.
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set.
 

Protected Member Functions

void CumulateRecursiveValueAt (const ArgumentType &argument, int dimension, typename istd::TIndex< Dimensions > &index, ResultType &result) const
 Cumulate interpolated value or derivative at specified recursion level.
 
- Protected Member Functions inherited from istd::IChangeable
virtual void OnBeginChanges ()
 Callback function for begin change event.
 
virtual void OnEndChanges (const ChangeSet &changeSet)
 Callback function for end change event.
 

Detailed Description

template<int Dimensions, class Element = double>
class imath::TMultidimensionalPolynomial< Dimensions, Element >

Multidimensional polynomial function.

Parameters
Dimensionsnumber of dimensions.
Elementtype of result value.

Definition at line 23 of file TMultidimensionalPolynomial.h.

Member Typedef Documentation

◆ BaseClass

template<int Dimensions, class Element = double>
typedef imath::TIMathFunction<TVector<Dimensions>, Element> imath::TMultidimensionalPolynomial< Dimensions, Element >::BaseClass

Definition at line 28 of file TMultidimensionalPolynomial.h.

◆ CoeffGridSize

template<int Dimensions, class Element = double>
typedef Coefficients::SizesType imath::TMultidimensionalPolynomial< Dimensions, Element >::CoeffGridSize

Definition at line 30 of file TMultidimensionalPolynomial.h.

◆ Coefficients

template<int Dimensions, class Element = double>
typedef istd::TArray<Element, Dimensions> imath::TMultidimensionalPolynomial< Dimensions, Element >::Coefficients

Definition at line 29 of file TMultidimensionalPolynomial.h.

Constructor & Destructor Documentation

◆ TMultidimensionalPolynomial() [1/2]

template<int Dimensions, class Element >
imath::TMultidimensionalPolynomial< Dimensions, Element >::TMultidimensionalPolynomial ( )

Definition at line 81 of file TMultidimensionalPolynomial.h.

◆ TMultidimensionalPolynomial() [2/2]

template<int Dimensions, class Element >
imath::TMultidimensionalPolynomial< Dimensions, Element >::TMultidimensionalPolynomial ( const Coefficients coefficients)
explicit

Definition at line 87 of file TMultidimensionalPolynomial.h.

Member Function Documentation

◆ ApproximateCoefficientsFromFulcrums()

template<int Dimensions, class Element >
bool imath::TMultidimensionalPolynomial< Dimensions, Element >::ApproximateCoefficientsFromFulcrums ( const CoeffGridSize coeffGridSize,
const ArgumentType arguments,
const ResultType destValues,
int  count 
)

◆ CumulateRecursiveValueAt()

template<int Dimensions, class Element >
void imath::TMultidimensionalPolynomial< Dimensions, Element >::CumulateRecursiveValueAt ( const ArgumentType argument,
int  dimension,
typename istd::TIndex< Dimensions > &  index,
ResultType result 
) const
protected

Cumulate interpolated value or derivative at specified recursion level.

Parameters
argumentposition, where interpolation should be calculated.
dimensionworking dimension and recursion level.
indexmultidimensional index pointing at coefficient. For the sake of performance it is internal modified.
resultoutput value.

Definition at line 356 of file TMultidimensionalPolynomial.h.

References istd::TIndex< Dimensions >::GetAt().

◆ GetBaseFunctionValue()

template<int Dimensions, class Element >
double imath::TMultidimensionalPolynomial< Dimensions, Element >::GetBaseFunctionValue ( const ArgumentType argument,
const istd::TIndex< Dimensions > &  coeffIndex 
)
static

Get value of base function for single coefficient.

Definition at line 341 of file TMultidimensionalPolynomial.h.

References istd::TIndex< Dimensions >::GetAt().

◆ GetCoefficients()

template<int Dimensions, class Element >
const TMultidimensionalPolynomial< Dimensions, Element >::Coefficients & imath::TMultidimensionalPolynomial< Dimensions, Element >::GetCoefficients ( ) const

Definition at line 94 of file TMultidimensionalPolynomial.h.

◆ GetValueAt() [1/5]

TMultidimensionalPolynomial< 1, double >::ResultType imath::TMultidimensionalPolynomial< 1, double >::GetValueAt ( const ArgumentType argument) const
inlinevirtual

Get function value for specified argument value.

This overloaded menthod is provided only for convinence.

Parameters
argumentfunction argument.
Returns
function value for specified argument.

Implements imath::TIMathFunction< Argument, Result >.

Definition at line 184 of file TMultidimensionalPolynomial.h.

References istd::TIndex< Dimensions >::GetAt().

◆ GetValueAt() [2/5]

TMultidimensionalPolynomial< 2, double >::ResultType imath::TMultidimensionalPolynomial< 2, double >::GetValueAt ( const ArgumentType argument) const
inlinevirtual

Get function value for specified argument value.

This overloaded menthod is provided only for convinence.

Parameters
argumentfunction argument.
Returns
function value for specified argument.

Implements imath::TIMathFunction< Argument, Result >.

Definition at line 202 of file TMultidimensionalPolynomial.h.

References istd::TIndex< Dimensions >::GetAt().

◆ GetValueAt() [3/5]

TMultidimensionalPolynomial< 3, double >::ResultType imath::TMultidimensionalPolynomial< 3, double >::GetValueAt ( const ArgumentType argument) const
inlinevirtual

Get function value for specified argument value.

This overloaded menthod is provided only for convinence.

Parameters
argumentfunction argument.
Returns
function value for specified argument.

Implements imath::TIMathFunction< Argument, Result >.

Definition at line 240 of file TMultidimensionalPolynomial.h.

References istd::TIndex< Dimensions >::GetAt().

◆ GetValueAt() [4/5]

template<int Dimensions, class Element >
TMultidimensionalPolynomial< Dimensions, Element >::ResultType imath::TMultidimensionalPolynomial< Dimensions, Element >::GetValueAt ( const ArgumentType argument) const
overridevirtual

Get function value for specified argument value.

This overloaded menthod is provided only for convinence.

Parameters
argumentfunction argument.
Returns
function value for specified argument.

Implements imath::TIMathFunction< Argument, Result >.

Definition at line 172 of file TMultidimensionalPolynomial.h.

◆ GetValueAt() [5/5]

template<int Dimensions, class Element >
bool imath::TMultidimensionalPolynomial< Dimensions, Element >::GetValueAt ( const ArgumentType argument,
ResultType result 
) const
overridevirtual

Get function value for specified argument value.

Parameters
argumentfunction argument.
resultfunction value for specified argument.
Returns
true if result was correctly calculated.

Implements imath::TIMathFunction< Argument, Result >.

Definition at line 163 of file TMultidimensionalPolynomial.h.

References imath::TMultidimensionalPolynomial< Dimensions, Element >::GetValueAt().

Referenced by imath::TMultidimensionalPolynomial< Dimensions, Element >::GetValueAt().

◆ Serialize()

template<int Dimensions, class Element >
bool imath::TMultidimensionalPolynomial< Dimensions, Element >::Serialize ( iser::IArchive archive)
overridevirtual

Load or store state of this object as a archive stream.

Type of operation is depending on archive type.

See also
iser::IArchive

Implements iser::ISerializable.

Definition at line 293 of file TMultidimensionalPolynomial.h.

References istd::TIndex< Dimensions >::Begin(), iser::IArchive::BeginTag(), iser::IArchive::EndTag(), iser::IArchive::IsStoring(), NULL, iser::IArchive::Process(), and iser::CArchiveTag::TT_GROUP.

◆ SetCoefficients()

template<int Dimensions, class Element >
void imath::TMultidimensionalPolynomial< Dimensions, Element >::SetCoefficients ( const Coefficients coefficients)

Definition at line 101 of file TMultidimensionalPolynomial.h.


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