IMP  2.3.0
The Integrative Modeling Platform
IMP::domino::ExclusionSubsetFilterTable Class Reference

Do not allow two particles to be in the same state. More...

#include <IMP/domino/subset_filters.h>

+ Inheritance diagram for IMP::domino::ExclusionSubsetFilterTable:

Detailed Description

Do not allow two particles to be in the same state.

If a ParticleStatesTable is passed, then two particles cannot be in the same state if they have the same ParticleStates, otherwise, if a kernel::ParticlePairs is passed then pairs found in the list are not allowed to have the same state index.

Definition at line 219 of file subset_filters.h.

Public Member Functions

 ExclusionSubsetFilterTable (IMP::domino::ParticleStatesTable *pst)
 
virtual double get_strength (const IMP::domino::Subset &s, const IMP::domino::Subsets &excluded) const
 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
 
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. More...
 
- Public Member Functions inherited from IMP::domino::DisjointSetsSubsetFilterTable
void add_pair (const kernel::ParticlePair &pp)
 
void add_set (const kernel::ParticlesTemp &ps)
 
- Public Member Functions inherited from IMP::domino::SubsetFilterTable
 SubsetFilterTable (std::string name="SubsetFilterTable%1%")
 
- Public Member Functions inherited from IMP::base::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
 
kernel::ParticlesTemp get_set (unsigned int i) const
 
- Protected Member Functions inherited from IMP::base::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
virtual void do_destroy ()
 

Member Function Documentation

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

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::ExclusionSubsetFilterTable::get_subset_filter ( const IMP::domino::Subset s,
const IMP::domino::Subsets prior_subsets 
) const
virtual

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::base::VersionInfo IMP::domino::ExclusionSubsetFilterTable::get_version_info ( ) const
virtual

Get information about the module and version of the object.

Reimplemented from IMP::base::Object.

Definition at line 219 of file subset_filters.h.


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