SurgSim::Math::Polynomial< T, 1 > Class Template Reference

Polynomial<T, 1> specializes the Polynomial class for degree 1 (linear polynomials) More...

#include <Polynomial.h>

Public Member Functions
	Polynomial ()
	Constructor.
	Polynomial (const T &a0, const T &a1)
	Constructor. More...
T	evaluate (const T &x) const
	Evaluate the polynomial at a point. More...
T	operator() (const T &x) const
	Evaluate the polynomial at a point. More...
Polynomial< T, 0 >	derivative () const
bool	isNearZero (const T &epsilon=static_cast< T >(polynomial_epsilon)) const
bool	isApprox (const Polynomial< T, 1 > &p, const T &epsilon) const
T	getCoefficient (size_t i) const
void	setCoefficient (size_t i, const T &value)
	Set a specified coefficient to a desired value. More...
T &	operator[] (const size_t i)
const T &	operator[] (const size_t i) const
Polynomial< T, 1 >	operator- () const
Polynomial< T, 1 >	operator+ (const Polynomial< T, 1 > &rhs) const
Polynomial< T, 1 > &	operator+= (const Polynomial< T, 1 > &rhs)
Polynomial< T, 1 >	operator- (const Polynomial< T, 1 > &rhs) const
Polynomial< T, 1 > &	operator-= (const Polynomial< T, 1 > &rhs)

Detailed Description

template<typename T>
class SurgSim::Math::Polynomial< T, 1 >

Polynomial<T, 1> specializes the Polynomial class for degree 1 (linear polynomials)

See also

Polynomial<T, N>

Constructor & Destructor Documentation

Polynomial()

template<class T >

SurgSim::Math::Polynomial< T, 1 >::Polynomial	(	const T &	a0,
		const T &	a1
	)

Constructor.

Parameters

a0	coefficient of the 0 degree term
a1	coefficient of the 1 degree term

Member Function Documentation

derivative()

template<class T >

Polynomial< T, 0 > SurgSim::Math::Polynomial< T, 1 >::derivative

(

)

const

Returns

the derivative of the polynomial

evaluate()

template<class T >

T SurgSim::Math::Polynomial< T, 1 >::evaluate

(

const T &

x

)

const

Evaluate the polynomial at a point.

Parameters

x	point at which to evaluate the polynomial

Returns

the value of the polynomial at x

getCoefficient()

template<class T >

T SurgSim::Math::Polynomial< T, 1 >::getCoefficient

(

size_t

i

)

const

Parameters

i	index of the desired coefficient

Returns

the value of coefficient i

isApprox()

template<class T >

bool SurgSim::Math::Polynomial< T, 1 >::isApprox	(	const Polynomial< T, 1 > &	p,
		const T &	epsilon
	)		const

Parameters

p	the test polynomial
epsilon	the closeness parameter

Returns

true if all the coefficients of the current polynomial are within an epsilon of the corresponding coefficient in p

isNearZero()

template<class T >

bool SurgSim::Math::Polynomial< T, 1 >::isNearZero

(

const T &

epsilon = static_cast<T>(polynomial_epsilon)

)

const

Parameters

epsilon

the closeness parameter

Returns

true if all coefficients of the polynomial are within an epsilon of 0

operator()()

template<class T >

T SurgSim::Math::Polynomial< T, 1 >::operator()

(

const T &

x

)

const

Evaluate the polynomial at a point.

Parameters

x	point at which to evaluate the polynomial

Returns

the value of the polynomial at x

operator[]()

template<class T >

T & SurgSim::Math::Polynomial< T, 1 >::operator[]

(

const size_t

i

)

Standard arithmetic operators extended to intervals

setCoefficient()

template<class T >

void SurgSim::Math::Polynomial< T, 1 >::setCoefficient	(	size_t	i,
		const T &	value
	)

Set a specified coefficient to a desired value.

Parameters

i	index of the desired coefficient
value	the value to be set in the coefficient

Exceptions

if	i is greater than the polynomial degree

---

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

• SurgSim/Math/Polynomial.h
• SurgSim/Math/Polynomial-inl.h