IMP logo
IMP Reference Guide  2.6.0
The Integrative Modeling Platform
IMP::isd::BivariateFunction Class Referenceabstract

Base class for functions of two variables. More...

#include <IMP/isd/bivariate_functions.h>

+ Inheritance diagram for IMP::isd::BivariateFunction:

Detailed Description

Base class for functions of two variables.

Definition at line 24 of file bivariate_functions.h.

Public Member Functions

 BivariateFunction (std::string str)
 
virtual void add_to_derivatives (const Floats &x1, const Floats &x2, DerivativeAccumulator &accum) const =0
 update derivatives of particles More...
 
virtual void add_to_particle_derivative (unsigned particle_no, double value, DerivativeAccumulator &accum) const =0
 update derivatives of particles More...
 
virtual IMP_Eigen::MatrixXd get_derivative_matrix (unsigned particle_no, const FloatsList &xlist) const =0
 return derivative matrix More...
 
virtual FloatsList get_derivative_matrix (unsigned particle_no, const FloatsList &xlist, bool stupid) const =0
 
virtual ModelObjectsTemp get_inputs () const =0
 particle manipulation More...
 
virtual unsigned get_ndims_x1 () const =0
 returns the number of input dimensions More...
 
virtual unsigned get_ndims_x2 () const =0
 
virtual unsigned get_ndims_y () const =0
 returns the number of output dimensions More...
 
virtual unsigned get_number_of_optimized_particles () const =0
 returns the number of particles that are optimized More...
 
virtual unsigned get_number_of_particles () const =0
 returns the number of particles that this function uses More...
 
virtual bool get_particle_is_optimized (unsigned particle_no) const =0
 returns true if the particle whose index is provided is optimized More...
 
virtual IMP_Eigen::MatrixXd get_second_derivative_matrix (unsigned particle_a, unsigned particle_b, const FloatsList &xlist) const =0
 return second derivative matrix More...
 
virtual FloatsList get_second_derivative_matrix (unsigned particle_a, unsigned particle_b, const FloatsList &xlist, bool stupid) const =0
 
virtual bool has_changed () const =0
 return true if internal parameters have changed. More...
 
virtual Floats operator() (const Floats &x1, const Floats &x2) const =0
 evaluate the function at a certain point More...
 
virtual IMP_Eigen::MatrixXd operator() (const IMP::FloatsList &xlist) const =0
 evaluate the function at a list of points More...
 
virtual FloatsList operator() (const IMP::FloatsList &xlist, bool stupid) const =0
 used for testing only More...
 
virtual void update ()=0
 update internal parameters More...
 
- Public Member Functions inherited from IMP::Object
virtual void clear_caches ()
 
CheckLevel get_check_level () const
 
LogLevel get_log_level () const
 
virtual VersionInfo get_version_info () const
 Get information about the module and version of the object. More...
 
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)
 
virtual std::string get_type_name () const
 

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 ()
 

Member Function Documentation

virtual void IMP::isd::BivariateFunction::add_to_derivatives ( const Floats x1,
const Floats x2,
DerivativeAccumulator accum 
) const
pure virtual

update derivatives of particles

Implemented in IMP::isd::Covariance1DFunction.

virtual void IMP::isd::BivariateFunction::add_to_particle_derivative ( unsigned  particle_no,
double  value,
DerivativeAccumulator accum 
) const
pure virtual

update derivatives of particles

Implemented in IMP::isd::Covariance1DFunction.

virtual IMP_Eigen::MatrixXd IMP::isd::BivariateFunction::get_derivative_matrix ( unsigned  particle_no,
const FloatsList xlist 
) const
pure virtual

return derivative matrix

Implemented in IMP::isd::Covariance1DFunction.

virtual ModelObjectsTemp IMP::isd::BivariateFunction::get_inputs ( ) const
pure virtual

particle manipulation

Implemented in IMP::isd::Covariance1DFunction.

virtual unsigned IMP::isd::BivariateFunction::get_ndims_x1 ( ) const
pure virtual

returns the number of input dimensions

Implemented in IMP::isd::Covariance1DFunction.

virtual unsigned IMP::isd::BivariateFunction::get_ndims_y ( ) const
pure virtual

returns the number of output dimensions

Implemented in IMP::isd::Covariance1DFunction.

virtual unsigned IMP::isd::BivariateFunction::get_number_of_optimized_particles ( ) const
pure virtual

returns the number of particles that are optimized

Implemented in IMP::isd::Covariance1DFunction.

virtual unsigned IMP::isd::BivariateFunction::get_number_of_particles ( ) const
pure virtual

returns the number of particles that this function uses

Implemented in IMP::isd::Covariance1DFunction.

virtual bool IMP::isd::BivariateFunction::get_particle_is_optimized ( unsigned  particle_no) const
pure virtual

returns true if the particle whose index is provided is optimized

Implemented in IMP::isd::Covariance1DFunction.

virtual IMP_Eigen::MatrixXd IMP::isd::BivariateFunction::get_second_derivative_matrix ( unsigned  particle_a,
unsigned  particle_b,
const FloatsList xlist 
) const
pure virtual

return second derivative matrix

Implemented in IMP::isd::Covariance1DFunction.

virtual bool IMP::isd::BivariateFunction::has_changed ( ) const
pure virtual

return true if internal parameters have changed.

Implemented in IMP::isd::Covariance1DFunction.

virtual Floats IMP::isd::BivariateFunction::operator() ( const Floats x1,
const Floats x2 
) const
pure virtual

evaluate the function at a certain point

Implemented in IMP::isd::Covariance1DFunction.

virtual IMP_Eigen::MatrixXd IMP::isd::BivariateFunction::operator() ( const IMP::FloatsList xlist) const
pure virtual

evaluate the function at a list of points

Implemented in IMP::isd::Covariance1DFunction.

virtual FloatsList IMP::isd::BivariateFunction::operator() ( const IMP::FloatsList xlist,
bool  stupid 
) const
pure virtual

used for testing only

Implemented in IMP::isd::Covariance1DFunction.

virtual void IMP::isd::BivariateFunction::update ( )
pure virtual

update internal parameters

Implemented in IMP::isd::Covariance1DFunction.


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