Macros for various classes. More...

Include dependency graph for pair_macros.h:

This graph shows which files directly or indirectly include this file:

Macros
#define	IMP_ACTIVE_PAIR_CONTAINER(Name) IMP_PAIR_CONTAINER(name)
	Declare the needed functions for an active PairContainer.
#define	IMP_COMPOSITE_PAIR_SCORE(Name)
	Declare the functions needed for a complex PairScore.
#define	IMP_FOREACH_PAIR(sequence, operation)
#define	IMP_FOREACH_PAIR_INDEX(sequence, operation)
#define	IMP_IMPLEMENT_PAIR_CONTAINER_OPERATIONS(Name, LOOP)
#define	IMP_INDEX_PAIR_DERIVATIVE_MODIFIER(Name)
	Declare the functions needed for a PairModifier.
#define	IMP_INDEX_PAIR_MODIFIER(Name)
	Declare the functions needed for a PairModifier.
#define	IMP_INDEX_PAIR_PREDICATE(Name, gv)
	Declare the functions needed for a PairPredicate.
#define	IMP_INDEX_PAIR_SCORE(Name)
	Declare the functions needed for a complex PairScore.
#define	IMP_PAIR_CONTAINER(Name)
	Declare the needed functions for a PairContainer.
#define	IMP_PAIR_DERIVATIVE_MODIFIER(Name)
	Declare the functions needed for a PairModifier.
#define	IMP_PAIR_MODIFIER(Name)
	Declare the functions needed for a PairModifier.
#define	IMP_PAIR_PREDICATE(Name)
	Declare the functions needed for a PairPredicate.
#define	IMP_PAIR_SCORE(Name)
	Declare the functions needed for a PairScore.
#define	IMP_PAIR_SCORE_BASE(Name)
#define	IMP_SIMPLE_PAIR_SCORE(Name)
	Declare the functions needed for a PairScore.

Detailed Description

Macros for various classes.

This file is generated by a script (core/tools/make-containers). Do not edit directly.

Macro Definition Documentation

#define IMP_ACTIVE_PAIR_CONTAINER ( Name ) IMP_PAIR_CONTAINER(name)

Declare the needed functions for an active PairContainer.

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()

#define IMP_COMPOSITE_PAIR_SCORE ( Name )

Declare the functions needed for a complex PairScore.

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

#define IMP_FOREACH_PAIR	(	sequence,
		operation
	)

These macros avoid various inefficiencies.

The macros take the name of the sequence and the operation to peform. The item in the sequence is called _1, it's index is _2. Use it like

IMP_FOREACH_PARTICLE(sc, std::cout << "Item " << _2

<< " is _1->get_name() << std::endl);

#define IMP_FOREACH_PAIR_INDEX	(	sequence,
		operation
	)

These macros avoid various inefficiencies.

The macros take the name of the sequence and the operation to peform. The item in the sequence is called _1, it's index is _2. Use it like

IMP_FOREACH_PARTICLE(sc, std::cout << "Item " << _2

<< " is _1->get_name() << std::endl);

#define IMP_IMPLEMENT_PAIR_CONTAINER_OPERATIONS	(	Name,
		LOOP
	)

Implement the needed template functions for a container.

Parameters:

[in]	Name	the name
[in]	LOOP	do the loop. There should be a line IMP_OPERATION and the current item should be in a variable named item at that time.

#define IMP_INDEX_PAIR_DERIVATIVE_MODIFIER ( Name )

Declare the functions needed for a PairModifier.

In addition to the methods done by IMP_OBJECT, it declares

#define IMP_INDEX_PAIR_MODIFIER ( Name )

Declare the functions needed for a PairModifier.

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()

#define IMP_INDEX_PAIR_PREDICATE	(	Name,
		gv
	)

Declare the functions needed for a PairPredicate.

In addition to the methods done by IMP_OBJECT, it declares

IMP::PairPredicate::get_value_index()
IMP::PairPredicate::get_input_particles()
IMP::PairPredicate::get_output_particles()

#define IMP_INDEX_PAIR_SCORE ( Name )

Declare the functions needed for a complex PairScore.

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

#define IMP_PAIR_CONTAINER ( Name )

Declare the needed functions for a PairContainer.

In addition to the methods of IMP_OBJECT, it declares

IMP::PairContainer::get_contains_particle_particle_pair()
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()

#define IMP_PAIR_DERIVATIVE_MODIFIER ( Name )

Declare the functions needed for a PairModifier.

In addition to the methods done by IMP_OBJECT, it declares

#define IMP_PAIR_MODIFIER ( Name )

Declare the functions needed for a PairModifier.

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()

#define IMP_PAIR_PREDICATE ( Name )

Declare the functions needed for a PairPredicate.

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()

#define IMP_PAIR_SCORE ( Name )

Declare the functions needed for a PairScore.

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.

#define IMP_SIMPLE_PAIR_SCORE ( Name )

Declare the functions needed for a PairScore.

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.