gov.sandia.cognition.learning.function.scalar

Class LinearCombinationScalarFunction<InputType>

java.lang.Object

gov.sandia.cognition.util.AbstractCloneableSerializable

gov.sandia.cognition.learning.function.LinearCombinationFunction<InputType,java.lang.Double>

gov.sandia.cognition.learning.function.scalar.LinearCombinationScalarFunction<InputType>

Type Parameters:

InputType - Input class for the basis function

All Implemented Interfaces:

Evaluator<InputType,java.lang.Double>, Regressor<InputType>, Vectorizable, ScalarFunction<InputType>, CloneableSerializable, java.io.Serializable, java.lang.Cloneable

public class LinearCombinationScalarFunction<InputType>
extends LinearCombinationFunction<InputType,java.lang.Double>
implements Regressor<InputType>

A weighted linear combination of scalar functions.

Since:

2.0

Author:

Kevin R. Dixon

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LinearCombinationScalarFunction(java.util.ArrayList<? extends Evaluator<InputType,java.lang.Double>> basisFunctions, Vector coefficients) Creates a new instance of LinearCombinationFunction
LinearCombinationScalarFunction(java.util.Collection<? extends Evaluator<InputType,java.lang.Double>> basisFunctions) Creates a new instance of LinearCombinationFunction

Method Summary

Modifier and Type	Method and Description
LinearCombinationScalarFunction<InputType>	clone() This makes public the clone method on the Object class and removes the exception that it throws.
java.lang.Double	evaluate(InputType input) Evaluates the LinearCombinationFunction about the given input.
double	evaluateAsDouble(InputType input) Evaluates the scalar function as a double.

Methods inherited from class gov.sandia.cognition.learning.function.LinearCombinationFunction

convertFromVector, convertToVector, getBasisFunctions, getCoefficients, setBasisFunctions, setCoefficients, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LinearCombinationScalarFunction

public LinearCombinationScalarFunction(java.util.Collection<? extends Evaluator<InputType,java.lang.Double>> basisFunctions)

Creates a new instance of LinearCombinationFunction

Parameters:

basisFunctions - Collection of basis functions to combine to produce the output

LinearCombinationScalarFunction

public LinearCombinationScalarFunction(java.util.ArrayList<? extends Evaluator<InputType,java.lang.Double>> basisFunctions,
                                       Vector coefficients)

Creates a new instance of LinearCombinationFunction

Parameters:

basisFunctions - Collection of basis functions to combine to produce the output

coefficients - Coefficients for the basisFunctions

Method Detail

clone

public LinearCombinationScalarFunction<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 Vectorizable

Specified by:

clone in interface CloneableSerializable

Overrides:

clone in class LinearCombinationFunction<InputType,java.lang.Double>

Returns:

A clone of this object.

evaluate

public java.lang.Double evaluate(InputType input)

Description copied from class: LinearCombinationFunction

Evaluates the LinearCombinationFunction about the given input. The output is produced as: y = a0*f0(x) + a1*f1(x) + ... + an*fn(x), where "y" is the output, "x" is the given input, "ai" is the ith coefficient and "fi" is the ith basis function

Specified by:

evaluate in interface Evaluator<InputType,java.lang.Double>

Specified by:

evaluate in interface ScalarFunction<InputType>

Specified by:

evaluate in class LinearCombinationFunction<InputType,java.lang.Double>

Parameters:

input - The input about which to compute the output

Returns:

y = a0*f0(x) + a1*f1(x) + ... + an*fn(x)

evaluateAsDouble

public double evaluateAsDouble(InputType input)

Description copied from interface: ScalarFunction

Evaluates the scalar function as a double.

Specified by:

evaluateAsDouble in interface ScalarFunction<InputType>

Parameters:

input - The input value.

Returns:

The scalar output calculated from the given input.