gov.sandia.cognition.algorithm

Class AbstractParallelAlgorithm

java.lang.Object

gov.sandia.cognition.util.AbstractCloneableSerializable

gov.sandia.cognition.algorithm.AbstractParallelAlgorithm

All Implemented Interfaces:

ParallelAlgorithm, CloneableSerializable, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

MaximumLikelihoodDistributionEstimator

public abstract class AbstractParallelAlgorithm
extends AbstractCloneableSerializable
implements ParallelAlgorithm

Partial implementation of ParallelAlgorithm. This class automatically generates a thread pool appropriate for the number of processing units available on the current machine.

Since:

3.0

Author:

Kevin R. Dixon

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractParallelAlgorithm() Creates a new instance of AbstractParallelAlgorithm
AbstractParallelAlgorithm(java.util.concurrent.ThreadPoolExecutor threadPool) Creates a new instance of AbstractParallelAlgorithm

Method Summary

Modifier and Type	Method and Description
AbstractParallelAlgorithm	clone() This makes public the clone method on the Object class and removes the exception that it throws.
int	getNumThreads() Gets the number of threads in the thread pool.
java.util.concurrent.ThreadPoolExecutor	getThreadPool() Gets the thread pool for the algorithm to use.
void	setThreadPool(java.util.concurrent.ThreadPoolExecutor threadPool) Sets the thread pool for the algorithm to use.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractParallelAlgorithm

public AbstractParallelAlgorithm()

Creates a new instance of AbstractParallelAlgorithm

AbstractParallelAlgorithm

public AbstractParallelAlgorithm(java.util.concurrent.ThreadPoolExecutor threadPool)

Creates a new instance of AbstractParallelAlgorithm

Parameters:

threadPool - Thread pool used for parallelization.

Method Detail

clone

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

getNumThreads

public int getNumThreads()

Description copied from interface: ParallelAlgorithm

Gets the number of threads in the thread pool.

Specified by:

getNumThreads in interface ParallelAlgorithm

Returns:

Number of threads in the thread pool

getThreadPool

public java.util.concurrent.ThreadPoolExecutor getThreadPool()

Description copied from interface: ParallelAlgorithm

Gets the thread pool for the algorithm to use.

Specified by:

getThreadPool in interface ParallelAlgorithm

Returns:

Thread pool used for parallelization.

setThreadPool

public void setThreadPool(java.util.concurrent.ThreadPoolExecutor threadPool)

Description copied from interface: ParallelAlgorithm

Sets the thread pool for the algorithm to use.

Specified by:

setThreadPool in interface ParallelAlgorithm

Parameters:

threadPool - Thread pool used for parallelization.