IMP logo
IMP Reference Guide  develop.182d9373c4,2021/04/12
The Integrative Modeling Platform
IMP::core::OrderedTypeQuadPredicate Class Reference

#include <IMP/core/quad_predicates.h>

+ Inheritance diagram for IMP::core::OrderedTypeQuadPredicate:

Detailed Description

Return a unique predicate value for each ordered quad of ParticleTypes (see Typed).

Definition at line 71 of file quad_predicates.h.

Public Member Functions

 OrderedTypeQuadPredicate (std::string name="OrderedTypeQuadPredicate%1%")
 
virtual ModelObjectsTemp do_get_inputs (Model *m, const ParticleIndexes &pis) const
 Overload this method to specify the inputs. More...
 
virtual std::string get_type_name () const
 
int get_value (const core::ParticleTypes &types)
 Compute the predicate for specified types. More...
 
Ints get_value (const ParticleQuadsTemp &o) const
 
int get_value (const ParticleQuad &a) const
 
virtual int get_value_index (Model *m, const ParticleIndexQuad &pi) const
 Compute the predicate for types of specific pi. More...
 
Ints get_value_index (Model *m, const ParticleIndexQuads &o) const
 
virtual int get_value_index_in_batch (Model *m, const ParticleIndexQuad &pi) const
 
virtual ::IMP::VersionInfo get_version_info () const
 Get information about the module and version of the object. More...
 
virtual void setup_for_get_value_index_in_batch (Model *m) const
 
- Public Member Functions inherited from IMP::QuadPredicate
 QuadPredicate (std::string name="QuadPredicate %1%")
 
int operator() (Model *m, const ParticleIndexQuad &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
 
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::OrderedTypeQuadPredicate::do_get_inputs ( Model m,
const ParticleIndexes pis 
) const
virtual

Overload this method to specify the inputs.

Implements IMP::ParticleInputs.

Definition at line 111 of file quad_predicates.h.

+ Here is the call graph for this function:

int IMP::core::OrderedTypeQuadPredicate::get_value ( const core::ParticleTypes types)

Compute the predicate for specified types.

Definition at line 82 of file quad_predicates.h.

int IMP::core::OrderedTypeQuadPredicate::get_value ( const ParticleQuad 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::QuadPredicate.

Definition at line 117 of file quad_predicates.h.

Ints IMP::core::OrderedTypeQuadPredicate::get_value ( const ParticleQuadsTemp 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::QuadPredicate.

Definition at line 117 of file quad_predicates.h.

virtual int IMP::core::OrderedTypeQuadPredicate::get_value_index ( Model m,
const ParticleIndexQuad pi 
) const
virtual

Compute the predicate for types of specific pi.

Reimplemented from IMP::QuadPredicate.

Definition at line 86 of file quad_predicates.h.

virtual int IMP::core::OrderedTypeQuadPredicate::get_value_index_in_batch ( Model m,
const ParticleIndexQuad pi 
) const
virtual

Same as get_value_index, but with optimizations for a batch of calls. Call setup_for_get_value_index_in_batch() right before calling a batch of those, otherwise unexpected behavior.

Reimplemented from IMP::QuadPredicate.

Definition at line 103 of file quad_predicates.h.

virtual ::IMP::VersionInfo IMP::core::OrderedTypeQuadPredicate::get_version_info ( ) const
virtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 118 of file quad_predicates.h.

virtual void IMP::core::OrderedTypeQuadPredicate::setup_for_get_value_index_in_batch ( Model m) const
virtual

Setup for a batch of calls to get_value_index_in_batch() (used for improving performance)

Reimplemented from IMP::QuadPredicate.

Definition at line 93 of file quad_predicates.h.


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