Detailed Description

Base class for functions of two variables.

Inheritance diagram for IMP::isd::BivariateFunction:

Public Member Functions
def	__init__
	BivariateFunction (std::string str)
virtual void	add_to_derivatives (const Floats &x1, const Floats &x2, DerivativeAccumulator &accum) const =0
	update derivatives of particles
virtual void	add_to_particle_derivative (unsigned particle_no, double value, DerivativeAccumulator &accum) const =0
	update derivatives of particles
virtual Eigen::MatrixXd	get_derivative_matrix (unsigned particle_no, const FloatsList &xlist) const =0
	return derivative matrix
virtual FloatsList	get_derivative_matrix (unsigned particle_no, const FloatsList &xlist, bool stupid) const =0
virtual ContainersTemp	get_input_containers () const =0
virtual ParticlesTemp	get_input_particles () const =0
	particle manipulation
virtual unsigned	get_ndims_x1 () const =0
	returns the number of input dimensions
virtual unsigned	get_ndims_x2 () const =0
virtual unsigned	get_ndims_y () const =0
	returns the number of output dimensions
virtual unsigned	get_number_of_optimized_particles () const =0
	returns the number of particles that are optimized
virtual unsigned	get_number_of_particles () const =0
	returns the number of particles that this function uses
virtual bool	get_particle_is_optimized (unsigned particle_no) const =0
	returns true if the particle whose index is provided is optimized
virtual Eigen::MatrixXd	get_second_derivative_matrix (unsigned particle_a, unsigned particle_b, const FloatsList &xlist) const =0
	return second derivative matrix
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.
virtual Floats	operator() (const Floats &x1, const Floats &x2) const =0
	evaluate the function at a certain point
virtual Eigen::MatrixXd	operator() (const IMP::FloatsList &xlist) const =0
	evaluate the function at a list of points
virtual FloatsList	operator() (const IMP::FloatsList &xlist, bool stupid) const =0
	used for testing only
virtual void	update ()=0
	update internal parameters
Public Member Functions inherited from IMP::base::Object
std::size_t	__hash__ () const
virtual std::string	get_type_name () const =0
	Return a string identifying the type of the object.
virtual IMP::base::VersionInfo	get_version_info () const =0
	Get information about the module and version of the object.
void	set_check_level (CheckLevel l)
void	set_log_level (LogLevel l)
	Set the logging level used in this object.
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::base::Object
	Object (std::string name)

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 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 ParticlesTemp IMP::isd::BivariateFunction::get_input_particles ( ) 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 Eigen::MatrixXd IMP::isd::BivariateFunction::get_second_derivative_matrix	(	unsigned	particle_a,
		unsigned	particle_b,
		const FloatsList &	xlist
	)		const