jsat.parameters

Class DoubleParameter

java.lang.Object

jsat.parameters.Parameter

jsat.parameters.DoubleParameter

All Implemented Interfaces:

Serializable

public abstract class DoubleParameter
extends Parameter

A double parameter that may be altered.

Author:

Edward Raff

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class jsat.parameters.Parameter

Parameter.ParameterHolder, Parameter.WarmParameter

Constructor Summary

Constructors

Constructor and Description
DoubleParameter()

Method Summary

Modifier and Type	Method and Description
Distribution	getGuess(DataSet data) This method allows one to obtain a distribution that represents a reasonable "guess" at the range of values that would work for this parameter.
abstract double	getValue() Returns the current value for the parameter.
String	getValueString() Returns a string indicating the value currently held by the Parameter
abstract boolean	setValue(double val) Sets the value for this parameter.

Methods inherited from class jsat.parameters.Parameter

equals, getASCIIName, getName, getParamsFromMethods, hashCode, isWarmParameter, preferredLowToHigh, requiresRetrain, toParameterMap, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DoubleParameter

public DoubleParameter()

Method Detail

getValue

public abstract double getValue()

Returns the current value for the parameter.

Returns:

the value for this parameter.

setValue

public abstract boolean setValue(double val)

Sets the value for this parameter.

Returns:

true if the value was set, false if the value was invalid, and thus ignored.

getGuess

public Distribution getGuess(DataSet data)

This method allows one to obtain a distribution that represents a reasonable "guess" at the range of values that would work for this parameter. If the DataSet is an instance of ClassificationDataSet or RegressionDataSet, the method may choose to assume that the value is being guessed for the specified task and change its behavior

Providing a getGuess is not required, and returns null if guessing is not supported.

Parameters:

data - the data with which we want a reasonable guess for this parameter

Returns:

a distribution that represents a reasonable guess of a good value for this parameter given the input data

getValueString

public String getValueString()

Description copied from class: Parameter

Returns a string indicating the value currently held by the Parameter

Specified by:

getValueString in class Parameter

Returns:

a string representation of the parameter's value