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

This is a TabulatedFunction that computes a discrete one dimensional function f(x). More...

#include <TabulatedFunction.h>

+ Inheritance diagram for Discrete1DFunction:

Public Member Functions

 Discrete1DFunction (const std::vector< double > &values)
 Create a Discrete1DFunction f(x) based on a set of tabulated values. More...
 
void getFunctionParameters (std::vector< double > &values) const
 Get the parameters for the tabulated function. More...
 
void setFunctionParameters (const std::vector< double > &values)
 Set the parameters for the tabulated function. More...
 
Discrete1DFunctionCopy () 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 discrete one dimensional function f(x).

To evaluate it, x is rounded to the nearest integer and the table element with that index is returned. If the index is outside the range [0, size), the result is undefined.

Constructor & Destructor Documentation

Discrete1DFunction ( const std::vector< double > &  values)

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

Parameters
valuesthe tabulated values of the function f(x)

Member Function Documentation

Discrete1DFunction* Copy ( ) const
virtual

Create a deep copy of the tabulated function.

Implements TabulatedFunction.

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

Get the parameters for the tabulated function.

Parameters
valuesthe tabulated values of the function f(x)
void setFunctionParameters ( const std::vector< double > &  values)

Set the parameters for the tabulated function.

Parameters
valuesthe tabulated values of the function f(x)

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