IMP logo
IMP Reference Guide  develop.b708a66810,2021/08/02
The Integrative Modeling Platform
IMP::container::InContainerQuadFilter Class Reference

A filter which returns true if a container containers the Quad. More...

#include <IMP/container/InContainerQuadFilter.h>

+ Inheritance diagram for IMP::container::InContainerQuadFilter:

Detailed Description

A filter which returns true if a container containers the Quad.

This predicate returns 1 if the passed tuple is in the container.

Note
Use the handle_permutations parameter to the constructor to determine whether only exact matchers, or matches under permutation are considered matching. By default they are are.

Definition at line 32 of file InContainerQuadFilter.h.

Public Member Functions

 InContainerQuadFilter (QuadContainer *c, std::string name="QuadFilter %1%")
 
 InContainerQuadFilter (QuadContainer *c, bool handle_permutations, std::string name="QuadFilter %1%")
 
virtual ModelObjectsTemp do_get_inputs (Model *m, const ParticleIndexes &pi) const
 Overload this method to specify the inputs. More...
 
virtual std::string get_type_name () const
 
int get_value (const ParticleQuad &a) const
 
Ints get_value (const ParticleQuadsTemp &o) const
 
virtual int get_value_index (Model *, const ParticleIndexQuad &vt) const
 Compute the predicate and the derivative if needed. More...
 
Ints get_value_index (Model *m, const ParticleIndexQuads &o) const
 
virtual ::IMP::VersionInfo get_version_info () const
 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::container::InContainerQuadFilter::do_get_inputs ( Model m,
const ParticleIndexes pis 
) const
virtual

Overload this method to specify the inputs.

Implements IMP::ParticleInputs.

Definition at line 46 of file InContainerQuadFilter.h.

+ Here is the call graph for this function:

virtual int IMP::container::InContainerQuadFilter::get_value_index ( Model m,
const ParticleIndexQuad vt 
) const
virtual

Compute the predicate and the derivative if needed.

Implements IMP::QuadPredicate.

Definition at line 42 of file InContainerQuadFilter.h.

virtual ::IMP::VersionInfo IMP::container::InContainerQuadFilter::get_version_info ( ) const
virtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 53 of file InContainerQuadFilter.h.


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