IMP logo
IMP Reference Guide  develop.7cb8855c60,2024/10/08
The Integrative Modeling Platform
IMP::core::UnorderedTypeQuadPredicate Class Reference

Return a unique predicate value for each unordered set of ParticleTypes. More...

#include <IMP/core/quad_predicates.h>

+ Inheritance diagram for IMP::core::UnorderedTypeQuadPredicate:

Detailed Description

Return a unique predicate value for each unordered set of ParticleTypes.

When applied to a set of particles that are decorated with the Typed decorator, this returns a value that is a function of all of the types. The order of the particles does not matter.

Definition at line 59 of file quad_predicates.h.

Public Member Functions

 UnorderedTypeQuadPredicate (std::string name="UnorderedTypeQuadPredicate%1%")
 
virtual ModelObjectsTemp do_get_inputs (Model *m, const ParticleIndexes &pis) const override
 Overload this method to specify the inputs. More...
 
virtual std::string get_type_name () const override
 
int get_value (const ParticleQuad &a) const
 
Ints get_value (const ParticleQuadsTemp &o) const
 
virtual int get_value_index (Model *m, const ParticleIndexQuad &pi) const override
 Compute the predicate and the derivative if needed. More...
 
Ints get_value_index (Model *m, const ParticleIndexQuads &o) const override
 
virtual ::IMP::VersionInfo get_version_info () const override
 Get information about the module and version of the object. More...
 
- Public Member Functions inherited from IMP::QuadPredicate
 QuadPredicate (std::string name="QuadPredicate %1%")
 
virtual int get_value_index_in_batch (Model *m, const ParticleIndexQuad &vt) const
 
int operator() (Model *m, const ParticleIndexQuad &vt) const
 Enable them to be use as functors. More...
 
virtual void setup_for_get_value_index_in_batch (Model *) const
 
- 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
 
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::QuadPredicate
typedef ParticleQuad Argument
 
typedef ParticleIndexQuad IndexArgument
 
- 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 ModelObjectsTemp IMP::core::UnorderedTypeQuadPredicate::do_get_inputs ( Model m,
const ParticleIndexes pis 
) const
overridevirtual

Overload this method to specify the inputs.

Implements IMP::ParticleInputs.

Definition at line 74 of file quad_predicates.h.

+ Here is the call graph for this function:

virtual int IMP::core::UnorderedTypeQuadPredicate::get_value_index ( Model m,
const ParticleIndexQuad vt 
) const
overridevirtual

Compute the predicate and the derivative if needed.

Implements IMP::QuadPredicate.

Definition at line 70 of file quad_predicates.h.

virtual ::IMP::VersionInfo IMP::core::UnorderedTypeQuadPredicate::get_version_info ( ) const
overridevirtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 81 of file quad_predicates.h.


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