OMK::Type::PolatorNT Class Reference

Base class for a polator. More...

#include <OMKPolatorNT.h>

Inheritance diagram for OMK::Type::PolatorNT:

[legend]Collaboration diagram for OMK::Type::PolatorNT:

[legend]List of all members.

Public Types
enum	PrecisionLevels {   Constant,   Linear,   Quadratic,   Cubic,   ConstantContinuous,   LinearContinuous,   QuadraticContinuous,   CubicContinuous }
	Enumerate identifiers for the first levels of precision. More...
Public Member Functions
	PolatorNT (int numberOfNeededValuesForMaxPrecisionPolation)
	Contructor.
virtual	~PolatorNT ()
	Destructor.
virtual int	getNumberOfNeededValuesForMaxPrecisionPolation () const
	Returns number of needed values for a maximum precision polation.
Static Public Attributes
static int	defaultPrecisionLevel
	The default precision level for all polators created.
Protected Attributes
int	_numberOfNeededValuesForMaxPrecisionPolation
	Number of values needed to be able to use this polator at its maximum precision level.

---

Detailed Description

Base class for a polator.

A polator is an object capable of extrapolation, interpolation and antepolation, and this at different precision levels.

Author:

Olivier Filangi

Version:

1.0 1.0 -> 1.1 (by David Margery) : added default precision level

Definition at line 38 of file OMKPolatorNT.h.

---

Member Enumeration Documentation

enum OMK::Type::PolatorNT::PrecisionLevels

Enumerate identifiers for the first levels of precision.

Enumerator:

Constant	Constant.
Linear	Linear.
Quadratic	Quadratic.
Cubic	Cubic.
ConstantContinuous	Continous on extrapolation but precision-less.
LinearContinuous	Continous on extrapolation but precision-less.
QuadraticContinuous	Continous on extrapolation but precision-less.
CubicContinuous	Continous on extrapolation but precision-less.

Definition at line 60 of file OMKPolatorNT.h.

  {
    Constant,             
    Linear,               
    Quadratic,            
    Cubic,                
    ConstantContinuous,   
    LinearContinuous,     
    QuadraticContinuous,  
    CubicContinuous       
  };

---

Constructor & Destructor Documentation

PolatorNT::PolatorNT

(

int

numberOfNeededValuesForMaxPrecisionPolation

)

Contructor.

Parameters:

numberOfNeededValuesForMaxPrecisionPolation

length of the history file needed to be able to use this polator at its maximum precision level.

Definition at line 29 of file OMKPolatorNT.cpp.

  : _numberOfNeededValuesForMaxPrecisionPolation ( numberOfNeededValuesForMaxPrecisionPolation )
{
}

PolatorNT::~PolatorNT

(

)

[virtual]

Destructor.

Definition at line 34 of file OMKPolatorNT.cpp.

{
}

---

Member Function Documentation

int PolatorNT::getNumberOfNeededValuesForMaxPrecisionPolation

(

)

const [virtual]

Returns number of needed values for a maximum precision polation.

Definition at line 38 of file OMKPolatorNT.cpp.

References _numberOfNeededValuesForMaxPrecisionPolation.

{
  return _numberOfNeededValuesForMaxPrecisionPolation ; 
}

---

Member Data Documentation

int PolatorNT::defaultPrecisionLevel [static]

The default precision level for all polators created.

It is set to Constant by default. You can change it in the configuration by setting the value of the parameter defaultPolatorPrecisionLevel in the controller UserParams.

Definition at line 57 of file OMKPolatorNT.h.

Referenced by OMK::Controller::Controller().

int OMK::Type::PolatorNT::_numberOfNeededValuesForMaxPrecisionPolation [protected]

Number of values needed to be able to use this polator at its maximum precision level.

Definition at line 75 of file OMKPolatorNT.h.

Referenced by getNumberOfNeededValuesForMaxPrecisionPolation().

---