gov.sandia.cognition.learning.algorithm.ensemble

Class AbstractUnweightedEnsemble<MemberType>

java.lang.Object

gov.sandia.cognition.util.AbstractCloneableSerializable

gov.sandia.cognition.learning.algorithm.ensemble.AbstractUnweightedEnsemble<MemberType>

Type Parameters:

MemberType - The type of the ensemble members.

All Implemented Interfaces:

Ensemble<MemberType>, CloneableSerializable, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

AdditiveEnsemble, AveragingEnsemble

public abstract class AbstractUnweightedEnsemble<MemberType>
extends AbstractCloneableSerializable
implements Ensemble<MemberType>

An abstract implementation of the Ensemble interface for unweighted ensembles. Implements the ensemble as a list.

Since:

3.3.3

Author:

Justin Basilico

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<MemberType>	members The members of the ensemble.

Constructor Summary

Constructors

Constructor and Description
AbstractUnweightedEnsemble() Creates a new AbstractUnweightedEnsemble.
AbstractUnweightedEnsemble(java.util.List<MemberType> members) Creates a new AbstractUnweightedEnsemble with the given list of members.

Method Summary

Modifier and Type	Method and Description
void	add(MemberType member) Adds a given member to the ensemble.
AbstractUnweightedEnsemble<MemberType>	clone() This makes public the clone method on the Object class and removes the exception that it throws.
int	getMemberCount() Gets the number of members in the ensemble.
java.util.List<MemberType>	getMembers() Gets the members of the ensemble.
void	setMembers(java.util.List<MemberType> members) Sets the list of ensemble members.

Methods inherited from class java.lang.Object

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

Field Detail

members

protected java.util.List<MemberType> members

The members of the ensemble.

Constructor Detail

AbstractUnweightedEnsemble

public AbstractUnweightedEnsemble()

Creates a new AbstractUnweightedEnsemble.

AbstractUnweightedEnsemble

public AbstractUnweightedEnsemble(java.util.List<MemberType> members)

Creates a new AbstractUnweightedEnsemble with the given list of members.

Parameters:

members - The list of ensemble members.

Method Detail

clone

public AbstractUnweightedEnsemble<MemberType> 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.

add

public void add(MemberType member)

Adds a given member to the ensemble.

Parameters:

member - The ensemble member to add.

getMemberCount

public int getMemberCount()

Gets the number of members in the ensemble.

Returns:

The number of members in the ensemble.

getMembers

public java.util.List<MemberType> getMembers()

Description copied from interface: Ensemble

Gets the members of the ensemble.

Specified by:

getMembers in interface Ensemble<MemberType>

Returns:

The members of the ensemble.

setMembers

public void setMembers(java.util.List<MemberType> members)

Sets the list of ensemble members.

Parameters:

members - The list of ensemble members.