gov.sandia.cognition.learning.function.kernel
Class ScalarFunctionKernel<InputType>

java.lang.Object
  extended by gov.sandia.cognition.util.AbstractCloneableSerializable
      extended by gov.sandia.cognition.learning.function.kernel.ScalarFunctionKernel<InputType>
Type Parameters:
InputType - The type of the input to the Kernel. For example, Vector.
All Implemented Interfaces:
Kernel<InputType>, CloneableSerializable, Serializable, Cloneable

@CodeReview(reviewer="Kevin R. Dixon",
            date="2009-07-08",
            changesNeeded=false,
            comments={"Made clone call super.clone.","Looks fine otherwise."})
public class ScalarFunctionKernel<InputType>
extends AbstractCloneableSerializable
implements Kernel<InputType>

The ScalarFunctionKernel class implements a kernel that applies a scalar function two the two inputs to the kernel and then returns their product.

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

Field Summary
protected  Evaluator<? super InputType,Double> function
          The scalar function for the kernel to use.
 
Constructor Summary
ScalarFunctionKernel()
          Creates a new instance of RealFunctionKernel.
ScalarFunctionKernel(Evaluator<? super InputType,Double> function)
          Creates a new instance of RealFunctionKernel.
 
Method Summary
 ScalarFunctionKernel<InputType> clone()
          This makes public the clone method on the Object class and removes the exception that it throws.
 double evaluate(InputType x, InputType y)
          Evaluates the kernel on the given inputs by first applying the scalar function to each input and then taking the product of the two returned scalar values.
 Evaluator<? super InputType,Double> getFunction()
          Gets the scalar function the kernel is using.
 void setFunction(Evaluator<? super InputType,Double> function)
          Sets the scalar function for the kernel to use.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

function

protected Evaluator<? super InputType,Double> function
The scalar function for the kernel to use.

Constructor Detail

ScalarFunctionKernel

public ScalarFunctionKernel()
Creates a new instance of RealFunctionKernel.


ScalarFunctionKernel

public ScalarFunctionKernel(Evaluator<? super InputType,Double> function)
Creates a new instance of RealFunctionKernel.

Parameters:
function - The scalar function for the kernel to use.
Method Detail

clone

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

evaluate

public double evaluate(InputType x,
                       InputType y)
Evaluates the kernel on the given inputs by first applying the scalar function to each input and then taking the product of the two returned scalar values.

Specified by:
evaluate in interface Kernel<InputType>
Parameters:
x - The first item.
y - The second item.
Returns:
The kernel evaluated on the two given objects.

getFunction

public Evaluator<? super InputType,Double> getFunction()
Gets the scalar function the kernel is using.

Returns:
The scalar function the kernel is using.

setFunction

public void setFunction(Evaluator<? super InputType,Double> function)
Sets the scalar function for the kernel to use.

Parameters:
function - The scalar function for the kernel to use.