gov.sandia.cognition.learning.algorithm

Class AbstractBatchLearnerContainer<LearnerType extends BatchLearner<?,?>>

java.lang.Object

gov.sandia.cognition.util.AbstractCloneableSerializable

gov.sandia.cognition.learning.algorithm.AbstractBatchLearnerContainer<LearnerType>

Type Parameters:

LearnerType - Type of the learning algorithm contained in the object.

All Implemented Interfaces:

BatchLearnerContainer<LearnerType>, CloneableSerializable, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

BinaryVersusCategorizer.Learner, DivergencesEvaluator.Learner, EvaluatorToCategorizerAdapter.Learner, InputOutputTransformedBatchLearner, ParameterAdaptableBatchLearnerWrapper, SequencePredictionLearner, WinnerTakeAllCategorizer.Learner

public class AbstractBatchLearnerContainer<LearnerType extends BatchLearner<?,?>>
extends AbstractCloneableSerializable
implements BatchLearnerContainer<LearnerType>

An abstract class for objects that contain a batch learning algorithm.

Since:

3.0

Author:

Justin Basilico

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected LearnerType	learner The wrapped learner.

Constructor Summary

Constructors

Constructor and Description
AbstractBatchLearnerContainer() Creates a new AbstractBatchLearnerWrapper with a null learner.
AbstractBatchLearnerContainer(LearnerType learner) Creates a new AbstractBatchLearnerWrapper with the given learner.

Method Summary

Modifier and Type	Method and Description
AbstractBatchLearnerContainer<LearnerType>	clone() This makes public the clone method on the Object class and removes the exception that it throws.
LearnerType	getLearner() Gets the wrapped learner.
void	setLearner(LearnerType learner) Sets the wrapped learner.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

learner

protected LearnerType extends BatchLearner<?,?> learner

The wrapped learner.

Constructor Detail

AbstractBatchLearnerContainer

public AbstractBatchLearnerContainer()

Creates a new AbstractBatchLearnerWrapper with a null learner.

AbstractBatchLearnerContainer

public AbstractBatchLearnerContainer(LearnerType learner)

Creates a new AbstractBatchLearnerWrapper with the given learner.

Parameters:

learner - The wrapped learner.

Method Detail

clone

public AbstractBatchLearnerContainer<LearnerType> 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.

getLearner

public LearnerType getLearner()

Gets the wrapped learner.

Specified by:

getLearner in interface BatchLearnerContainer<LearnerType extends BatchLearner<?,?>>

Returns:

The wrapped learner.

setLearner

public void setLearner(LearnerType learner)

Sets the wrapped learner.

Parameters:

learner - The wrapped learner.