IntegrableNumber Class Template Reference

#include <C:/Work/specialnumbers_svn/NumberLib/NumbersLib/IntegrableNumber.h>

Inheritance diagram for IntegrableNumber:

List of all members.

Detailed Description

template<class T, unsigned int sampleCount, unsigned int maxOrder>
class luma::numbers::IntegrableNumber< T, sampleCount, maxOrder >

An integral number is a number that keeps track of itw own integrals.

$y_n = \Sigma x_n = \frac{\sum_{i= n - m + 1}^n x_{n}t_{n}}{\sum_{i = n - m + 1}^nt_n}$

This class complements the DifferentiableNumber class.

Parameters:

	T	The type that underlies this IntegrableNumber. Typically float.
	m	The number of samples to store
	n	The order of the integrable

Definition at line 29 of file IntegrableNumber.h.


Public Member Functions
void	forceValue (T x, float elapsedTime=1.0f)
	Forces this integrable number into a long term srteady state.
T	getSample (int i) const
	This returns the nth sample stored.
T	getValue (unsigned int order) const
	Returns the integral of order specified for this IntegrableNumber.
	IntegrableNumber (T initialValue)
void	setValue (T x, float elapsedTime=1.0f)
	Sets the value of this IntegrableNumber, and recalculates all integrals.
Private Attributes
CyclicNumber< int >	mCurrentIndex
T	mCurrentValue
T	mInitialValue
T	mSamples [sampleCount]
IntegrableNumber< T, sampleCount, maxOrder-1 >	mSum
float	mTimeSamples [sampleCount]
float	mTotalTime

Constructor & Destructor Documentation

IntegrableNumber ( T initialValue ) [inline]

Parameters:

initialValue

zero of type T, returned by all calls of getValue that this number cannot calculate.

Definition at line 87 of file IntegrableNumber.h.

References IntegrableNumber::mSamples, and IntegrableNumber::mTimeSamples.

Member Function Documentation

void forceValue	(	T	x,
		float	elapsedTime = `1.0f`
	)			`[inline]`

Forces this integrable number into a long term srteady state.

The alpsed time is the time elapsed between samples. For example, if this integrable number (with say, 10 samples) is forced to a value of 10, with elapsed time of 1.0f, then the sum would be 100. If the elapsed time is 3, then the sum would be 300.

Definition at line 122 of file IntegrableNumber.h.

References IntegrableNumber::mCurrentValue, IntegrableNumber::mInitialValue, IntegrableNumber::mSamples, IntegrableNumber::mSum, and IntegrableNumber::mTotalTime.

Referenced by PIDBufferedNumber::forceValue().

T getSample ( int i ) const [inline]

This returns the nth sample stored.

Note that sample[0] is not necesarily the oldest sample. This method is used for testing, and should not be generally not be used in production code.

Definition at line 163 of file IntegrableNumber.h.

References IntegrableNumber::mSamples.

Referenced by PIDBufferedNumber::getSample().

T getValue ( unsigned int order ) const [inline, virtual]

Returns the integral of order specified for this IntegrableNumber.

Parameters: