OpenMM
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Continuous1DFunction Class Reference

This is a TabulatedFunction that computes a continuous one dimensional function. More...

#include <TabulatedFunction.h>

+ Inheritance diagram for Continuous1DFunction:

Public Member Functions

 Continuous1DFunction (const std::vector< double > &values, double min, double max)
 Create a Continuous1DFunction f(x) based on a set of tabulated values. More...
 
void getFunctionParameters (std::vector< double > &values, double &min, double &max) const
 Get the parameters for the tabulated function. More...
 
void setFunctionParameters (const std::vector< double > &values, double min, double max)
 Set the parameters for the tabulated function. More...
 
Continuous1DFunctionCopy () const
 Create a deep copy of the tabulated function. More...
 
- Public Member Functions inherited from TabulatedFunction
virtual ~TabulatedFunction ()
 

Detailed Description

This is a TabulatedFunction that computes a continuous one dimensional function.

Constructor & Destructor Documentation

Continuous1DFunction ( const std::vector< double > &  values,
double  min,
double  max 
)

Create a Continuous1DFunction f(x) based on a set of tabulated values.

Parameters
valuesthe tabulated values of the function f(x) at uniformly spaced values of x between min and max. A natural cubic spline is used to interpolate between the tabulated values. The function is assumed to be zero for x < min or x > max.
minthe value of x corresponding to the first element of values
maxthe value of x corresponding to the last element of values

Member Function Documentation

Continuous1DFunction* Copy ( ) const
virtual

Create a deep copy of the tabulated function.

Implements TabulatedFunction.

void getFunctionParameters ( std::vector< double > &  values,
double &  min,
double &  max 
) const

Get the parameters for the tabulated function.

Parameters
valuesthe tabulated values of the function f(x) at uniformly spaced values of x between min and max. A natural cubic spline is used to interpolate between the tabulated values. The function is assumed to be zero for x < min or x > max.
minthe value of x corresponding to the first element of values
maxthe value of x corresponding to the last element of values
void setFunctionParameters ( const std::vector< double > &  values,
double  min,
double  max 
)

Set the parameters for the tabulated function.

Parameters
valuesthe tabulated values of the function f(x) at uniformly spaced values of x between min and max. A natural cubic spline is used to interpolate between the tabulated values. The function is assumed to be zero for x < min or x > max.
minthe value of x corresponding to the first element of values
maxthe value of x corresponding to the last element of values

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