 |
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). SingletonPredicates will evaluate the predicate for the passed particles.
Implementers should check out IMP_SINGLETON_PREDICATE().
Inheritance diagram for IMP::SingletonPredicate:Public Types | |
| typedef Particle * | Argument |
| typedef ParticleIndex | IndexArgument |
Public Member Functions | |
| SingletonPredicate (std::string name="SingletonPredicate %1%") | |
| virtual ContainersTemp | get_input_containers (Particle *p) const =0 |
| virtual ParticlesTemp | get_input_particles (Particle *p) const =0 |
| virtual int | get_value (Particle *vt) const =0 |
| Compute the predicate. | |
| virtual Ints | get_value (const ParticlesTemp &o) const |
| virtual int | get_value_index (Model *m, ParticleIndex vt) const |
| Compute the predicate and the derivative if needed. | |
| virtual Ints | get_value_index (Model *m, const ParticleIndexes &o) const |
| Public Member Functions inherited from IMP::base::Object | |
| std::size_t | __hash__ () const |
| virtual std::string | get_type_name () const =0 |
| Return a string identifying the type of the object. | |
| virtual IMP::base::VersionInfo | get_version_info () const =0 |
| 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. | |
| 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 | |
| Protected Member Functions inherited from IMP::base::Object | |
| Object (std::string name) | |
|
pure virtual |
Get the set of input containers when this modifier is applied to the arguments.
|
pure virtual |
Get the set of particles read when applied to the arguments.
|
pure virtual |
Compute the predicate.
|
virtual |
Implementations for these are provided by the IMP_SINGLETON_PREDICATE() macro.
|
virtual |
Compute the predicate and the derivative if needed.
|
virtual |
Implementations for these are provided by the IMP_SINGLETON_PREDICATE() macro.
