USGS Astrogeology Isis API

This is a derived class from Basis1VariableFunction which provides the capabilities of a polynomial equation in one variable with degree n, where n is specified during the object construction. For example, Degree = 1 z = a + b*x Degree = 2 z = a + b*x + c*x**2 Degree = 3 z = a + b*x + c*x**2 + d*x**3 In general the number of coefficients will be degree + 1.

Definition at line 52 of file PolynomialUnivariate.h.


Public Member Functions
	PolynomialUnivariate (int degree)
	Create a PolynomialUnivariate object.
	~PolynomialUnivariate ()
	Destroys the PolynomialUnivariate object.
void	Expand (const std::vector< double > &vars)
	This is the the overriding virtual function that provides the expansion of the two input variables into the polynomial equation.
double	DerivativeVar (const double value)
	This will take the Derivative with respect to the variable and evaluate at given value.
double	DerivativeCoef (const double value, const int coefIndex)
	Evaluate the derivative of the polynomial defined by the given coefficients with respect to the coefficient at the given index, at the current value.
void	SetCoefficients (const std::vector< double > &coefs)
	Set the coefficients for the equation.
double	Evaluate (const std::vector< double > &vars)
	Compute the equation using the input variables.
int	Coefficients () const
	Returns the number of coefficients for the equation.
int	Variables () const
	Returns the number of variables in the equation.
std::string	Name () const
	Returns the name of the equation.
double	Term (int c) const
	Returns the cth term.
double	Coefficient (int i) const
	Returns the ith coefficient.
Protected Attributes
std::string	p_name
	The name of the equation. Call it by using Name().
int	p_numVars
	The number of variables in the equation. Call it by using Variables().
int	p_numCoefs
	The number of coefficients in the equation.
std::vector< double >	p_coefs
	A vector of the coefficients in the equation.
std::vector< double >	p_terms
	A vector of the terms in the equation.
Private Attributes
int	p_degree
	The order/degree of the polynomial.

Constructor & Destructor Documentation

Isis::PolynomialUnivariate::PolynomialUnivariate ( int degree )

Create a PolynomialUnivariate object.

Parameters:

degree

The order/degree of the polynomial

Definition at line 37 of file PolynomialUnivariate.cpp.

References p_degree.

Isis::PolynomialUnivariate::~PolynomialUnivariate ( ) [inline]

Destroys the PolynomialUnivariate object.

Definition at line 57 of file PolynomialUnivariate.h.

Member Function Documentation

double Isis::BasisFunction::Coefficient ( int i ) const [inline, inherited]

Returns the ith coefficient.

Parameters:

The index for the desired coefficient.

Returns:: The ith coefficient

Definition at line 109 of file BasisFunction.h.

Referenced by DerivativeVar(), Isis::SurfaceModel::MinMax(), Isis::AutoReg::ModelSurface(), Isis::SpicePosition::ReloadCache(), Isis::SpicePosition::SetPolynomial(), Isis::OverlapNormalization::Solve(), Isis::Affine::Solve(), and Isis::BundleAdjust::Update().

int Isis::BasisFunction::Coefficients ( ) const [inline, inherited]

Returns the number of coefficients for the equation.

Returns:: The number of coefficients.

Definition at line 74 of file BasisFunction.h.

References Isis::BasisFunction::p_numCoefs.

Referenced by DerivativeCoef(), DerivativeVar(), Isis::SpicePosition::SetPolynomial(), Isis::OverlapNormalization::Solve(), Isis::LeastSquares::SolveQRD(), and Isis::LeastSquares::SolveSVD().

double Isis::PolynomialUnivariate::DerivativeCoef	(	const double	value,
		const int	coefIndex
	)			`[virtual]`

Evaluate the derivative of the polynomial defined by the given coefficients with respect to the coefficient at the given index, at the current value.

Parameters:

`[in]`	value	(const double) value at which to evaluate derivative
`[in]`	coefIndex	(const int) The index of the coefficient to differentiate with respect to

Returns:: (double) The derivative evaluated at given value

Implements Isis::Basis1VariableFunction.

Definition at line 91 of file PolynomialUnivariate.cpp.

References _FILEINFO_, Isis::BasisFunction::Coefficients(), and Isis::iException::Message().

double Isis::PolynomialUnivariate::DerivativeVar ( const double value ) [virtual]

This will take the Derivative with respect to the variable and evaluate at given value.

Parameters:

[in] value (const double) value at which to evaluate derivative

History:: 2008-01-09 Tracie Sucharski, Original Version

Implements Isis::Basis1VariableFunction.

Definition at line 68 of file PolynomialUnivariate.cpp.

References Isis::BasisFunction::Coefficient(), and Isis::BasisFunction::Coefficients().

double Isis::BasisFunction::Evaluate ( const std::vector< double > & vars ) [inherited]

Compute the equation using the input variables.

Parameters:

vars

A vector of double values to use for the equation. After setting the coefficients, this can be invoked many times to compute output values given input values.