IMP::container::InContainerPairFilter Class Reference

A filter which returns true if a container containers the Pair. More...

#include <IMP/container/InContainerPairFilter.h>

Inheritance diagram for IMP::container::InContainerPairFilter:

Public Member Functions
	InContainerPairFilter (PairContainer *c, std::string name="PairFilter %1%")
	InContainerPairFilter (PairContainer *c, bool handle_permutations, std::string name="PairFilter %1%")
virtual kernel::ModelObjectsTemp	do_get_inputs (kernel::Model *m, const kernel::ParticleIndexes &pi) const
virtual std::string	get_type_name () const
int	get_value (const ParticlePair &a) const
Ints	get_value (const ParticlePairsTemp &o) const
virtual int	get_value_index (kernel::Model *, const ParticleIndexPair &vt) const
Ints	get_value_index (kernel::Model *m, const ParticleIndexPairs &o) const
virtual ::IMP::base::VersionInfo	get_version_info () const
	Get information about the module and version of the object.
Public Member Functions inherited from IMP::kernel::PairPredicate
	PairPredicate (std::string name="PairPredicate %1%")
virtual int	get_value_index (kernel::Model *m, const ParticleIndexPair &vt) const
	Compute the predicate and the derivative if needed.
int	operator() (kernel::Model *m, const ParticleIndexPair &vt) const
	Enable them to be use as functors. More...
Public Member Functions inherited from IMP::kernel::ParticleInputs
virtual ContainersTemp	get_input_containers (Particle *p) const
virtual ParticlesTemp	get_input_particles (Particle *p) const
ModelObjectsTemp	get_inputs (kernel::Model *m, const ParticleIndexes &pis) const
Public Member Functions inherited from IMP::base::Object
virtual void	clear_caches ()
virtual void	do_destroy ()
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
Public Types inherited from IMP::kernel::PairPredicate
typedef ParticlePair	Argument
typedef ParticleIndexPair	IndexArgument
Protected Member Functions inherited from IMP::base::Object
	Object (std::string name)
	Construct an object with the given name. More...
	Object ()

Detailed Description

This predicate returns 1 if the passed tuple is in the container.

Note

Use the handle_permutations parameter to the constructor to determine whether only exact matchers, or matches under permutation are considered matching. By default they are are.

Definition at line 31 of file InContainerPairFilter.h.

Member Function Documentation

virtual kernel::ModelObjectsTemp IMP::container::InContainerPairFilter::do_get_inputs ( kernel::Model *  m, const kernel::ParticleIndexes &  pis  ) const

virtual

Overload this method to specify the inputs.

Reimplemented from IMP::kernel::ParticleInputs.

Definition at line 44 of file InContainerPairFilter.h.

Here is the call graph for this function:

Ints IMP::container::InContainerPairFilter::get_value ( const ParticlePairsTemp &  o ) const

virtual

Deprecated:

As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use the index based version.

Reimplemented from IMP::kernel::PairPredicate.

Definition at line 50 of file InContainerPairFilter.h.

int IMP::container::InContainerPairFilter::get_value ( const ParticlePair &  vt ) const

virtual

Deprecated:

As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use the index based version.

Reimplemented from IMP::kernel::PairPredicate.

Definition at line 50 of file InContainerPairFilter.h.

---

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

• InContainerPairFilter.h