cisst-saw
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | List of all members
nmrSingleVariablePowerBasis Class Reference

#include <nmrSingleVariablePowerBasis.h>

Public Types

typedef double VariableType
 
typedef
nmrPolynomialTermPowerIndex::PowerType 		PowerType
 

Public Member Functions

 nmrSingleVariablePowerBasis (PowerType degree)
 
void Initialize (PowerType degree)
 
PowerType GetDegree () const
 
VariableType GetVariable () const
 
VariableType GetVariablePower (PowerType power) const
 
VariableType operator[] (PowerType power) const
 
void SetVariable (VariableType variable)
 

Detailed Description

Stores the power basis for a single variable. A nmrSingleVariablePowerBasis is initialized with the maximal degree for which the variable is raised. Call SetVariable() to set the variable and calculate the sequence of powers.

Member Typedef Documentation

typedef nmrPolynomialTermPowerIndex::PowerType nmrSingleVariablePowerBasis::PowerType
typedef double nmrSingleVariablePowerBasis::VariableType

Constructor & Destructor Documentation

nmrSingleVariablePowerBasis::nmrSingleVariablePowerBasis ( PowerType  degree)
inline

Member Function Documentation

PowerType nmrSingleVariablePowerBasis::GetDegree ( ) const
inline

Return the maximal degree of the variable in this power sequence

VariableType nmrSingleVariablePowerBasis::GetVariable ( ) const
inline

Return the current value of the variable.

VariableType nmrSingleVariablePowerBasis::GetVariablePower ( PowerType  power) const
inline

Return a pre-computed power of the variable (assert limits)

void nmrSingleVariablePowerBasis::Initialize ( PowerType  degree)
inline

This function initializes the variable to zero and the degree to the given value. It is to be called during events such as serialization.

VariableType nmrSingleVariablePowerBasis::operator[] ( PowerType  power) const
inline

Return a pre-computed power of the variable

void nmrSingleVariablePowerBasis::SetVariable ( VariableType  variable)

Set the value of the variable and the rest of the power sequence

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.6