ossimTerm Class Reference

An abstract class to containing a multivariable function. More...

#include <ossimTerm.h>

Inheritance diagram for ossimTerm:

Public Member Functions
virtual	~ossimTerm ()
	Virtual destructor for destroying tree from the top node. More...
virtual ossim_float64	evaluate (std::vector< ossim_float64 >) const =0
	Evaluates a term at a given point PURE VIRTUAL. More...
virtual ossimTerm *	derivative (const ossim_uint32 &variable) const =0
	Calculates the derivative of the term. More...
virtual ossim_uint32	getType () const =0
	Gets the type. More...
virtual ossimTerm *	copy () const =0
	Returns a pointer to a copy of the term. More...
ossim_float64	operator() (std::vector< ossim_float64 > point) const
	Evaluates the function for a point. More...
ossimTerm *	operator+ (ossimTerm *rhs) const
	Returns a copy of the two terms in a polynomial. More...
ossimTerm *	operator* (ossimTerm *rhs) const
	Returns a copy of the two terms in a product. More...

Detailed Description

An abstract class to containing a multivariable function.

Definition at line 35 of file ossimTerm.h.

Constructor & Destructor Documentation

~ossimTerm()

virtual ossimTerm::~ossimTerm ( )

inlinevirtual

Virtual destructor for destroying tree from the top node.

Definition at line 43 of file ossimTerm.h.

{}

Member Function Documentation

copy()

virtual ossimTerm* ossimTerm::copy ( ) const

pure virtual

Returns a pointer to a copy of the term.

Returns

A pointer to a copy of the term

Implemented in ossimConst, ossimVar, ossimProd, ossimPolynomial, and ossimMonom.

Referenced by ossimMonom::copy(), ossimPolynomial::copy(), ossimProd::copy(), ossimProd::derivative(), operator*(), and operator+().

derivative()

virtual ossimTerm* ossimTerm::derivative ( const ossim_uint32 &  variable ) const

pure virtual

Calculates the derivative of the term.

Parameters

[in]

variable

The variable in which the derivative is with respect too

Returns

A pointer containing the derivative of the term.

Implemented in ossimConst, ossimVar, ossimProd, ossimPolynomial, and ossimMonom.

Referenced by ossimMonom::derivative(), ossimPolynomial::derivative(), ossimProd::derivative(), and ossimGDoptimizer::optimize().

evaluate()

virtual ossim_float64 ossimTerm::evaluate ( std::vector< ossim_float64 >  ) const

pure virtual

Evaluates a term at a given point PURE VIRTUAL.

Parameters

[in]

point

The point to be evaluated

Returns

the value at a point

Implemented in ossimConst, ossimVar, ossimProd, ossimPolynomial, and ossimMonom.

getType()

virtual ossim_uint32 ossimTerm::getType ( ) const

pure virtual

Gets the type.

Returns

The type

Implemented in ossimConst, ossimVar, ossimProd, ossimPolynomial, and ossimMonom.

operator()()

ossim_float64 ossimTerm::operator() ( std::vector< ossim_float64 >  point ) const

inline

Evaluates the function for a point.

Parameters

point

The point at which the function is being evaluated

Returns

The value at a point

Definition at line 85 of file ossimTerm.h.

{ return this->evaluate(point); }

operator*()

ossimTerm * ossimTerm::operator* ( ossimTerm *  rhs ) const

inline

Returns a copy of the two terms in a product.

Parameters

rhs	The right hand term of the product

Returns

A product with !COPIES! of the two terms

Definition at line 37 of file ossimTerm.cpp.

References copy().

                                                          {
    return new ossimProd(this->copy(), rhs->copy());
}

operator+()

ossimTerm * ossimTerm::operator+ ( ossimTerm *  rhs ) const

inline

Returns a copy of the two terms in a polynomial.

Mathematical term data structure for ossim.

Parameters

rhs	The right hand term of the polynomial

Returns

A polynomial with !COPIES! of the two terms

Author

Dylan Thomas Cannisi

Date

07/24/2017

   See top level LICENSE.txt file.

OSSIM TERM Returns a copy of the two terms in a polynomial

Parameters

rhs	The right hand term of the polynomial

Returns

A polynomial with !COPIES! of the two terms

Definition at line 27 of file ossimTerm.cpp.

References copy().

                                                          {
    return new ossimPolynomial(this->copy(), rhs->copy());
}

---

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

• ossimTerm.h
• ossimTerm.cpp