Detailed Description

An instance of this type is created by the SubsetFilterTable::get_subset_filter method(). It's job is to reject some of the Assignments corresponding to the Subset it was created with. It has one method of interest, get_is_ok() which true if the state passes the filter.

The passed Assignment has the particles ordered in the same order as they were in the Subset that was passed to the table in order to create the filter.

Definition at line 44 of file subset_filters.h.

Public Member Functions
	SubsetFilter (std::string name="SubsetFilter%1%")

virtual bool	get_is_ok (const Assignment &state) const =0

virtual int	get_next_state (int pos, const Assignment &state) const
	Return a next possible acceptable state for the particle in pos. More...

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 bool IMP::domino::SubsetFilter::get_is_ok ( const Assignment & state ) const

pure virtual

Return true if the given state passes this filter for the Subset it was created with

Implemented in IMP::em2d::DistanceFilter.

virtual int IMP::domino::SubsetFilter::get_next_state	(	int	pos,
		const Assignment &	state
	)		const

virtual

Return a next possible acceptable state for the particle in pos.

The default implementation returns the current value +1. This method needs to make sure it does not skip any valid states.

The method can assume !get_is_ok(state) and that the state minus pos is ok.

Definition at line 58 of file subset_filters.h.

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