Main Page Modules Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Related Pages

OSCAR::Diff Class Reference
[Math]

A class for numerically computing derivatives. More...

#include <Diff.h>

Inheritance diagram for OSCAR::Diff:

[legend]List of all members.


Public Methods
	Diff (std::vector< Vector > function)
	Diff (std::vector< double > function)
	Diff (const Diff &derivative)
Diff &	operator= (const Diff &rhs)
virtual	~Diff ()
bool	TakeDerivative (double timeStep)
bool	TakeSecondDerivative (double timeStep)
bool	GetDerivative (std::vector< Vector > &derivative)
bool	GetDerivative (std::vector< double > &derivative)
bool	GetSecondDerivative (std::vector< Vector > &secondDerivative)
bool	GetSecondDerivative (std::vector< double > &secondDerivative)
Protected Attributes
double	step
std::vector< Vector >	xMatrix
std::vector< double >	xVector
std::vector< Vector >	xMatrixPrime
std::vector< double >	xVectorPrime
std::vector< Vector >	xMatrixDoublePrime
std::vector< double >	xVectorDoublePrime

Detailed Description

Author:: Jeremy Sevier

Constructor & Destructor Documentation

OSCAR::Diff::Diff ( std::vector< Vector > function )

Constructor.

Parameters:

function is a vector trajectory to differentiate

See also:
Diff(std::vector<double> function)

OSCAR::Diff::Diff ( std::vector< double > function )

Constructor.

Parameters:

function is a trajectory to differentiate

See also:
Diff(std::vector<Vector> function)

OSCAR::Diff::Diff ( const Diff & derivative )

Copy Constructor.

Parameters:

derivative is a Diff object to copy from

virtual OSCAR::Diff::~Diff ( ) [virtual]

Destructor.

Member Function Documentation

bool OSCAR::Diff::GetDerivative ( std::vector< double > & derivative )

used to retrieve the derivative of the trajectory.

Parameters:

derivative is the derivative of the trajectory

Returns:
true if the derivative was taken before this method was called

Exceptions:

invalidArraySize invalidArraySize

bool OSCAR::Diff::GetDerivative ( std::vector< Vector > & derivative )

used to retrieve the derivative of the trajectory.

Parameters:

derivative is the derivative of the trajectory

Returns:
true if the derivative was taken before this method was called

Exceptions:

invalidArraySize invalidArraySize

bool OSCAR::Diff::GetSecondDerivative ( std::vector< double > & secondDerivative )

used to retrieve the second derivative of the trajectory.

Parameters:

derivative is the derivative of the trajectory

Returns:
true if the derivative was taken before this method was called

Exceptions:

invalidArraySize invalidArraySize

bool OSCAR::Diff::GetSecondDerivative ( std::vector< Vector > & secondDerivative )

used to retrieve the second derivative of the trajectory.

Parameters:

derivative is the derivative of the trajectory

Returns:
true if the derivative was taken before this method was called

Exceptions:

invalidArraySize invalidArraySize

Diff& OSCAR::Diff::operator= ( const Diff & rhs )

equals operator overload

bool OSCAR::Diff::TakeDerivative ( double timeStep )

used to take derivatives of the trajectory.

Parameters:

timestep is the step size between derivative steps

Returns:
true if the timestep is greater than zero

Exceptions:

invalidValue invalidValue

bool OSCAR::Diff::TakeSecondDerivative ( double timeStep )

used to take second derivatives of the trajectory.

Parameters:

timestep is the step size between derivative steps

Returns:
true if the timestep is greater than zero

Exceptions:

invalidValue invalidValue