IMP::kernel::PairPredicate Class Reference

Abstract predicate function. More...

#include <IMP/kernel/PairPredicate.h>

Inheritance diagram for IMP::kernel::PairPredicate:

Public Types
typedef ParticlePair	Argument
typedef ParticleIndexPair	IndexArgument

Public Member Functions
	PairPredicate (std::string name="PairPredicate %1%")
virtual int	get_value (const ParticlePair &vt) const
virtual Ints	get_value (const ParticlePairsTemp &o) const
virtual int	get_value_index (kernel::Model *m, const ParticleIndexPair &vt) const
	Compute the predicate and the derivative if needed.
virtual Ints	get_value_index (kernel::Model *m, const ParticleIndexPairs &o) const
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
virtual VersionInfo	get_version_info () const
	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)
virtual std::string	get_type_name () const

Additional Inherited Members
Protected Member Functions inherited from IMP::kernel::ParticleInputs
virtual ModelObjectsTemp	do_get_inputs (kernel::Model *m, const ParticleIndexes &pis) const
Protected Member Functions inherited from IMP::base::Object
	Object (std::string name)
	Construct an object with the given name. More...
	Object ()

Detailed Description

A predicate is a function which returns one of a discrete set of values (eg -1, 0, 1 depending on whether a value is negative, zero or positive). PairPredicates will evaluate the predicate for the passed particles.

Implementers should check out IMP_PAIR_PREDICATE().

Definition at line 32 of file kernel/PairPredicate.h.

Member Function Documentation

virtual int IMP::kernel::PairPredicate::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 in IMP::container::ExclusiveConsecutivePairFilter, IMP::core::CoinFlipPairPredicate, IMP::core::AllSamePairPredicate, IMP::container::ConsecutivePairFilter, IMP::core::OrderedTypePairPredicate, IMP::core::UnorderedTypePairPredicate, IMP::atom::StereochemistryPairFilter, IMP::container::InContainerPairFilter, IMP::core::ConstantPairPredicate, IMP::atom::BondedPairFilter, IMP::atom::SameResiduePairFilter, and IMP::misc::CommonEndpointPairFilter.

virtual Ints IMP::kernel::PairPredicate::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 in IMP::container::ExclusiveConsecutivePairFilter, IMP::core::CoinFlipPairPredicate, IMP::core::AllSamePairPredicate, IMP::container::ConsecutivePairFilter, IMP::core::OrderedTypePairPredicate, IMP::core::UnorderedTypePairPredicate, IMP::atom::StereochemistryPairFilter, IMP::container::InContainerPairFilter, IMP::core::ConstantPairPredicate, IMP::atom::BondedPairFilter, IMP::atom::SameResiduePairFilter, and IMP::misc::CommonEndpointPairFilter.

int IMP::kernel::PairPredicate::operator()	(	kernel::Model *	m,
		const ParticleIndexPair &	vt
	)		const

But beware of slicing.

Definition at line 57 of file kernel/PairPredicate.h.

---

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

• kernel/PairPredicate.h