Macros for various classes. More...
#include "internal/TupleRestraint.h"#include "internal/functors.h"#include "container_macros.h"#include "input_output_macros.h"#include <algorithm>
Include dependency graph for kernel/pair_macros.h: This graph shows which files directly or indirectly include this file:Go to the source code of this file.
Macros | |
| #define | IMP_ACTIVE_PAIR_CONTAINER(Name) IMP_PAIR_CONTAINER(name) |
| Declare the needed functions for an active PairContainer. More... | |
| #define | IMP_COMPOSITE_PAIR_SCORE(Name) |
| Declare the functions needed for a complex PairScore. More... | |
| #define | IMP_FOREACH_PAIR(sequence, operation) |
| #define | IMP_FOREACH_PAIR_INDEX(sequence, operation) IMP_CONTAINER_FOREACH(PairContainer, sequence, operation) |
| #define | IMP_INDEX_PAIR_DERIVATIVE_MODIFIER(Name) IMP_INDEX_PAIR_MODIFIER(Name) |
| Use IMP_INDEX_PAIR_MODIFIER instead. | |
| #define | IMP_INDEX_PAIR_MODIFIER(Name) |
| Declare the functions needed for a PairModifier. More... | |
| #define | IMP_INDEX_PAIR_PREDICATE(Name, return_value, return_inputs) |
| Declare the functions needed for a PairPredicate. More... | |
| #define | IMP_INDEX_PAIR_SCORE(Name) |
| Declare the functions needed for a complex PairScore. More... | |
| #define | IMP_PAIR_CONTAINER(Name) |
| Declare the needed functions for a PairContainer. More... | |
| #define | IMP_PAIR_DERIVATIVE_MODIFIER(Name) IMP_PAIR_MODIFIER(Name) |
| Use IMP_PAIR_MODIFIER() instead. | |
| #define | IMP_PAIR_MODIFIER(Name) |
| Declare the functions needed for a PairModifier. More... | |
| #define | IMP_PAIR_PREDICATE(Name) |
| Declare the functions needed for a PairPredicate. More... | |
| #define | IMP_PAIR_SCORE(Name) |
| Declare the functions needed for a PairScore. More... | |
| #define | IMP_SIMPLE_PAIR_SCORE(Name) |
| Declare the functions needed for a PairScore. More... | |
Detailed Description
This file is generated by a script (core/tools/make-containers). Do not edit directly.
Copyright 2007-2013 IMP Inventors. All rights reserved.
Definition in file kernel/pair_macros.h.
Macro Definition Documentation
| #define IMP_ACTIVE_PAIR_CONTAINER | ( | Name | ) | IMP_PAIR_CONTAINER(name) |
In addition to the methods of IMP_PAIR_CONTAINER(), it declares
- IMP::ScoreState::get_input_particles()
- IMP::ScoreState::get_input_containers()
- IMP::ScoreState::do_before_evaluate()
Definition at line 381 of file kernel/pair_macros.h.
| #define IMP_COMPOSITE_PAIR_SCORE | ( | Name | ) |
In addition to the methods done by IMP_OBJECT(), it declares
- IMP::PairScore::evaluate_index()
- IMP::PairScore::do_get_inputs()
- IMP::PairScore::evaluate_if_good_index()
Definition at line 83 of file kernel/pair_macros.h.
| #define IMP_FOREACH_PAIR | ( | sequence, | |
| operation | |||
| ) |
Use IMP_CONTAINER_FOREACH() instead.
Definition at line 386 of file kernel/pair_macros.h.
| #define IMP_FOREACH_PAIR_INDEX | ( | sequence, | |
| operation | |||
| ) | IMP_CONTAINER_FOREACH(PairContainer, sequence, operation) |
Use IMP_CONTAINER_FOREACH() instead.
Definition at line 402 of file kernel/pair_macros.h.
| #define IMP_INDEX_PAIR_MODIFIER | ( | Name | ) |
In addition to the methods done by IMP_OBJECT, it declares
- IMP::PairModifier::apply(IMP::Particle*)
- IMP::PairModifier::get_inputs()
- IMP::PairModifier::get_outputs()
Definition at line 301 of file kernel/pair_macros.h.
| #define IMP_INDEX_PAIR_PREDICATE | ( | Name, | |
| return_value, | |||
| return_inputs | |||
| ) |
In addition to the methods done by IMP_OBJECT, it defines
- IMP::PairPredicate::get_value_index() based on the return_value parameter
- IMP::PairPredicate::do_get_inputs() based on the return_inputs parameter
Definition at line 224 of file kernel/pair_macros.h.
| #define IMP_INDEX_PAIR_SCORE | ( | Name | ) |
In addition to the methods done by IMP_OBJECT(), it declares
- IMP::PairScore::evaluate()
- IMP::PairScore::get_input_particles()
- IMP::PairScore::get_output_particles()
- IMP::PairScore::evaluate_if_good
Definition at line 133 of file kernel/pair_macros.h.
| #define IMP_PAIR_CONTAINER | ( | Name | ) |
In addition to the methods of IMP_OBJECT, it declares - IMP::PairContainer::get_number_of_particle_particle_pairs() - IMP::PairContainer::get_particle_particle_pair() - IMP::PairContainer::apply() - IMP::PairContainer::evaluate() - IMP::Interaction::get_input_objects() You need to define a template method with the signature
that applied the functor to each thing in the container.
Definition at line 360 of file kernel/pair_macros.h.
| #define IMP_PAIR_MODIFIER | ( | Name | ) |
In addition to the methods done by IMP_OBJECT, it declares
- IMP::PairModifier::apply(IMP::Particle*)
- IMP::PairModifier::get_input_particles()
- IMP::PairModifier::get_output_particles()
Definition at line 280 of file kernel/pair_macros.h.
| #define IMP_PAIR_PREDICATE | ( | Name | ) |
In addition to the methods done by IMP_OBJECT, it declares
- IMP::PairPredicate::get_value()
- IMP::PairPredicate::get_input_particles()
- IMP::PairPredicate::get_output_particles()
Definition at line 190 of file kernel/pair_macros.h.
| #define IMP_PAIR_SCORE | ( | Name | ) |
In addition to the methods done by IMP_INTERACTON, it declares
- IMP::PairScore::evaluate(IMP::Particle*, IMP::DerivativeAccumulator*)
- IMP::PairScore::get_input_particles()
- IMP::PairScore::get_output_particles()
See IMP_SIMPLE_PAIR_SCORE() for a way of providing an implementation of that method.
Definition at line 31 of file kernel/pair_macros.h.
| #define IMP_SIMPLE_PAIR_SCORE | ( | Name | ) |
In addition to the methods declared and defined by IMP_PAIR_SCORE, the macro provides an implementation of
- IMP::PairScore::get_input_particles()
- IMP::PairScore::get_input_containers() which assume that only the passed particle serves as input to the score.
Definition at line 57 of file kernel/pair_macros.h.