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/core/approximations/approximationSchemeListener.h>

Definition at line 51 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 34 of file approximationSchemeListener.cpp.

References __sch, GUM_CONNECT, whenProgress(), and whenStop().

                                             :
      __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 52 of file approximationSchemeListener.cpp.

References operator=().

                                                            {
    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 44 of file approximationSchemeListener.cpp.

References GUM_ERROR.

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

Member Function Documentation

attachSignal__()

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

inherited

Definition at line 36 of file listener_inl.h.

References gum::Listener::__senders.

                                                               {
    __senders.push_back(sender);
  }

detachSignal__()

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

inherited

Definition at line 40 of file listener_inl.h.

References gum::Listener::__senders.

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

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

operator=()

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

protected

Copy operator.

Definition at line 57 of file approximationSchemeListener.cpp.

References GUM_ERROR.

Referenced by ~ApproximationSchemeListener().

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

Here is the caller 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.

Referenced by ApproximationSchemeListener().

Here is the caller graph for this function:

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.

Referenced by ApproximationSchemeListener().

Here is the caller graph for this function:

Member Data Documentation

__sch

IApproximationSchemeConfiguration& gum::ApproximationSchemeListener::__sch

private

The scheme configuration.

Definition at line 97 of file approximationSchemeListener.h.

Referenced by ApproximationSchemeListener().

---

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

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