OpenSim::VectorFunction Class Reference

#include <VectorFunction.h>

Inheritance diagram for OpenSim::VectorFunction:
OpenSim::Object OpenSim::VectorFunctionUncoupledNxN OpenSim::VectorGCVSplineR1R3 OpenSim::ExampleVectorFunctionUncoupledNxN OpenSim::VectorFunctionForActuators

List of all members.

Public Member Functions

 VectorFunction ()
 Default constructor.
 VectorFunction (int aNX, int aNY)
 Default constructor.
 VectorFunction (const VectorFunction &aVectorFunction)
 Copy constructor.
virtual ~VectorFunction ()
 Destructor.
virtual Objectcopy () const =0
 Construct and return a copy of this object.
VectorFunctionoperator= (const VectorFunction &aVectorFunction)
 Assignment operator.
int getNX () const
 Get the number of independent variables.
int getNY () const
 Get the number of dependent variables.
void setMinX (const Array< double > &aMinX)
 Set the minimum values of the independent variables.
const Array< double > & getMinX () const
 Get the minimum values of the independent variables.
void setMinX (int aXIndex, double aMinX)
 Set the minimum value of one of the independent variables.
double getMinX (int aXIndex) const
 Get the minimum values of the independent variables.
void setMaxX (const Array< double > &aMaxX)
 Set the maximum values of the independent variables.
const Array< double > & getMaxX () const
 Get the maximum values of the independent variables.
void setMaxX (int aXIndex, double aMaxX)
 Set the maximum value of one of the independent variables.
double getMaxX (int aXIndex) const
 Get the maximum values of the independent variables.
virtual void updateBoundingBox ()
 Update the bounding box for the abscissae.
virtual void calcValue (const double *aX, double *rY, int aSize)=0
virtual void calcValue (const Array< double > &aX, Array< double > &rY)=0
virtual void calcDerivative (const Array< double > &aX, Array< double > &rY, const Array< int > &aDerivWRT)=0

Protected Attributes

int _nX
 Number of independent variables.
int _nY
 Number of dependant variables.
Array< double > _minX
 Array containing minimum allowed values of the independent variables.
Array< double > _maxX
 Array containing maximum allowed values of the independent variables.

Constructor & Destructor Documentation

VectorFunction::VectorFunction (  ) 

Default constructor.

VectorFunction::VectorFunction ( int  aNX,
int  aNY 
)

Default constructor.

VectorFunction::VectorFunction ( const VectorFunction aVectorFunction  ) 

Copy constructor.

Parameters:
aVectorFunction Function to copy.
VectorFunction::~VectorFunction (  )  [virtual]

Destructor.


Member Function Documentation

virtual void OpenSim::VectorFunction::calcDerivative ( const Array< double > &  aX,
Array< double > &  rY,
const Array< int > &  aDerivWRT 
) [pure virtual]
virtual void OpenSim::VectorFunction::calcValue ( const Array< double > &  aX,
Array< double > &  rY 
) [pure virtual]
virtual void OpenSim::VectorFunction::calcValue ( const double *  aX,
double *  rY,
int  aSize 
) [pure virtual]
virtual Object* OpenSim::VectorFunction::copy (  )  const [pure virtual]

Construct and return a copy of this object.

The object is allocated using the new operator, so the caller is responsible for deleting the returned object.

Returns:
Copy of this object.

Reimplemented from OpenSim::Object.

Implemented in OpenSim::ExampleVectorFunctionUncoupledNxN, OpenSim::VectorFunctionUncoupledNxN, OpenSim::VectorGCVSplineR1R3, and OpenSim::VectorFunctionForActuators.

double VectorFunction::getMaxX ( int  aXIndex  )  const

Get the maximum values of the independent variables.

Parameters:
aX Index of the independent variable value to be set.
Returns:
Array of maximum values of the independent variables.
const Array< double > & VectorFunction::getMaxX (  )  const

Get the maximum values of the independent variables.

Returns:
Array of maximum values of the independent variables.
double VectorFunction::getMinX ( int  aXIndex  )  const

Get the minimum values of the independent variables.

Parameters:
aXIndex Index of the independent variable value to be set.
Returns:
Array of minimum values of the independent variables.
const Array< double > & VectorFunction::getMinX (  )  const

Get the minimum values of the independent variables.

Returns:
Array of minimum values of the independent variables.
int VectorFunction::getNX (  )  const

Get the number of independent variables.

Returns:
Number of independent variables.
int VectorFunction::getNY (  )  const

Get the number of dependent variables.

Returns:
Number of dependent variables.
VectorFunction & VectorFunction::operator= ( const VectorFunction aVectorFunction  ) 

Assignment operator.

Returns:
Reference to this object.

Reimplemented from OpenSim::Object.

Reimplemented in OpenSim::ExampleVectorFunctionUncoupledNxN, OpenSim::VectorFunctionUncoupledNxN, OpenSim::VectorGCVSplineR1R3, and OpenSim::VectorFunctionForActuators.

void VectorFunction::setMaxX ( int  aXIndex,
double  aMaxX 
)

Set the maximum value of one of the independent variables.

Parameters:
aX Index of the independent variable value to be set.
aMaxX Value of the independent variable specified by aX.
void VectorFunction::setMaxX ( const Array< double > &  aMaxX  ) 

Set the maximum values of the independent variables.

Parameters:
aMaxX Array of maximum values of the independent variables.
void VectorFunction::setMinX ( int  aXIndex,
double  aMinX 
)

Set the minimum value of one of the independent variables.

Parameters:
aXIndex Index of the independent variable value to be set.
aMinX Value of the independent variable specified by aX.
void VectorFunction::setMinX ( const Array< double > &  aMinX  ) 

Set the minimum values of the independent variables.

Parameters:
aMinX Array of minimum values of the independent variables.
void VectorFunction::updateBoundingBox (  )  [virtual]

Update the bounding box for the abscissae.

This method should be overrided as needed by derived classes.

Reimplemented in OpenSim::VectorGCVSplineR1R3.


Member Data Documentation

Array containing maximum allowed values of the independent variables.

Array containing minimum allowed values of the independent variables.

Number of independent variables.

Number of dependant variables.


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

Generated on Wed Dec 16 15:03:42 2009 for OpenSim by  doxygen 1.6.1