bpp::OptimizationEvent Class Reference

An event object which indicates that an optimization event occured. More...

#include <Bpp/Numeric/Function/Optimizer.h>

Collaboration diagram for bpp::OptimizationEvent:

Public Member Functions
	OptimizationEvent (OptimizerInterface *optimizer)
	OptimizationEvent (const OptimizationEvent &oe)
OptimizationEvent &	operator= (const OptimizationEvent &oe)
virtual	~OptimizationEvent ()
OptimizerInterface *	getOptimizer ()
const OptimizerInterface *	getOptimizer () const

Private Attributes
OptimizerInterface *	optimizer_
	Stores a pointer toward the optimizer that cast the event. More...

Detailed Description

An event object which indicates that an optimization event occured.

Definition at line 22 of file Optimizer.h.

Constructor & Destructor Documentation

OptimizationEvent() [1/2]

bpp::OptimizationEvent::OptimizationEvent ( OptimizerInterface *  optimizer )

inline

Parameters

optimizer

A pointer toward the optimizer that launched the event.

Definition at line 36 of file Optimizer.h.

OptimizationEvent() [2/2]

bpp::OptimizationEvent::OptimizationEvent ( const OptimizationEvent &  oe )

inline

Definition at line 37 of file Optimizer.h.

~OptimizationEvent()

virtual bpp::OptimizationEvent::~OptimizationEvent ( )

inlinevirtual

Definition at line 43 of file Optimizer.h.

Member Function Documentation

getOptimizer() [1/2]

OptimizerInterface* bpp::OptimizationEvent::getOptimizer ( )

inline

Returns

A pointer toward the optimizer that launched the event.

Definition at line 49 of file Optimizer.h.

References optimizer_.

getOptimizer() [2/2]

const OptimizerInterface* bpp::OptimizationEvent::getOptimizer ( ) const

inline

Returns

A pointer toward the optimizer that launched the event.

Definition at line 54 of file Optimizer.h.

References optimizer_.

operator=()

OptimizationEvent& bpp::OptimizationEvent::operator= ( const OptimizationEvent &  oe )

inline

Definition at line 38 of file Optimizer.h.

References optimizer_.

Member Data Documentation

optimizer_

OptimizerInterface* bpp::OptimizationEvent::optimizer_

private

Stores a pointer toward the optimizer that cast the event.

A regular pointer is used, as the Optimizer itself may not be managed by a smart pointer.

Definition at line 30 of file Optimizer.h.

Referenced by getOptimizer(), and operator=().

---

The documentation for this class was generated from the following file:

• Bpp/Numeric/Function/Optimizer.h