IMP logo
IMP Reference Guide  2.20.2
The Integrative Modeling Platform
IMP::core::ClosedCubicSpline Class Reference

Closed cubic spline function. More...

#include <IMP/core/ClosedCubicSpline.h>

+ Inheritance diagram for IMP::core::ClosedCubicSpline:

Detailed Description

Closed cubic spline function.

This function is a cubic spline interpolating a set of values. The function is periodic, so the score will also have the same value at minrange + spacing * values.size(). See OpenCubicSpline for a non-periodic spline.

See Also
OpenCubicSpline

Definition at line 22 of file ClosedCubicSpline.h.

Public Member Functions

 ClosedCubicSpline (const Floats &values, double minrange, double spacing)
 
void do_show (std::ostream &out) const
 
virtual double evaluate (double feature) const override
 Calculate score with respect to the given feature. More...
 
virtual DerivativePair evaluate_with_derivative (double feature) const override
 Calculate score and derivative with respect to the given feature. More...
 
virtual std::string get_type_name () const override
 
virtual ::IMP::VersionInfo get_version_info () const override
 Get information about the module and version of the object. More...
 
- Public Member Functions inherited from IMP::UnaryFunction
 UnaryFunction (std::string name="UnaryFunction%1%")
 
- Public Member Functions inherited from IMP::Object
virtual void clear_caches ()
 
CheckLevel get_check_level () const
 
LogLevel get_log_level () const
 
void set_check_level (CheckLevel l)
 
void set_log_level (LogLevel l)
 Set the logging level used in this object. More...
 
void set_was_used (bool tf) const
 
void show (std::ostream &out=std::cout) const
 
const std::string & get_name () const
 
void set_name (std::string name)
 

Additional Inherited Members

- Protected Member Functions inherited from IMP::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
virtual void do_destroy ()
 

Constructor & Destructor Documentation

IMP::core::ClosedCubicSpline::ClosedCubicSpline ( const Floats values,
double  minrange,
double  spacing 
)
Parameters
[in]valuesScore value at each spline point.
[in]minrangeFeature value at first spline point.
[in]spacingDistance (in feature space) between points

Member Function Documentation

virtual double IMP::core::ClosedCubicSpline::evaluate ( double  feature) const
overridevirtual

Calculate score with respect to the given feature.

Parameters
[in]featureValue of feature being tested.
Returns
Score

Reimplemented from IMP::UnaryFunction.

virtual DerivativePair IMP::core::ClosedCubicSpline::evaluate_with_derivative ( double  feature) const
overridevirtual

Calculate score and derivative with respect to the given feature.

Parameters
[in]featureValue of feature being tested.
Returns
a DerivativePair containing the score and its partial derivative with respect to the given feature.

Reimplemented from IMP::UnaryFunction.

virtual ::IMP::VersionInfo IMP::core::ClosedCubicSpline::get_version_info ( ) const
overridevirtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 35 of file ClosedCubicSpline.h.


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