jsat.parameters

Class ObjectParameter<T>

java.lang.Object

jsat.parameters.Parameter

jsat.parameters.ObjectParameter<T>

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

DecayRateParameter, KernelFunctionParameter

public abstract class ObjectParameter<T>
extends Parameter

A parameter that could be one of a finite number of possible objects.

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
ObjectParameter()

Method Summary

Modifier and Type	Method and Description
abstract T	getObject() Returns the current object value
java.lang.String	getValueString() Returns a string indicating the value currently held by the Parameter
abstract java.util.List<T>	parameterOptions() Returns a list of all possible objects that may be used as a parameter.
abstract boolean	setObject(T obj) Sets the parameter to the given object

Methods inherited from class jsat.parameters.Parameter

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ObjectParameter

public ObjectParameter()

Method Detail

getObject

public abstract T getObject()

Returns the current object value

Returns:

the current object set for the parameter

setObject

public abstract boolean setObject(T obj)

Sets the parameter to the given object

Parameters:

obj - the new parameter value

Returns:

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

parameterOptions

public abstract java.util.List<T> parameterOptions()

Returns a list of all possible objects that may be used as a parameter.

Returns:

a list of all possible objects that may be used as a parameter.

getValueString

public java.lang.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