Various general useful macros for IMP. More...

#include <IMP/kernel/kernel_config.h>
#include <IMP/base/value_macros.h>
#include <IMP/base/utility_macros.h>
#include "internal/utility.h"
#include "OptimizerState.h"

Include dependency graph for kernel/optimizer_state_macros.h:

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

Go to the source code of this file.

Macros
#define	IMP_MODEL_SAVE(Name, args, vars, constr, functs, save_action)
	Define a pair of classes to handle saving the model. More...

#define	IMP_OPTIMIZER_STATE(Name)
	Define the basics needed for an OptimizerState. More...

#define	IMP_PERIODIC_OPTIMIZER_STATE(Name)
	Define the basics needed for an OptimizerState which acts every n steps. More...

Detailed Description

Definition in file kernel/optimizer_state_macros.h.

Macro Definition Documentation

#define IMP_MODEL_SAVE	(	Name,
		args,
		vars,
		constr,
		functs,
		save_action
	)

This macro defines a class:

NameOptimizerState to handling saving the model in the specified way during optimization and on failures, respectively.

Parameters

[in]	Name	The name to prefix the class names
[in]	args	The parentesized arguments to the constructor. The last one should be a string called file_name.
[in]	vars	The needed member variables.
[in]	constr	The body of the constructor.
[in]	functs	Any functions (declaration and definition) to go in the class bodies.
[in]	save_action	The action to take to perform the save. The name to save to is know as file_name

Definition at line 83 of file kernel/optimizer_state_macros.h.

#define IMP_OPTIMIZER_STATE ( Name )

Value:

virtual void update(); \

IMP_OBJECT(Name)

In addition to the methods done by IMP_OBJECT, it declares

IMP::OptimizerState::update()

Definition at line 22 of file kernel/optimizer_state_macros.h.

#define IMP_PERIODIC_OPTIMIZER_STATE ( Name )

Please use IMP::core::PeriodicOptimizerState instead.

Definition at line 29 of file kernel/optimizer_state_macros.h.

Macros

Detailed Description

Macro Definition Documentation