IMP logo
IMP Reference Guide  2.21.0
The Integrative Modeling Platform
IMP::core::WeightedSum Class Reference

Weighted sum of unary functions. More...

#include <IMP/core/WeightedSum.h>

+ Inheritance diagram for IMP::core::WeightedSum:

Detailed Description

Weighted sum of unary functions.

A unary function that computes the weighted sum of multiple functions.

Definition at line 18 of file WeightedSum.h.

Public Member Functions

 WeightedSum (UnaryFunctions funcs, Floats weights)
 
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...
 
UnaryFunctionget_function (unsigned int i)
 Get function at index. More...
 
unsigned int get_function_number ()
 Get the number of functions. 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...
 
double get_weight (unsigned int i) const
 Get function weight at index. More...
 
Floats get_weights ()
 Get the function weights. More...
 
void set_weights (Floats weights)
 Set the function weights. 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::WeightedSum::WeightedSum ( UnaryFunctions  funcs,
Floats  weights 
)

Create with the functions and their respective weights

Definition at line 21 of file WeightedSum.h.

Member Function Documentation

virtual double IMP::core::WeightedSum::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.

Definition at line 41 of file WeightedSum.h.

virtual DerivativePair IMP::core::WeightedSum::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.

Definition at line 28 of file WeightedSum.h.

UnaryFunction* IMP::core::WeightedSum::get_function ( unsigned int  i)

Get function at index.

Definition at line 71 of file WeightedSum.h.

unsigned int IMP::core::WeightedSum::get_function_number ( )

Get the number of functions.

Definition at line 50 of file WeightedSum.h.

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

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 76 of file WeightedSum.h.

double IMP::core::WeightedSum::get_weight ( unsigned int  i) const

Get function weight at index.

Definition at line 65 of file WeightedSum.h.

Floats IMP::core::WeightedSum::get_weights ( )

Get the function weights.

Definition at line 62 of file WeightedSum.h.

void IMP::core::WeightedSum::set_weights ( Floats  weights)

Set the function weights.

Definition at line 55 of file WeightedSum.h.


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