gov.sandia.cognition.util
Class AbstractRandomized

java.lang.Object
  extended by gov.sandia.cognition.util.AbstractCloneableSerializable
      extended by gov.sandia.cognition.util.AbstractRandomized
All Implemented Interfaces:
CloneableSerializable, Randomized, Serializable, Cloneable
Direct Known Subclasses:
CrossFoldCreator, ImportanceSampling, KMeansFactory, NeighborhoodGaussianClusterInitializer, RandomByTwoFoldCreator, RandomDataPartitioner, RandomSubspace, RandomSubVectorThresholdLearner, RejectionSampling, ThreeLayerFeedforwardNeuralNetwork, VectorizableCrossoverFunction, VectorizablePerturber

@CodeReviews(reviews={@CodeReview(reviewer="Kevin R. Dixon",date="2008-10-02",changesNeeded=false,comments={"Cleaned up javadoc.","Moved previous code review to CodeReview annotation.","Otherwise, looks fine."}),@CodeReview(reviewer="Kevin R. Dixon",date="2007-11-25",changesNeeded=false,comments="Looks fine.")})
public abstract class AbstractRandomized
extends AbstractCloneableSerializable
implements Randomized

The AbstractRandomized abstract class implements the Randomized interface by containing the random object in a protected field.

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

Field Summary
protected  Random random
          The random number generator for this object to use.
 
Constructor Summary
AbstractRandomized(Random random)
          Creates a new instance of AbstractRandomized with the given Random object.
 
Method Summary
 CloneableSerializable clone()
          This makes public the clone method on the Object class and removes the exception that it throws.
 Random getRandom()
          Gets the random number generator used by this object.
 void setRandom(Random random)
          Sets the random number generator used by this object.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

random

protected Random random
The random number generator for this object to use.

Constructor Detail

AbstractRandomized

public AbstractRandomized(Random random)
Creates a new instance of AbstractRandomized with the given Random object.

Parameters:
random - The random number generator to use.
Method Detail

clone

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

getRandom

public Random getRandom()
Description copied from interface: Randomized
Gets the random number generator used by this object.

Specified by:
getRandom in interface Randomized
Returns:
The random number generator used by this object.

setRandom

public void setRandom(Random random)
Description copied from interface: Randomized
Sets the random number generator used by this object.

Specified by:
setRandom in interface Randomized
Parameters:
random - The random number generator for this object to use.