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 78 of file subset_filters.h.

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 SubsetFilter *	get_subset_filter (const Subset &s, const Subsets &prior_subsets) const =0

Public Member Functions inherited from IMP::Object
virtual void	clear_caches ()

CheckLevel	get_check_level () const

LogLevel	get_log_level () const

virtual VersionInfo	get_version_info () const
	Get information about the module and version of the object. More...

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)

virtual std::string	get_type_name () const

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 ()

Member Function Documentation

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

pure 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.

Implemented in IMP::domino::ProbabilisticSubsetFilterTable, IMP::domino::PairListSubsetFilterTable, IMP::domino::ListSubsetFilterTable, IMP::domino::EquivalenceAndExclusionSubsetFilterTable, IMP::domino::EquivalenceSubsetFilterTable, IMP::domino::EqualitySubsetFilterTable, IMP::domino::ExclusionSubsetFilterTable, IMP::domino::MinimumRestraintScoreSubsetFilterTable, IMP::domino::RestraintScoreSubsetFilterTable, IMP::em2d::DistanceFilterTable, and IMP::example::ExampleSubsetFilterTable.

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.

Implemented in IMP::domino::ProbabilisticSubsetFilterTable, IMP::domino::PairListSubsetFilterTable, IMP::domino::ListSubsetFilterTable, IMP::domino::EquivalenceAndExclusionSubsetFilterTable, IMP::domino::EquivalenceSubsetFilterTable, IMP::domino::EqualitySubsetFilterTable, IMP::domino::ExclusionSubsetFilterTable, IMP::domino::MinimumRestraintScoreSubsetFilterTable, IMP::domino::RestraintScoreSubsetFilterTable, IMP::em2d::DistanceFilterTable, and IMP::example::ExampleSubsetFilterTable.

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

subset_filters.h

Detailed Description

Public Member Functions

Additional Inherited Members

Member Function Documentation