IMP Reference Guide  2.5.0 The Integrative Modeling Platform
IMP::domino::PairListSubsetFilterTable Class Reference

#include <IMP/domino/subset_filters.h>

Inheritance diagram for IMP::domino::PairListSubsetFilterTable:

## Detailed Description

For provided pairs of particles, on all them to be in certain explicitly lists pairs of states. That is, if the particle pair (p0, p1) is added, with the list [(0,1), (3,4)], then (p0, p1) can only be in (0,1) or (3,4). Note, this class assumes that the single particles are handled appropriately. That is, that something else is restricting p0 to only 0 or 3.

Definition at line 298 of file subset_filters.h.

## Public Member Functions

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::VersionInfo get_version_info () const
Get information about the module and version of the object. More...

void set_allowed_states (ParticlePair p, const IntPairs &states)

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)

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

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 312 of file subset_filters.h.

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