singleton_macros.h File Reference

Macros for various classes. More...

Include dependency graph for singleton_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_SINGLETON_CONTAINER(Name)   IMP_SINGLETON_CONTAINER(name)
	Declare the needed functions for an active SingletonContainer.
#define	IMP_COMPOSITE_SINGLETON_SCORE(Name)
	Declare the functions needed for a complex SingletonScore.
#define	IMP_FOREACH_SINGLETON(sequence, operation)
#define	IMP_FOREACH_SINGLETON_INDEX(sequence, operation)
#define	IMP_IMPLEMENT_SINGLETON_CONTAINER_OPERATIONS(Name, LOOP)
#define	IMP_INDEX_SINGLETON_DERIVATIVE_MODIFIER(Name)
	Declare the functions needed for a SingletonModifier.
#define	IMP_INDEX_SINGLETON_MODIFIER(Name)
	Declare the functions needed for a SingletonModifier.
#define	IMP_INDEX_SINGLETON_PREDICATE(Name, gv)
	Declare the functions needed for a SingletonPredicate.
#define	IMP_INDEX_SINGLETON_SCORE(Name)
	Declare the functions needed for a complex SingletonScore.
#define	IMP_SIMPLE_SINGLETON_SCORE(Name)
	Declare the functions needed for a SingletonScore.
#define	IMP_SINGLETON_CONTAINER(Name)
	Declare the needed functions for a SingletonContainer.
#define	IMP_SINGLETON_DERIVATIVE_MODIFIER(Name)
	Declare the functions needed for a SingletonModifier.
#define	IMP_SINGLETON_MODIFIER(Name)
	Declare the functions needed for a SingletonModifier.
#define	IMP_SINGLETON_PREDICATE(Name)
	Declare the functions needed for a SingletonPredicate.
#define	IMP_SINGLETON_SCORE(Name)
	Declare the functions needed for a SingletonScore.
#define	IMP_SINGLETON_SCORE_BASE(Name)

---

Detailed Description

Macros for various classes.

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

Copyright 2007-2012 IMP Inventors. All rights reserved.

---

Macro Definition Documentation

#define IMP_ACTIVE_SINGLETON_CONTAINER

(

Name

)

IMP_SINGLETON_CONTAINER(name)

Declare the needed functions for an active SingletonContainer.

In addition to the methods of IMP_SINGLETON_CONTAINER(), it declares

• IMP::ScoreState::get_input_particles()
• IMP::ScoreState::get_input_containers()
• IMP::ScoreState::do_before_evaluate()

#define IMP_COMPOSITE_SINGLETON_SCORE

(

Name

)

Declare the functions needed for a complex SingletonScore.

In addition to the methods done by IMP_OBJECT(), it declares

• IMP::SingletonScore::evaluate()
• IMP::SingletonScore::get_input_particles()
• IMP::SingletonScore::get_output_particles()
• IMP::SingletonScore::evaluate_if_good

#define IMP_FOREACH_SINGLETON	(		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_SINGLETON_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_SINGLETON_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_SINGLETON_DERIVATIVE_MODIFIER

(

Name

)

Declare the functions needed for a SingletonModifier.

In addition to the methods done by IMP_OBJECT, it declares

• IMP::SingletonDerivativeModifier::apply()
• IMP::SingletonDerivativeModifier::get_input_particles()
• IMP::SingletonDerivativeModifier::get_output_particles()

#define IMP_INDEX_SINGLETON_MODIFIER

(

Name

)

Declare the functions needed for a SingletonModifier.

In addition to the methods done by IMP_OBJECT, it declares

• IMP::SingletonModifier::apply(IMP::Particle*)
• IMP::SingletonModifier::get_input_particles()
• IMP::SingletonModifier::get_output_particles()

#define IMP_INDEX_SINGLETON_PREDICATE	(		Name,
			gv
	)

Declare the functions needed for a SingletonPredicate.

In addition to the methods done by IMP_OBJECT, it declares

• IMP::SingletonPredicate::get_value_index()
• IMP::SingletonPredicate::get_input_particles()
• IMP::SingletonPredicate::get_output_particles()

#define IMP_INDEX_SINGLETON_SCORE

(

Name

)

Declare the functions needed for a complex SingletonScore.

In addition to the methods done by IMP_OBJECT(), it declares

• IMP::SingletonScore::evaluate()
• IMP::SingletonScore::get_input_particles()
• IMP::SingletonScore::get_output_particles()
• IMP::SingletonScore::evaluate_if_good

#define IMP_SIMPLE_SINGLETON_SCORE

(

Name

)

Declare the functions needed for a SingletonScore.

In addition to the methods declared and defined by IMP_SINGLETON_SCORE, the macro provides an implementation of

• IMP::SingletonScore::get_input_particles()
• IMP::SingletonScore::get_input_containers() which assume that only the passed particle serves as input to the score.

#define IMP_SINGLETON_CONTAINER

(

Name

)

Declare the needed functions for a SingletonContainer.

In addition to the methods of IMP_OBJECT, it declares

• IMP::SingletonContainer::get_contains_particle_particle()
• IMP::SingletonContainer::get_number_of_particle_particles()
• IMP::SingletonContainer::get_particle_particle()
• IMP::SingletonContainer::apply()
• IMP::SingletonContainer::evaluate()
• IMP::Interaction::get_input_objects()

#define IMP_SINGLETON_DERIVATIVE_MODIFIER

(

Name

)

Declare the functions needed for a SingletonModifier.

In addition to the methods done by IMP_OBJECT, it declares

• IMP::SingletonDerivativeModifier::apply()
• IMP::SingletonDerivativeModifier::get_input_particles()
• IMP::SingletonDerivativeModifier::get_output_particles()

#define IMP_SINGLETON_MODIFIER

(

Name

)

Declare the functions needed for a SingletonModifier.

In addition to the methods done by IMP_OBJECT, it declares

• IMP::SingletonModifier::apply(IMP::Particle*)
• IMP::SingletonModifier::get_input_particles()
• IMP::SingletonModifier::get_output_particles()

#define IMP_SINGLETON_PREDICATE

(

Name

)

Declare the functions needed for a SingletonPredicate.

In addition to the methods done by IMP_OBJECT, it declares

• IMP::SingletonPredicate::get_value()
• IMP::SingletonPredicate::get_input_particles()
• IMP::SingletonPredicate::get_output_particles()

#define IMP_SINGLETON_SCORE

(

Name

)

Declare the functions needed for a SingletonScore.

In addition to the methods done by IMP_INTERACTON, it declares

• IMP::SingletonScore::evaluate(IMP::Particle*, IMP::DerivativeAccumulator*)
• IMP::SingletonScore::get_input_particles()
• IMP::SingletonScore::get_output_particles()

See IMP_SIMPLE_SINGLETON_SCORE() for a way of providing an implementation of that method.