bpp-core3  3.0.0
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 (Optimizer *optimizer)
 
 OptimizationEvent (const OptimizationEvent &oe)
 
OptimizationEventoperator= (const OptimizationEvent &oe)
 
virtual ~OptimizationEvent ()
 
OptimizergetOptimizer ()
 
const OptimizergetOptimizer () const
 

Private Attributes

Optimizeroptimizer_
 

Detailed Description

An event object which indicates that an optimization event occured.

Definition at line 56 of file Optimizer.h.

Constructor & Destructor Documentation

◆ OptimizationEvent() [1/2]

bpp::OptimizationEvent::OptimizationEvent ( Optimizer optimizer)
inline
Parameters
optimizerA pointer toward the optimizer that launched the event.

Definition at line 65 of file Optimizer.h.

◆ OptimizationEvent() [2/2]

bpp::OptimizationEvent::OptimizationEvent ( const OptimizationEvent oe)
inline

Definition at line 66 of file Optimizer.h.

◆ ~OptimizationEvent()

virtual bpp::OptimizationEvent::~OptimizationEvent ( )
inlinevirtual

Definition at line 72 of file Optimizer.h.

Member Function Documentation

◆ getOptimizer() [1/2]

Optimizer* bpp::OptimizationEvent::getOptimizer ( )
inline
Returns
A pointer toward the optimizer that launched the event.

Definition at line 78 of file Optimizer.h.

References optimizer_.

◆ getOptimizer() [2/2]

const Optimizer* bpp::OptimizationEvent::getOptimizer ( ) const
inline
Returns
A pointer toward the optimizer that launched the event.

Definition at line 83 of file Optimizer.h.

References optimizer_.

◆ operator=()

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

Definition at line 67 of file Optimizer.h.

References optimizer_.

Member Data Documentation

◆ optimizer_

Optimizer* bpp::OptimizationEvent::optimizer_
private

Definition at line 59 of file Optimizer.h.

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


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