Detailed Description

Store the centers of clusters of the assignments. The metric can either be specified explicitly using the set_metric() function or the default can be used which is to use the l_inf norm on the embedding returned by the ParticleState. We can later add the ability to choose the metric that acts on the vector of distances, but for now it is L2.

Warning: ClusteredAssignmentContainer has not been stabilized and is likely to change without notice.

Warning: ClusteredAssignmentContainer has not been well tested yet: Use with caution and please report any bugs found.

Inheritance diagram for IMP::domino::ClusteredAssignmentContainer:

List of all members.

Public Member Functions
	ClusteredAssignmentContainer (unsigned int k, Subset s, ParticleStatesTable *pst)
void	add_metric (Particle p, statistics::Metric m)
const statistics::Metrics &	get_metrics () const
	get the properly ordered metrics
double	get_r () const
Public Member Functions inherited from IMP::domino::AssignmentContainer
	AssignmentContainer (std::string name="AssignmentsContainer %1%")
virtual void	add_assignment (const Assignment &a)=0
virtual void	add_assignments (const Assignments &as)=0
virtual Assignment	get_assignment (unsigned int i) const =0
virtual Assignments	get_assignments (IntRange ir) const =0
virtual Assignments	get_assignments () const =0
virtual unsigned int	get_number_of_assignments () const =0
virtual Ints	get_particle_assignments (unsigned int i) const =0
	Get all the assignments for the ith particle.
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)

Static Public Member Functions
static ClusteredAssignmentContainer *	get_from (IMP::base::Object *o)

Member Function Documentation

void IMP::domino::ClusteredAssignmentContainer::add_metric	(	Particle *	p,
		statistics::Metric *	m
	)

Add a metric to act on the specified particle. Make sure this metric matches the ParticleState (eg if it is an XYZState, that the numbers of the states used in the metric and that in the XYZState coincide).

const statistics::Metrics& IMP::domino::ClusteredAssignmentContainer::get_metrics ( ) const

get the properly ordered metrics

double IMP::domino::ClusteredAssignmentContainer::get_r ( ) const

Return the r parameter defining the maximum size of the cluster.

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

assignment_containers.h

Detailed Description

Public Member Functions

Static Public Member Functions

Member Function Documentation