gov.sandia.cognition.learning.function.kernel
Class ZeroKernel

java.lang.Object
  extended by gov.sandia.cognition.util.AbstractCloneableSerializable
      extended by gov.sandia.cognition.learning.function.kernel.ZeroKernel
All Implemented Interfaces:
Kernel<Object>, CloneableSerializable, Serializable, Cloneable

@CodeReview(reviewer="Kevin R. Dixon",
            date="2009-07-08",
            changesNeeded=false,
            comments="Looks fine.")
public final class ZeroKernel
extends AbstractCloneableSerializable
implements Kernel<Object>

The ZeroKernel always returns zero. On its own it is not useful, but it is useful in combination with some other kernels when there is some aspect of the data that needs to be ignored.

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

Constructor Summary
ZeroKernel()
          Creates a new instance of ZeroKernel.
 
Method Summary
 ZeroKernel clone()
          This makes public the clone method on the Object class and removes the exception that it throws.
 double evaluate(Object x, Object y)
          Returns zero regardless of the input values.
static ZeroKernel getInstance()
          Gets the single instance of this class because it has no internal data.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ZeroKernel

public ZeroKernel()
Creates a new instance of ZeroKernel.

Method Detail

getInstance

public static ZeroKernel getInstance()
Gets the single instance of this class because it has no internal data.

Returns:
The instance of the singleton.

clone

public ZeroKernel 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(Object x,
                       Object y)
Returns zero regardless of the input values.

Specified by:
evaluate in interface Kernel<Object>
Parameters:
x - The first item.
y - The second item.
Returns:
Zero.