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

java.lang.Object
  extended by gov.sandia.cognition.util.AbstractCloneableSerializable
      extended by gov.sandia.cognition.learning.function.kernel.DefaultKernelsContainer<InputType>
          extended by gov.sandia.cognition.learning.function.kernel.SumKernel<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 SumKernel<InputType>
extends DefaultKernelsContainer<InputType>
implements Kernel<InputType>

The SumKernel class implements a kernel that adds together the result of applying multiple kernels to the same pair of inputs.

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

Field Summary
 
Fields inherited from class gov.sandia.cognition.learning.function.kernel.DefaultKernelsContainer
kernels
 
Constructor Summary
SumKernel()
          Creates a new instance of SumKernel.
SumKernel(Collection<? extends Kernel<? super InputType>> kernels)
          Creates a new instance of SumKernel with the given collection of kernels.
 
Method Summary
 SumKernel<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)
          The addition kernel applies multiple kernels to the given inputs and returns their sum.
 
Methods inherited from class gov.sandia.cognition.learning.function.kernel.DefaultKernelsContainer
getKernels, setKernels
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SumKernel

public SumKernel()
Creates a new instance of SumKernel.


SumKernel

public SumKernel(Collection<? extends Kernel<? super InputType>> kernels)
Creates a new instance of SumKernel with the given collection of kernels.

Parameters:
kernels - The collection of kernels to use.
Method Detail

clone

public SumKernel<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 DefaultKernelsContainer<InputType>
Returns:
A clone of this object.

evaluate

public double evaluate(InputType x,
                       InputType y)
The addition kernel applies multiple kernels to the given inputs and returns their sum.

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.