gov.sandia.cognition.learning.function.scalar
Class VectorFunctionToScalarFunction<InputType>

java.lang.Object
  extended by gov.sandia.cognition.util.AbstractCloneableSerializable
      extended by gov.sandia.cognition.math.AbstractScalarFunction<InputType>
          extended by gov.sandia.cognition.learning.function.regression.AbstractRegressor<InputType>
              extended by gov.sandia.cognition.learning.function.scalar.VectorFunctionToScalarFunction<InputType>
Type Parameters:
InputType - The type of the input to the function.
All Implemented Interfaces:
Evaluator<InputType,Double>, ScalarFunction<InputType>, CloneableSerializable, Serializable, Cloneable

@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>

The VectorFunctionToScalarFunction class implements an adapter for using a vector function that outputs a single-dimensional vector as a scalar function.

Since:
2.0
Author:
Justin Basilico
See Also:
Serialized Form

Nested Class Summary
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.
 
Field Summary
protected  Evaluator<? super InputType,? extends Vectorizable> vectorFunction
          The function that takes a given input and outputs a 1-dimensional vector.
 
Constructor Summary
VectorFunctionToScalarFunction()
          Creates a new instance of VectorFunctionToScalarFunction.
VectorFunctionToScalarFunction(Evaluator<? super InputType,? extends Vectorizable> vectorFunction)
          Creates a new instance of VectorFunctionToScalarFunction.
 
Method Summary
 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.
 
Methods inherited from class gov.sandia.cognition.math.AbstractScalarFunction
evaluate
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

vectorFunction

protected Evaluator<? super InputType,? extends Vectorizable> vectorFunction
The function that takes a given input and outputs a 1-dimensional vector.

Constructor Detail

VectorFunctionToScalarFunction

public VectorFunctionToScalarFunction()
Creates a new instance of VectorFunctionToScalarFunction.


VectorFunctionToScalarFunction

public VectorFunctionToScalarFunction(Evaluator<? super InputType,? extends Vectorizable> vectorFunction)
Creates a new instance of VectorFunctionToScalarFunction.

Parameters:
vectorFunction - The function that outputs a 1-dimensional vector.
Method Detail

clone

public VectorFunctionToScalarFunction<InputType> clone()
Description copied from class: AbstractCloneableSerializable
This makes public the clone method on the Object 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.

Specified by:
clone in interface CloneableSerializable
Overrides:
clone in class AbstractCloneableSerializable
Returns:
A clone of this object.

evaluateAsDouble

public double evaluateAsDouble(InputType input)
Description copied from interface: ScalarFunction
Evaluates the scalar function as a double.

Parameters:
input - The input value.
Returns:
The scalar output calculated from the given input.

getVectorFunction

public Evaluator<? super InputType,? extends Vectorizable> getVectorFunction()
Gets the vector function with a one-dimensional output that is being converted to a scalar function.

Returns:
The vector function with a one-dimensional output.

setVectorFunction

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

Parameters:
vectorFunction - The vector function with a one-dimensional output.