kernel/optimizer_state_macros.h File Reference

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

Detailed Description

Copyright 2007-2013 IMP Inventors. All rights reserved.

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 79 of file kernel/optimizer_state_macros.h.

#define IMP_OPTIMIZER_STATE

(

Name

)

Value:

IMPKERNEL_DEPRECATED_MACRO(2.1, "Declare the methods youself."); \
  virtual void update() IMP_OVERRIDE;                              \
  IMP_OBJECT_NO_WARNING(Name)

Deprecated:

As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Declare the methods directly.

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

#define IMP_PERIODIC_OPTIMIZER_STATE

(

Name

)

Deprecated:

As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Functionality is built into OptimizerState.

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