com.cra.bnet.learn
Class EmEtaParameters

java.lang.Object
  |
  +--com.cra.bnet.learn.EmEtaParameters

public final class EmEtaParameters
extends Object

Parameters for the EmEta learning algorithm.


Field Summary
static EmEtaParameters DEFAULT_PARAMETERS
          Default parameters.
 
Constructor Summary
EmEtaParameters(double eta, int maxIterations, double minDelta)
          Creates a new EmEtaParameters object using the specified values.
 
Method Summary
 double getLearningRate()
          Returns the learning rate (also known as eta).
 int getMaximumIterations()
          Returns the maximum number of iterations.
 double getMinimumDelta()
          Returns the minimum value for delta.
 String toString()
          Returns a string representation of this parameters object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DEFAULT_PARAMETERS

public static final EmEtaParameters DEFAULT_PARAMETERS
Default parameters. The default values are:
 eta = 1.8
 maxIterations = 40
 minDelta = 0.001
 

Constructor Detail

EmEtaParameters

public EmEtaParameters(double eta,
                       int maxIterations,
                       double minDelta)
Creates a new EmEtaParameters object using the specified values.

Parameters:
eta - learning rate.
maxIterations - maximum number of iterations.
minDelta - minimum value for delta.
Throws:
IllegalArgumentException - if eta <= 0.0, maxIterations < 0, or minDelta < 0.0.
Method Detail

getLearningRate

public double getLearningRate()
Returns the learning rate (also known as eta).

Returns:
the learning rate.

getMaximumIterations

public int getMaximumIterations()
Returns the maximum number of iterations.

Returns:
the maximum number of iterations.

getMinimumDelta

public double getMinimumDelta()
Returns the minimum value for delta. The algorithm should stop once delta is less than or equal to this value.

Returns:
the minimum value for delta.

toString

public String toString()
Returns a string representation of this parameters object.

Overrides:
toString in class Object
Returns:
a string representation of this parameters object.