IMP logo
IMP Reference Guide  develop.ba5ef9f91e,2024/02/26
The Integrative Modeling Platform
IMP::domino::ProbabilisticSubsetFilterTable Class Reference

#include <IMP/domino/subset_filters.h>

+ Inheritance diagram for IMP::domino::ProbabilisticSubsetFilterTable:

Detailed Description

Randomly reject some of the states. The purpose of this is to try to generate a sampling of the total states when there are a very large number of acceptable states.

Definition at line 321 of file subset_filters.h.

Public Member Functions

 ProbabilisticSubsetFilterTable (double p, bool leaves_only=false)
 
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::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::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
virtual void do_destroy ()
 

Constructor & Destructor Documentation

IMP::domino::ProbabilisticSubsetFilterTable::ProbabilisticSubsetFilterTable ( double  p,
bool  leaves_only = false 
)
Parameters
[in]pAllow states to pass with probability p
[in]leaves_onlyIf true, only filter the leaves of the merge tree.

Member Function Documentation

virtual double IMP::domino::ProbabilisticSubsetFilterTable::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::ProbabilisticSubsetFilterTable::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::ProbabilisticSubsetFilterTable::get_version_info ( ) const
overridevirtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 338 of file subset_filters.h.


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