IMP logo
IMP Reference Guide  2.7.0
The Integrative Modeling Platform
IMP::AttributeOptimizer Class Reference

Base class for optimizers that act on individual attributes. More...

#include <IMP/AttributeOptimizer.h>

+ Inheritance diagram for IMP::AttributeOptimizer:

Detailed Description

Base class for optimizers that act on individual attributes.

AttributeOptimizers optimize the collection of optimized attributes (see Model::set_is_optimized()) in contrast to, say molecular dynamics where the fundamental entity is a Particle.

Definition at line 22 of file AttributeOptimizer.h.

Public Member Functions

 AttributeOptimizer (Model *m, std::string name="Optimizer %1%")
- Public Member Functions inherited from IMP::Optimizer
 Optimizer (Model *m, std::string name="Optimizer %1%")
double get_last_score () const
 Return the score found in the last evaluate. More...
ScoringFunctionget_scoring_function () const
 Return the scoring function that is being used. More...
bool get_stop_on_good_score () const
double optimize (unsigned int max_steps)
 Optimize the model for up to max_steps iterations. More...
virtual void set_scoring_function (ScoringFunctionAdaptor sf)
 Set the scoring function to use. More...
void set_stop_on_good_score (bool tf)
void remove_optimizer_state (OptimizerState *d)
void remove_optimizer_states (const OptimizerStates &d)
void set_optimizer_states (const OptimizerStates &ps)
void set_optimizer_states_order (const OptimizerStates &objs)
unsigned int add_optimizer_state (OptimizerState *obj)
void add_optimizer_states (const OptimizerStates &objs)
void clear_optimizer_states ()
unsigned int get_number_of_optimizer_states () const
bool get_has_optimizer_states ()
OptimizerStateget_optimizer_state (unsigned int i) const
OptimizerStates get_optimizer_states () const
void reserve_optimizer_states (unsigned int sz)
- Public Member Functions inherited from IMP::ModelObject
 ModelObject (Model *m, std::string name)
bool get_has_dependencies () const
 Return whether this object has dependencies computed. More...
bool get_has_required_score_states () const
 Return whether score states are computed. More...
ModelObjectsTemp get_inputs () const
ModelObjectsTemps get_interactions () const
 Get the interacting sets induced by this ModelObject. More...
Modelget_model () const
ModelObjectsTemp get_outputs () const
const ScoreStatesTempget_required_score_states () const
 Get the score states that are ancestors of this in the dependency graph. More...
void set_has_dependencies (bool tf)
 Either invalidate the dependencies or ensure they are correct. More...
void set_has_required_score_states (bool tf)
 Compute the required score states. 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

Protected Member Functions

double get_width (FloatKey k) const
- Protected Member Functions inherited from IMP::Optimizer
virtual ModelObjectsTemp do_get_inputs () const
virtual ModelObjectsTemp do_get_outputs () const
 don't return anything here to avoid pointless dependencies More...
virtual double do_optimize (unsigned int ns)=0
 override this function to do actual optimization More...
ModelObjectsTemp get_optimizer_state_inputs () const
void update_states () const
 Update optimizer states, should be called at each successful step. More...
- Protected Member Functions inherited from IMP::ModelObject
virtual ModelObjectsTemps do_get_interactions () const
virtual void handle_set_has_required_score_states (bool)
- Protected Member Functions inherited from IMP::Object
 Object (std::string name)
 Construct an object with the given name. More...
virtual void do_destroy ()

Methods for getting and setting optimized attributes

Optimizers don't have to go through the particles themselves looking for values to optimize unless they care about special properties of the optimized values. Instead they can iterate through the list of optimized attributes, each of which is identified by a FloatIndex. With these FloatIndex objects they can get and set the values and derivatives as needed.

FloatIndexes get_optimized_attributes () const
void set_value (FloatIndex fi, double v) const
Float get_value (FloatIndex fi) const
Float get_derivative (FloatIndex fi) const

Methods to get and set scaled optimizable values

Certain optimizers benefit from having all the optimized values scaled to vary over a similar range. These accessors use the Model::get_range ranges to scale the values before returning them and unscale them before setting them.

void set_scaled_value (FloatIndex fi, Float v) const
double get_scaled_value (FloatIndex fi) const
double get_scaled_derivative (FloatIndex fi) const
void clear_range_cache ()
 Clear the cache of range information. Do this at the start of. More...

Member Function Documentation

void IMP::AttributeOptimizer::clear_range_cache ( )

Clear the cache of range information. Do this at the start of.

Definition at line 94 of file AttributeOptimizer.h.

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