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

java.lang.Object
  extended by gov.sandia.cognition.util.AbstractCloneableSerializable
      extended by gov.sandia.cognition.learning.function.kernel.DefaultKernelContainer<InputType>
          extended by gov.sandia.cognition.learning.function.kernel.ExponentialKernel<InputType>
Type Parameters:
InputType - Input class to the Kernel
All Implemented Interfaces:
Kernel<InputType>, KernelContainer<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 ExponentialKernel<InputType>
extends DefaultKernelContainer<InputType>
implements Kernel<InputType>

The ExponentialKernel class implements a kernel that applies the exponential function to the result of another kernel.

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

Field Summary
 
Fields inherited from class gov.sandia.cognition.learning.function.kernel.DefaultKernelContainer
kernel
 
Constructor Summary
ExponentialKernel()
          Creates a new instance of ExponentialKernel.
ExponentialKernel(Kernel<? super InputType> kernel)
          Creates a new instance of ExponentialKernel.
 
Method Summary
 ExponentialKernel<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 exponential kernel takes the exponential of applying another kernel to the two given inputs.
 
Methods inherited from class gov.sandia.cognition.learning.function.kernel.DefaultKernelContainer
getKernel, setKernel
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ExponentialKernel

public ExponentialKernel()
Creates a new instance of ExponentialKernel.


ExponentialKernel

public ExponentialKernel(Kernel<? super InputType> kernel)
Creates a new instance of ExponentialKernel.

Parameters:
kernel - The kernel to use.
Method Detail

clone

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

evaluate

public double evaluate(InputType x,
                       InputType y)
The exponential kernel takes the exponential of applying another kernel to the two given inputs.

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.