IMP  2.2.0
The Integrative Modeling Platform
IMP::container::QuadContainerStatistics Class Reference

Track statistics on a QuadContainer. More...

#include <IMP/container/QuadContainerStatistics.h>

+ Inheritance diagram for IMP::container::QuadContainerStatistics:

Public Member Functions

 QuadContainerStatistics (QuadContainerAdaptor c)
 
virtual void do_after_evaluate (DerivativeAccumulator *da)
 
virtual void do_before_evaluate ()
 
virtual kernel::ModelObjectsTemp do_get_inputs () const
 
virtual kernel::ModelObjectsTemp do_get_outputs () const
 
virtual std::string get_type_name () const
 
virtual ::IMP::base::VersionInfo get_version_info () const
 Get information about the module and version of the object.
 
void set_track_unique (bool tf)
 
void show_statistics (std::ostream &out) const
 
- Public Member Functions inherited from IMP::kernel::ScoreState
 ScoreState (kernel::Model *m, std::string name)
 
void after_evaluate (DerivativeAccumulator *accpt)
 Do post evaluation work if needed.
 
void before_evaluate ()
 Force update of the structure.
 
- Public Member Functions inherited from IMP::kernel::ModelObject
 ModelObject (kernel::Model *m, std::string name)
 
bool get_has_dependencies () const
 Return whether this object has dependencies computed.
 
bool get_has_required_score_states () const
 
ModelObjectsTemp get_inputs () const
 
ModelObjectsTemps get_interactions () const
 
Modelget_model () const
 
ModelObjectsTemp get_outputs () const
 
const ScoreStatesTempget_required_score_states () const
 
void set_has_dependencies (bool tf)
 
void set_has_required_score_states (bool tf)
 
- Public Member Functions inherited from IMP::base::Object
virtual void clear_caches ()
 
virtual void do_destroy ()
 
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::kernel::ModelObject
virtual ModelObjectsTemps do_get_interactions () const
 
virtual void handle_set_has_required_score_states (bool)
 
- Protected Member Functions inherited from IMP::base::Object
 Object (std::string name)
 Construct an object with the given name. More...
 

Detailed Description

The current statistics are average and min/max occupancy. Other statistics can be added on request, but we probably want to restrict it to ones that are cheap to gather.

Definition at line 26 of file QuadContainerStatistics.h.

Member Function Documentation

virtual kernel::ModelObjectsTemp IMP::container::QuadContainerStatistics::do_get_inputs ( ) const
virtual

Get any Particle, Container or other ModelObjects read by this during evaluation. If you read everything in a container, you can just return that container.

Implements IMP::kernel::ModelObject.

virtual kernel::ModelObjectsTemp IMP::container::QuadContainerStatistics::do_get_outputs ( ) const
virtual

Get any Particle, Container or other ModelObjects changed by this during evaluation. This is only useful for ScoreStates, at the moment.

Implements IMP::kernel::ModelObject.

void IMP::container::QuadContainerStatistics::set_track_unique ( bool  tf)

Keeping track of the number of unique entries seen is expensive, so it is not done by default.


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