InputType - The type of the input to the function.@CodeReview(reviewer="Kevin R. Dixon", date="2009-07-06", changesNeeded=false, comments={"Made clone() call super.clone().","Made Learner inherit SupervisedBatchLearner","Otherwise, class looks fine."}) public class VectorFunctionToScalarFunction<InputType> extends AbstractRegressor<InputType>
VectorFunctionToScalarFunction class implements an adapter for
using a vector function that outputs a single-dimensional vector as a
scalar function.| Modifier and Type | Class and Description |
|---|---|
static class |
VectorFunctionToScalarFunction.Learner<InputType>
The
VectorFunctionToScalarFunction.Learner class implements a
simple learner for a VectorFunctionToScalarFunction that allows
a learning algorithm that outputs a vector function to be adapted to
learn on data whose output are doubles. |
| Modifier and Type | Field and Description |
|---|---|
protected Evaluator<? super InputType,? extends Vectorizable> |
vectorFunction
The function that takes a given input and outputs a 1-dimensional
vector.
|
| Constructor and Description |
|---|
VectorFunctionToScalarFunction()
Creates a new instance of
VectorFunctionToScalarFunction. |
VectorFunctionToScalarFunction(Evaluator<? super InputType,? extends Vectorizable> vectorFunction)
Creates a new instance of
VectorFunctionToScalarFunction. |
| Modifier and Type | Method and Description |
|---|---|
VectorFunctionToScalarFunction<InputType> |
clone()
This makes public the clone method on the
Object class and
removes the exception that it throws. |
double |
evaluateAsDouble(InputType input)
Evaluates the scalar function as a double.
|
Evaluator<? super InputType,? extends Vectorizable> |
getVectorFunction()
Gets the vector function with a one-dimensional output that is being
converted to a scalar function.
|
void |
setVectorFunction(Evaluator<? super InputType,? extends Vectorizable> vectorFunction)
Sets the vector function with a one-dimensional output that is being
converted to a scalar function.
|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitevaluateprotected Evaluator<? super InputType,? extends Vectorizable> vectorFunction
public VectorFunctionToScalarFunction()
VectorFunctionToScalarFunction.public VectorFunctionToScalarFunction(Evaluator<? super InputType,? extends Vectorizable> vectorFunction)
VectorFunctionToScalarFunction.vectorFunction - The function that outputs a 1-dimensional
vector.public VectorFunctionToScalarFunction<InputType> clone()
AbstractCloneableSerializableObject class and
removes the exception that it throws. Its default behavior is to
automatically create a clone of the exact type of object that the
clone is called on and to copy all primitives but to keep all references,
which means it is a shallow copy.
Extensions of this class may want to override this method (but call
super.clone() to implement a "smart copy". That is, to target
the most common use case for creating a copy of the object. Because of
the default behavior being a shallow copy, extending classes only need
to handle fields that need to have a deeper copy (or those that need to
be reset). Some of the methods in ObjectUtil may be helpful in
implementing a custom clone method.
Note: The contract of this method is that you must use
super.clone() as the basis for your implementation.clone in interface CloneableSerializableclone in class AbstractCloneableSerializablepublic double evaluateAsDouble(InputType input)
ScalarFunctioninput - The input value.public Evaluator<? super InputType,? extends Vectorizable> getVectorFunction()
public void setVectorFunction(Evaluator<? super InputType,? extends Vectorizable> vectorFunction)
vectorFunction - The vector function with a one-dimensional output.