bpp-phyl  2.2.0
bpp::NaNListener Class Reference

A listener which capture NaN function values and throw an exception in case this happens. More...

#include <Bpp/Phyl/OptimizationTools.h>

+ Inheritance diagram for bpp::NaNListener:
+ Collaboration diagram for bpp::NaNListener:

Public Member Functions

 NaNListener (Optimizer *optimizer, Function *function)
 
 NaNListener (const NaNListener &lr)
 
NaNListeneroperator= (const NaNListener &lr)
 
void optimizationInitializationPerformed (const OptimizationEvent &event)
 
void optimizationStepPerformed (const OptimizationEvent &event) throw (Exception)
 
bool listenerModifiesParameters () const
 

Private Attributes

Optimizer * optimizer_
 
Function * function_
 

Detailed Description

A listener which capture NaN function values and throw an exception in case this happens.

Definition at line 62 of file OptimizationTools.h.

Constructor & Destructor Documentation

◆ NaNListener() [1/2]

bpp::NaNListener::NaNListener ( Optimizer *  optimizer,
Function *  function 
)
inline

Definition at line 69 of file OptimizationTools.h.

◆ NaNListener() [2/2]

bpp::NaNListener::NaNListener ( const NaNListener lr)
inline

Definition at line 71 of file OptimizationTools.h.

Member Function Documentation

◆ listenerModifiesParameters()

bool bpp::NaNListener::listenerModifiesParameters ( ) const
inline

Definition at line 94 of file OptimizationTools.h.

◆ operator=()

NaNListener& bpp::NaNListener::operator= ( const NaNListener lr)
inline

Definition at line 76 of file OptimizationTools.h.

References function_, and optimizer_.

◆ optimizationInitializationPerformed()

void bpp::NaNListener::optimizationInitializationPerformed ( const OptimizationEvent &  event)
inline

Definition at line 84 of file OptimizationTools.h.

◆ optimizationStepPerformed()

void bpp::NaNListener::optimizationStepPerformed ( const OptimizationEvent &  event)
throw (Exception
)
inline

Definition at line 85 of file OptimizationTools.h.

References function_, and optimizer_.

Member Data Documentation

◆ function_

Function* bpp::NaNListener::function_
private

Definition at line 66 of file OptimizationTools.h.

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

◆ optimizer_

Optimizer* bpp::NaNListener::optimizer_
private

Definition at line 65 of file OptimizationTools.h.

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


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