IMP  2.0.0
The Integrative Modeling Platform
IMP::domino::SubsetFilterTable Class Referenceabstract

#include <IMP/domino/subset_filters.h>

+ Inheritance diagram for IMP::domino::SubsetFilterTable:

Public Member Functions

 SubsetFilterTable (std::string name="SubsetFilterTable%1%")
 
virtual double get_strength (const Subset &s, const Subsets &prior_subsets) const =0
 The strength is a rough metric of how this filter restricts the subset. More...
 
virtual SubsetFilterget_subset_filter (const Subset &s, const Subsets &prior_subsets) const =0
 
- Public Member Functions inherited from IMP::base::Object
virtual void clear_caches ()
 
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. 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)
 

Related Functions

(Note that these are not member functions.)

typedef IMP::base::Vector
< IMP::base::WeakPointer
< SubsetFilterTable > > 
SubsetFilterTablesTemp
 

Additional Inherited Members

- Protected Member Functions inherited from IMP::base::Object
 Object (std::string name)
 Construct an object with the given name. More...
 

Detailed Description

A SubsetFilterTable class which produces SubsetFilter objects upon demand. When the get_subset_filter() method is called, it is passed the Subset that is to be filtered. It is also passed subsets of that Subset which have previously been filtered (and so don't need to be checked again).

For example, if the passed set is {a,b,c} and the prior_subsets are {a,b} and {b,c}, then only properties than involve a and c need to be checked, as ones involve a and b and b and c have already been checked previously.

Definition at line 81 of file subset_filters.h.

Member Function Documentation

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

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.

virtual SubsetFilter* IMP::domino::SubsetFilterTable::get_subset_filter ( const Subset s,
const Subsets prior_subsets 
) const
pure 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.

Friends And Related Function Documentation

Pass a set of objects.

Definition at line 347 of file subset_filters.h.


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