net.myrrix.common.parallel

Class Paralleler<T>

java.lang.Object

net.myrrix.common.parallel.Paralleler<T>

Type Parameters:

T - type of value to operate on

public final class Paralleler<T>
extends Object

A convenient way of executing a large number of small tasks in parallel. The values to be operated on are provided as an Iterator over values, along with a function that does something to each value, as a Processor.

By default the work is performed on each value in a number of threads equal to the number of cores on the machines, when calling runInParallel(). The operations may also be invoked with a given ExecutorService and parallelism with runInParallel(ExecutorService, int).

Since:

1.0

Author:

Sean Owen

Constructor Summary

Constructors

Constructor and Description
Paralleler(Iterator<T> values, Processor<T> processor) Creates an instance which will apply a Processor to many values.
Paralleler(Iterator<T> values, Processor<T> processor, String name) Creates an instance which will apply a Processor to many values.

Method Summary

Methods

Modifier and Type	Method and Description
void	runInParallel() Run Processor, in as many threads as available cores, on values.
void	runInParallel(ExecutorService executor, int parallelism) Run Processor, in as many threads as available cores, on values.
void	runInSerial() Run Processor, but only in 1 thread, on values.

Methods inherited from class java.lang.Object

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

Constructor Detail

Paralleler

public Paralleler(Iterator<T> values,
          Processor<T> processor)

Creates an instance which will apply a Processor to many values.

Parameters:

values - values to be processed with processor

processor - Processor to apply to each value

Paralleler

public Paralleler(Iterator<T> values,
          Processor<T> processor,
          String name)

Creates an instance which will apply a Processor to many values.

Parameters:

values - values to be processed with processor

processor - Processor to apply to each value

name - thread name prefix

Method Detail

runInSerial

public void runInSerial()
                 throws ExecutionException

Run Processor, but only in 1 thread, on values.

Throws:

ExecutionException - if any execution fails

runInParallel

public void runInParallel()
                   throws InterruptedException,
                          ExecutionException

Run Processor, in as many threads as available cores, on values.

Throws:

ExecutionException - if any execution fails

InterruptedException

runInParallel

public void runInParallel(ExecutorService executor,
                 int parallelism)
                   throws InterruptedException,
                          ExecutionException

Run Processor, in as many threads as available cores, on values. The given ExecutorService and number of threads are used instead of a new one.

Throws:

ExecutionException - if any execution fails

InterruptedException