com.cra.bnet.learn
Class EmEtaEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--com.cra.bnet.learn.EmEtaEvent
All Implemented Interfaces:
Serializable

public class EmEtaEvent
extends EventObject

An event fired by the EmEta learning algorithm.

See Also:
Serialized Form

Nested Class Summary
static class EmEtaEvent.EmEtaEventType
           
 
Field Summary
static EmEtaEvent.EmEtaEventType ALGORITHM_FINISHED
          The algorithm finished event type.
static EmEtaEvent.EmEtaEventType ALGORITHM_PAUSED
          The algorithm paused event type.
static EmEtaEvent.EmEtaEventType ALGORITHM_RESUMED
          The algorithm resumed event type.
static EmEtaEvent.EmEtaEventType ALGORITHM_STARTED
          The algorithm started event type.
static EmEtaEvent.EmEtaEventType ALGORITHM_STOPPED
          The algorithm stopped event type.
static EmEtaEvent.EmEtaEventType ITERATION_FINISHED
          The iteration finished event type.
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
EmEtaEvent(EmEtaLearningAlgorithm algorithm, double delta, int iteration, EmEtaEvent.EmEtaEventType type)
          Creates a new EmEtaEvent using the specified parameters.
 
Method Summary
 EmEtaLearningAlgorithm getAlgorithm()
          Returns the algorithm that fired this event.
 double getDelta()
          Returns the current value of delta.
 int getIterationNumber()
          Returns the current iteration number.
 String toString()
          Returns a string representation of this EmEta event.
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ALGORITHM_FINISHED

public static final EmEtaEvent.EmEtaEventType ALGORITHM_FINISHED
The algorithm finished event type.


ALGORITHM_PAUSED

public static final EmEtaEvent.EmEtaEventType ALGORITHM_PAUSED
The algorithm paused event type.


ALGORITHM_RESUMED

public static final EmEtaEvent.EmEtaEventType ALGORITHM_RESUMED
The algorithm resumed event type.


ALGORITHM_STARTED

public static final EmEtaEvent.EmEtaEventType ALGORITHM_STARTED
The algorithm started event type.


ALGORITHM_STOPPED

public static final EmEtaEvent.EmEtaEventType ALGORITHM_STOPPED
The algorithm stopped event type.


ITERATION_FINISHED

public static final EmEtaEvent.EmEtaEventType ITERATION_FINISHED
The iteration finished event type.

Constructor Detail

EmEtaEvent

public EmEtaEvent(EmEtaLearningAlgorithm algorithm,
                  double delta,
                  int iteration,
                  EmEtaEvent.EmEtaEventType type)
Creates a new EmEtaEvent using the specified parameters.

Parameters:
algorithm - algorithm that fired the event.
delta - current delta value.
iteration - current iteration number.
type - event type.
Throws:
IllegalArgumentException - if algorithm == null, delta < 0.0, or iteration < 0.
Method Detail

getAlgorithm

public EmEtaLearningAlgorithm getAlgorithm()
Returns the algorithm that fired this event.

Returns:
the algorithm that fired this event.

getDelta

public double getDelta()
Returns the current value of delta.

Returns:
the current value of delta.

getIterationNumber

public int getIterationNumber()
Returns the current iteration number.

Returns:
the current iteration number.

toString

public String toString()
Returns a string representation of this EmEta event.

Overrides:
toString in class EventObject
Returns:
a string representation of this EmEta event.