jsat.parameters

Class BooleanParameter

java.lang.Object

jsat.parameters.Parameter

jsat.parameters.BooleanParameter

All Implemented Interfaces:

Serializable

public abstract class BooleanParameter
extends Parameter

A boolean 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
BooleanParameter()

Method Summary

Modifier and Type	Method and Description
abstract boolean	getValue() Returns the current value for the parameter.
String	getValueString() Returns a string indicating the value currently held by the Parameter
abstract boolean	setValue(boolean 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

BooleanParameter

public BooleanParameter()

Method Detail

getValue

public abstract boolean getValue()

Returns the current value for the parameter.

Returns:

the value for this parameter.

setValue

public abstract boolean setValue(boolean val)

Sets the value for this parameter.

Returns:

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

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