IMP::core::Cosine Class Reference

Cosine function. More...

#include <IMP/core/Cosine.h>

Inheritance diagram for IMP::core::Cosine:

Detailed Description

Cosine function.

This evaluates the function |k| - k cos(nf + a) where k is a force constant, n the periodicity, a the phase, and f the input value. This is most commonly used for dihedral angle restraints, e.g. in the CHARMM force field.

Definition at line 22 of file Cosine.h.

Public Member Functions
	Cosine (Float force_constant, int periodicity, Float phase)
	Constructor. More...
void	do_show (std::ostream &out) const
virtual double	evaluate (double feature) const
	Calculate score with respect to the given feature. More...
virtual DerivativePair	evaluate_with_derivative (double feature) const
	Calculate score and derivative with respect to the given feature. More...
virtual std::string	get_type_name () const
virtual ::IMP::VersionInfo	get_version_info () const
	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::Cosine::Cosine	(	Float	force_constant,
		int	periodicity,
		Float	phase
	)

Constructor.

Parameters

[in]	force_constant	Force constant (score units)
[in]	periodicity	Periodicity (generally 1-6)
[in]	phase	Phase (radians)

Definition at line 29 of file Cosine.h.

Member Function Documentation

virtual double IMP::core::Cosine::evaluate ( double  feature ) const

virtual

Calculate score with respect to the given feature.

Parameters

[in]

feature

Value of feature being tested.

Returns

Score

Reimplemented from IMP::UnaryFunction.

virtual DerivativePair IMP::core::Cosine::evaluate_with_derivative ( double  feature ) const

virtual

Calculate score and derivative with respect to the given feature.

Parameters

[in]

feature

Value 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::Cosine::get_version_info ( ) const

virtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 38 of file Cosine.h.

---

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

• Cosine.h