IMP::TripletContainer Class Reference

---

Detailed Description

A shared container for Triplets.

Stores a searchable shared collection of Triplets.

\par Implementors

Developers who wish to implement a TripletContainer should inherit from this class and use the IMP_TRIPLET_CONTAINER() macro to help define the needed functions. Lamentably, we do not provide an example.

Inheritance diagram for IMP::TripletContainer:

List of all members.

Public Types
typedef ParticleIndexTriplet	ContainedIndexType
typedef ParticleIndexTriplets	ContainedIndexTypes
typedef ParticleTriplet	ContainedType
typedef ParticleTripletsTemp	ContainedTypes

Public Member Functions
virtual void	apply (const TripletModifier *sm) const =0
	Apply a SingletonModifier to the contents.
virtual void	apply (const TripletDerivativeModifier *sm, DerivativeAccumulator &da) const =0
	Apply a SingletonModifier to the contents.
virtual double	evaluate (const TripletScore *s, DerivativeAccumulator *da) const =0
	Evaluate a score on the contents.
virtual double	evaluate_if_good (const TripletScore *s, DerivativeAccumulator *da, double max) const =0
	Evaluate a score on the contents.
virtual bool	get_contains_particle_triplet (const ParticleTriplet &v) const =0
virtual unsigned int	get_number_of_particle_triplets () const
	return the number of Triplets in the container
virtual ParticleTriplet	get_particle_triplet (unsigned int i) const
ParticleTripletsTemp	get_particle_triplets () const
Public Member Functions inherited from IMP::Container
virtual void	do_after_evaluate (DerivativeAccumulator *accpt)
	Reset changed status.
virtual ParticlesTemp	get_all_possible_particles () const =0
	Get contained particles.
virtual ParticlesTemp	get_input_particles () const
	Return get_all_possible_particles()
virtual bool	get_is_changed () const
virtual bool	get_is_decomposable () const
virtual ContainersTemp	get_output_containers () const
	Containers don't have output.
virtual ParticlesTemp	get_output_particles () const
	Containers don't have output.
Public Member Functions inherited from IMP::Constraint
	Constraint (Model *m, std::string name="Constraint %1%")
Public Member Functions inherited from IMP::ScoreState
	ScoreState (Model *m, std::string name="ScoreState %1%")
void	after_evaluate (DerivativeAccumulator *accpt)
void	before_evaluate ()
virtual ContainersTemp	get_input_containers () const =0
Public Member Functions inherited from IMP::ModelObject
	ModelObject (Model *m, std::string name)
ModelObjectsTemp	get_inputs () const
Model *	get_model () const
ModelObjectsTemp	get_outputs () const
Public Member Functions inherited from IMP::base::Object
std::size_t	__hash__ () const
virtual std::string	get_type_name () const =0
	Return a string identifying the type of the object.
virtual IMP::base::VersionInfo	get_version_info () const =0
	Get information about the module and version of the object.
void	set_check_level (CheckLevel l)
void	set_log_level (LogLevel l)
	Set the logging level used in this object.
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)

Protected Member Functions
	TripletContainer (Model *m, std::string name="TripletContainer %1%")
Protected Member Functions inherited from IMP::Container
	Container (Model *m, std::string name="Container %1%")
void	set_is_changed (bool tf)
	This will be reset at the end of evaluate.

---

Member Function Documentation

virtual void IMP::TripletContainer::apply ( const TripletModifier *  sm ) const

pure virtual

Apply a SingletonModifier to the contents.

Implemented in IMP::container::TripletContainerSet.

virtual void IMP::TripletContainer::apply ( const TripletDerivativeModifier *  sm, DerivativeAccumulator &  da  ) const

pure virtual

Apply a SingletonModifier to the contents.

Implemented in IMP::container::TripletContainerSet.

virtual double IMP::TripletContainer::evaluate ( const TripletScore *  s, DerivativeAccumulator *  da  ) const

pure virtual

Evaluate a score on the contents.

Implemented in IMP::container::TripletContainerSet.

virtual double IMP::TripletContainer::evaluate_if_good ( const TripletScore *  s, DerivativeAccumulator *  da, double  max  ) const

pure virtual

Evaluate a score on the contents.

Implemented in IMP::container::TripletContainerSet.

virtual bool IMP::TripletContainer::get_contains_particle_triplet ( const ParticleTriplet &  v ) const

pure virtual

Note:

This function may be linear. Be aware of the complexity bounds of your particular container.

Implemented in IMP::container::TripletContainerSet.

virtual unsigned int IMP::TripletContainer::get_number_of_particle_triplets ( ) const

virtual

return the number of Triplets in the container

Note:

this isn't always constant time

---

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

• declare_TripletContainer.h