gum::ApproximationSchemeListener Class Reference

The ApproximationSchemeListener class. More...

#include <approximationSchemeListener.h>

Inheritance diagram for gum::ApproximationSchemeListener:

Collaboration diagram for gum::ApproximationSchemeListener:

Public Member Functions
	ApproximationSchemeListener (IApproximationSchemeConfiguration &sch)
	Class constructor. More...
virtual	~ApproximationSchemeListener ()
	Class destructor. More...
virtual void	whenProgress (const void *src, const Size step, const double error, const double time)=0
	When progress was made. More...
virtual void	whenStop (const void *src, const std::string message)=0
	When it stops. More...
void	_attachSignal_ (__sig__::ISignaler *sender)
void	_detachSignal_ (__sig__::ISignaler *sender)

Protected Member Functions
	ApproximationSchemeListener (const ApproximationSchemeListener &other)
	Copy constructor. More...
ApproximationSchemeListener &	operator= (const ApproximationSchemeListener &other)
	Copy operator. More...

Detailed Description

The ApproximationSchemeListener class.

Warning

Doxygen does not like spanning command on multiple line, so we could not configure it with the correct include directive. Use the following code snippet to include this file.

#include <agrum/tools/core/approximations/approximationSchemeListener.h>

Definition at line 50 of file approximationSchemeListener.h.

Constructor & Destructor Documentation

ApproximationSchemeListener() [1/2]

gum::ApproximationSchemeListener::ApproximationSchemeListener

(

IApproximationSchemeConfiguration &

sch

)

Class constructor.

Parameters

sch	The scheme configuration.

Definition at line 33 of file approximationSchemeListener.cpp.

References gum::Set< Key, Alloc >::emplace().

                                                                                                 :
      _sch_(sch) {
    GUM_CONSTRUCTOR(ApproximationSchemeListener);

    GUM_CONNECT((_sch_), onProgress, (*this), ApproximationSchemeListener::whenProgress);
    GUM_CONNECT((_sch_), onStop, (*this), ApproximationSchemeListener::whenStop);
  }

Here is the call graph for this function:

~ApproximationSchemeListener()

gum::ApproximationSchemeListener::~ApproximationSchemeListener ( )

virtual

Class destructor.

Definition at line 48 of file approximationSchemeListener.cpp.

References gum::Set< Key, Alloc >::emplace().

                                                            {
    GUM_DESTRUCTOR(ApproximationSchemeListener);
  }

Here is the call graph for this function:

ApproximationSchemeListener() [2/2]

gum::ApproximationSchemeListener::ApproximationSchemeListener ( const ApproximationSchemeListener &  other )

protected

Copy constructor.

Definition at line 41 of file approximationSchemeListener.cpp.

References gum::Set< Key, Alloc >::emplace().

                                               :
      _sch_(other._sch_) {
    GUM_CONS_CPY(ApproximationSchemeListener);
    GUM_ERROR(OperationNotAllowed, "No copy constructor for ApproximationSchemeListener")
  }

Here is the call graph for this function:

Member Function Documentation

_attachSignal_()

INLINE void gum::Listener::_attachSignal_ ( __sig__::ISignaler *  sender )

inherited

Definition at line 35 of file listener_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ _senders_.push_back(sender); }

Here is the call graph for this function:

_detachSignal_()

INLINE void gum::Listener::_detachSignal_ ( __sig__::ISignaler *  sender )

inherited

Definition at line 37 of file listener_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                               {
    auto del = std::remove(_senders_.begin(), _senders_.end(), sender);

    if (del != _senders_.end()) _senders_.erase(del, _senders_.end());
  }

Here is the call graph for this function:

operator=()

ApproximationSchemeListener & gum::ApproximationSchemeListener::operator= ( const ApproximationSchemeListener &  other )

protected

Copy operator.

Definition at line 53 of file approximationSchemeListener.cpp.

References gum::Set< Key, Alloc >::emplace().

                                                                                    {
    GUM_CONS_CPY(ApproximationSchemeListener);
    GUM_ERROR(OperationNotAllowed, "No copy constructor for ApproximationSchemeListener")
  }

Here is the call graph for this function:

whenProgress()

virtual void gum::ApproximationSchemeListener::whenProgress ( const void *  src, const Size  step, const double  error, const double  time  )

pure virtual

When progress was made.

Parameters

src	The signal source.
pourcent	The advancement in percent.
error	The number of errors.
time	The time.

Implemented in gum::learning::BNLearnerListener.

whenStop()

virtual void gum::ApproximationSchemeListener::whenStop ( const void *  src, const std::string  message  )

pure virtual

When it stops.

Parameters

src	The signal source.
message	A message.

Implemented in gum::learning::BNLearnerListener.

Member Data Documentation

_sch_

IApproximationSchemeConfiguration& gum::ApproximationSchemeListener::_sch_

private

The scheme configuration.

Definition at line 94 of file approximationSchemeListener.h.

---

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

• agrum/tools/core/approximations/approximationSchemeListener.h
• agrum/tools/core/approximations/approximationSchemeListener.cpp