jsat.parameters

Class MetricParameter

java.lang.Object

jsat.parameters.Parameter

jsat.parameters.MetricParameter

All Implemented Interfaces:

java.io.Serializable

public abstract class MetricParameter
extends Parameter

A MetricParameter is a parameter controller for the DistanceMetric used by the current algorithm.

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getASCIIName() Returns the name of this parameter using only valid ACII characters.
abstract DistanceMetric	getMetric() Returns the distance metric that was used for this learner
java.lang.String	getValueString() Returns a string indicating the value currently held by the Parameter
abstract boolean	setMetric(DistanceMetric val) Sets the distance metric that should be sued

Methods inherited from class jsat.parameters.Parameter

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MetricParameter

public MetricParameter()

Method Detail

setMetric

public abstract boolean setMetric(DistanceMetric val)

Sets the distance metric that should be sued

Parameters:

val - the distance metric to use

Returns:

true if the metric is valid and was set, false if the metric was not valid for this learner and ignored.

getMetric

public abstract DistanceMetric getMetric()

Returns the distance metric that was used for this learner

Returns:

the current distance metric

getASCIIName

public java.lang.String getASCIIName()

Description copied from class: Parameter

Returns the name of this parameter using only valid ACII characters.

Specified by:

getASCIIName in class Parameter

Returns:

the ACII name

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