jsat.math.decayrates

Class NoDecay

java.lang.Object

jsat.math.decayrates.NoDecay

All Implemented Interfaces:

Serializable, DecayRate

public class NoDecay
extends Object
implements DecayRate

A possible value for a decaying learning rate. NoDecay will perform no decaying of the initial value, the initial value will always be returned regardless of the input.

Author:

Edward Raff

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NoDecay()

Method Summary

Modifier and Type	Method and Description
DecayRate	clone()
double	rate(double time, double initial) Decays the initial value over time.
double	rate(double time, double maxTime, double initial) Decays the initial value over time.
String	toString()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NoDecay

public NoDecay()

Method Detail

rate

public double rate(double time,
                   double maxTime,
                   double initial)

Description copied from interface: DecayRate

Decays the initial value over time.

Specified by:

rate in interface DecayRate

Parameters:

time - the current time through the algorithm in the range [0, maxTime]

maxTime - the maximum time step that will be seen

initial - the initial value

Returns:

the decayed value over time of the initial value

rate

public double rate(double time,
                   double initial)

Description copied from interface: DecayRate

Decays the initial value over time.

Specified by:

rate in interface DecayRate

Parameters:

time - the current time step to return a value for

initial - the initial learning rate

Returns:

the decayed value

clone

public DecayRate clone()

Specified by:

clone in interface DecayRate

Overrides:

clone in class Object

toString

public String toString()

Overrides:

toString in class Object