Detailed Description

Linear function

Note: The offset is not meaningful for optimization, but does make the displayed energies nicer.

Definition at line 19 of file Linear.h.

Public Member Functions
	Linear (double offset, double slope)
	Create with the given offset and slope. More...

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...

void	set_offset (double f)

void	set_slope (double f)

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

Create with the given offset and slope.

Definition at line 22 of file Linear.h.

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

virtual

Calculate score with respect to the given feature.

Parameters

[in] feature Value of feature being tested.

Reimplemented from IMP::UnaryFunction.

Definition at line 28 of file Linear.h.

virtual DerivativePair IMP::core::Linear::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 FloatPair containing the score and its partial derivative with respect to the given feaure.

Reimplemented from IMP::UnaryFunction.

Definition at line 32 of file Linear.h.

virtual ::IMP::VersionInfo IMP::core::Linear::get_version_info ( ) const

virtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 37 of file Linear.h.

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