IMP logo
IMP Reference Guide  2.7.0
The Integrative Modeling Platform
IMP::PairPredicate Class Reference

Abstract predicate function. More...

#include <IMP/PairPredicate.h>

+ Inheritance diagram for IMP::PairPredicate:

Detailed Description

Abstract predicate function.

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 31 of file PairPredicate.h.

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 (Model *m, const ParticleIndexPair &vt) const
 Compute the predicate and the derivative if needed. More...
virtual Ints get_value_index (Model *m, const ParticleIndexPairs &o) const
int operator() (Model *m, const ParticleIndexPair &vt) const
 Enable them to be use as functors. More...
- Public Member Functions inherited from IMP::ParticleInputs
ModelObjectsTemp get_inputs (Model *m, const ParticleIndexes &pis) const
 Get the ModelObjects read when the given list of particles is used. 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::ParticleInputs
virtual ModelObjectsTemp do_get_inputs (Model *m, const ParticleIndexes &pis) const =0
 Overload this method to specify the inputs. More...
- 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

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

Enable them to be use as functors.

But beware of slicing.

Definition at line 58 of file PairPredicate.h.

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