Public Types | Public Member Functions | List of all members
imath::TISampledFunction< ArgumentDimensions, ResultDimensions > Class Template Referenceabstract

Interface for a resampled function with a regular grid design. More...

#include <TISampledFunction.h>

Inheritance diagram for imath::TISampledFunction< ArgumentDimensions, ResultDimensions >:
imath::TIMathFunction< istd::TIndex< ArgumentDimensions >, TVector< ResultDimensions > > istd::IChangeable istd::IPolymorphic istd::IPolymorphic imath::CSampledFunction2d iimg::CBitmapSurface

Public Types

typedef imath::TIMathFunction
< istd::TIndex
< ArgumentDimensions >
, imath::TVector
< ResultDimensions > > 
BaseClass
 
typedef BaseClass::ArgumentType ArgumentType
 
- Public Types inherited from imath::TIMathFunction< istd::TIndex< ArgumentDimensions >, TVector< ResultDimensions > >
typedef istd::TIndex
< ArgumentDimensions > 
ArgumentType
 
typedef TVector< ResultDimensions > 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...
 

Public Member Functions

virtual bool CreateFunction (double *dataPtr, const ArgumentType &sizes)=0
 Create function from input data. More...
 
virtual int GetTotalSamplesCount () const =0
 Get number of samples stored in this container. More...
 
virtual int GetGridSize (int dimensionIndex) const =0
 Get number of samples for specified dimension. More...
 
virtual istd::CRange GetLogicalRange (int dimensionIndex) const =0
 Get logical grid position range for specified dimension. More...
 
virtual istd::CRange GetResultValueRange (int dimensionIndex, int resultDimension=-1) const =0
 Get range of result value for the given axis. More...
 
virtual int GetArgumentDimensionality () const
 Get the number of argument components. More...
 
virtual int GetResultDimensionality () const
 Get the number of result components. More...
 
- Public Member Functions inherited from imath::TIMathFunction< istd::TIndex< ArgumentDimensions >, TVector< ResultDimensions > >
virtual bool GetValueAt (const istd::TIndex< ArgumentDimensions > &argument, TVector< ResultDimensions > &result) const =0
 Get function value for specified argument value. More...
 
virtual TVector< ResultDimensions > GetValueAt (const istd::TIndex< ArgumentDimensions > &argument) const =0
 Get function value for specified argument value. More...
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 
- Public Member Functions inherited from istd::IChangeable
virtual int GetSupportedOperations () const
 Get set of flags for supported operations. More...
 
virtual bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 Copy this object from another one. More...
 
virtual bool IsEqual (const IChangeable &object) const
 Compare this object with another object. More...
 
virtual IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
 Make a copy of this object. More...
 
virtual bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
 Reset data to its default state. More...
 
virtual void BeginChanges (const ChangeSet &changeSet)
 Starts the change transaction. More...
 
virtual void EndChanges (const ChangeSet &changeSet)
 Ends the change transaction. More...
 
virtual void BeginChangeGroup (const ChangeSet &changeSet)
 Starts group of changes. More...
 
virtual void EndChangeGroup (const ChangeSet &changeSet)
 Ends group of changes. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes. More...
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set. More...
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set. More...
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set. More...
 
- Protected Member Functions inherited from istd::IChangeable
virtual void OnBeginChanges ()
 Callback function for begin change event. More...
 
virtual void OnEndChanges (const ChangeSet &changeSet)
 Callback function for end change event. More...
 

Detailed Description

template<int ArgumentDimensions, int ResultDimensions>
class imath::TISampledFunction< ArgumentDimensions, ResultDimensions >

Interface for a resampled function with a regular grid design.

Definition at line 20 of file TISampledFunction.h.

Member Typedef Documentation

template<int ArgumentDimensions, int ResultDimensions>
typedef BaseClass::ArgumentType imath::TISampledFunction< ArgumentDimensions, ResultDimensions >::ArgumentType

Definition at line 30 of file TISampledFunction.h.

template<int ArgumentDimensions, int ResultDimensions>
typedef imath::TIMathFunction< istd::TIndex<ArgumentDimensions>, imath::TVector<ResultDimensions> > imath::TISampledFunction< ArgumentDimensions, ResultDimensions >::BaseClass

Definition at line 29 of file TISampledFunction.h.

Member Function Documentation

template<int ArgumentDimensions, int ResultDimensions>
virtual bool imath::TISampledFunction< ArgumentDimensions, ResultDimensions >::CreateFunction ( double *  dataPtr,
const ArgumentType sizes 
)
pure virtual

Create function from input data.

Implemented in imath::CSampledFunction2d.

template<int ArgumentDimensions, int ResultDimensions>
int imath::TISampledFunction< ArgumentDimensions, ResultDimensions >::GetArgumentDimensionality ( ) const
inlinevirtual

Get the number of argument components.

Definition at line 75 of file TISampledFunction.h.

template<int ArgumentDimensions, int ResultDimensions>
virtual int imath::TISampledFunction< ArgumentDimensions, ResultDimensions >::GetGridSize ( int  dimensionIndex) const
pure virtual

Get number of samples for specified dimension.

Implemented in imath::CSampledFunction2d.

template<int ArgumentDimensions, int ResultDimensions>
virtual istd::CRange imath::TISampledFunction< ArgumentDimensions, ResultDimensions >::GetLogicalRange ( int  dimensionIndex) const
pure virtual

Get logical grid position range for specified dimension.

Logical position describes

Implemented in imath::CSampledFunction2d.

template<int ArgumentDimensions, int ResultDimensions>
int imath::TISampledFunction< ArgumentDimensions, ResultDimensions >::GetResultDimensionality ( ) const
inlinevirtual

Get the number of result components.

Definition at line 82 of file TISampledFunction.h.

template<int ArgumentDimensions, int ResultDimensions>
virtual istd::CRange imath::TISampledFunction< ArgumentDimensions, ResultDimensions >::GetResultValueRange ( int  dimensionIndex,
int  resultDimension = -1 
) const
pure virtual

Get range of result value for the given axis.

Optionally some result dimension can be also specified.

Parameters
dimensionIndexindex of argument dimension.
resultDimensionoptional index of result dimension, it can be negative if all dimensions are meaned.
Returns
range of possible values, or invalid range if it is unknown.

Implemented in imath::CSampledFunction2d.

template<int ArgumentDimensions, int ResultDimensions>
virtual int imath::TISampledFunction< ArgumentDimensions, ResultDimensions >::GetTotalSamplesCount ( ) const
pure virtual

Get number of samples stored in this container.

Implemented in imath::CSampledFunction2d.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy