package jsat.parameters;
import jsat.DataSet;
import jsat.classifiers.ClassificationDataSet;
import jsat.distributions.Distribution;
import jsat.regression.RegressionDataSet;
/**
* A double parameter that may be altered.
*
* @author Edward Raff
*/
public abstract class DoubleParameter extends Parameter
{
private static final long serialVersionUID = 4132422231433472554L;
/**
* Returns the current value for the parameter.
*
* @return the value for this parameter.
*/
abstract public double getValue();
/**
* Sets the value for this parameter.
* @return true if the value was set, false if the value
* was invalid, and thus ignored.
*/
abstract public boolean setValue(double val);
/**
* 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 {@link ClassificationDataSet}
* or {@link 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 {@code null} if
* guessing is not supported.
*
* @param data the data with which we want a reasonable guess for this
* parameter
* @return a distribution that represents a reasonable guess of a good value
* for this parameter given the input data
*/
public Distribution getGuess(DataSet data)
{
return null;
}
@Override
public String getValueString()
{
return Double.toString(getValue());
}
}
Ads help maintain this website.