IMP logo
IMP Reference Guide  develop.27926d84dc,2024/04/16
The Integrative Modeling Platform
IMP::domino::EquivalenceSubsetFilterTable Class Reference

Define sets of equivalent particles. More...

#include <IMP/domino/subset_filters.h>

+ Inheritance diagram for IMP::domino::EquivalenceSubsetFilterTable:

Detailed Description

Define sets of equivalent particles.

Particles in an equivalency set are assumed to be equivalent under exchange. Given that, one should only generate each of the equivalent conformations once. More specifically, given equivalent particles p0 and p1, if p0 is given state s0 and p1 is given state s1, then p1 will never be given state s0 when p0 is given the state s1.

Definition at line 238 of file subset_filters.h.

Public Member Functions

 EquivalenceSubsetFilterTable (IMP::domino::ParticleStatesTable *pst)
 
virtual double get_strength (const IMP::domino::Subset &s, const IMP::domino::Subsets &excluded) const override
 The strength is a rough metric of how this filter restricts the subset. More...
 
virtual IMP::domino::SubsetFilterget_subset_filter (const IMP::domino::Subset &s, const IMP::domino::Subsets &excluded) const override
 
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...
 
- Public Member Functions inherited from IMP::domino::DisjointSetsSubsetFilterTable
void add_pair (const ParticlePair &pp)
 
void add_set (const ParticlesTemp &ps)
 
- Public Member Functions inherited from IMP::domino::SubsetFilterTable
 SubsetFilterTable (std::string name="SubsetFilterTable%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::domino::DisjointSetsSubsetFilterTable
 DisjointSetsSubsetFilterTable (ParticleStatesTable *pst, std::string name)
 
 DisjointSetsSubsetFilterTable (std::string name)
 
unsigned int get_number_of_sets () const
 
ParticlesTemp get_set (unsigned int i) const
 
- Protected Member Functions inherited from IMP::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
virtual void do_destroy ()
 

Member Function Documentation

virtual double IMP::domino::EquivalenceSubsetFilterTable::get_strength ( const IMP::domino::Subset s,
const IMP::domino::Subsets prior_subsets 
) const
overridevirtual

The strength is a rough metric of how this filter restricts the subset.

It is still kind of nebulous, but as a rough guide, it should be the fraction of the states that are eliminated by the filter.

Implements IMP::domino::SubsetFilterTable.

virtual IMP::domino::SubsetFilter* IMP::domino::EquivalenceSubsetFilterTable::get_subset_filter ( const IMP::domino::Subset s,
const IMP::domino::Subsets prior_subsets 
) const
overridevirtual

Return a SubsetFilter which acts on the Subset s, given that all the prior_subsets have already been filtered. This should return nullptr if there is no filtering to be done.

Implements IMP::domino::SubsetFilterTable.

virtual ::IMP::VersionInfo IMP::domino::EquivalenceSubsetFilterTable::get_version_info ( ) const
overridevirtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 238 of file subset_filters.h.


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