net.imglib2.parallel

Class ForkJoinExecutorService

java.lang.Object

java.util.concurrent.AbstractExecutorService

net.imglib2.parallel.ForkJoinExecutorService

All Implemented Interfaces:

Executor, ExecutorService

public class ForkJoinExecutorService
extends AbstractExecutorService

The ForkJoinExecutorService is an ExecutorService, for efficient nested parallelization.

The ForkJoinPool is an ExecutorService that provides an entry point to a technique called work-steeling. Work-steeling allows good performance for nested parallelization. But calling ForkJoinPool.submit(java.util.concurrent.ForkJoinTask<T>) or ForkJoinPool.invokeAll(java.util.Collection<? extends java.util.concurrent.Callable<T>>) alone, won't result in any work-steeling and performance boost. It's necessary to use ForkJoinTasks and their methods fork or invokeAll to benefit from work-steeling.

ForkJoinExecutorService is an ExecutorService that internally calls ForkJoinTask.fork() and ForkJoinTask.invokeAll(...) and therefore directly achieves good performance by work-steeling.

ForkJoinExecutorService is not a fully functional ExecutorService. Methods like shutdownNow(), awaitTermination(long, TimeUnit) and invokeAll(Collection, long, TimeUnit) are not implemented.

Constructor Summary

Constructors

Constructor and Description
ForkJoinExecutorService()

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long l, TimeUnit timeUnit)
void	execute(Runnable runnable)
int	getParallelism()
<T> List<Future<T>>	invokeAll(Collection<? extends Callable<T>> collection)
<T> List<Future<T>>	invokeAll(Collection<? extends Callable<T>> collection, long l, TimeUnit timeUnit)
boolean	isShutdown()
boolean	isTerminated()
void	shutdown()
List<Runnable>	shutdownNow()
<T> Future<T>	submit(Callable<T> callable)
Future<?>	submit(Runnable runnable)
<T> Future<T>	submit(Runnable runnable, T t)

Methods inherited from class java.util.concurrent.AbstractExecutorService

invokeAny, invokeAny, newTaskFor, newTaskFor

Methods inherited from class java.lang.Object

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

Constructor Detail

ForkJoinExecutorService

public ForkJoinExecutorService()

Method Detail

getParallelism

public int getParallelism()

shutdown

public void shutdown()

shutdownNow

public List<Runnable> shutdownNow()

isShutdown

public boolean isShutdown()

isTerminated

public boolean isTerminated()

awaitTermination

public boolean awaitTermination(long l,
                                TimeUnit timeUnit)
                         throws InterruptedException

Throws:

InterruptedException

invokeAll

public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> collection)
                              throws InterruptedException

Specified by:

invokeAll in interface ExecutorService

Overrides:

invokeAll in class AbstractExecutorService

Throws:

InterruptedException

invokeAll

public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> collection,
                                     long l,
                                     TimeUnit timeUnit)
                              throws InterruptedException

Specified by:

invokeAll in interface ExecutorService

Overrides:

invokeAll in class AbstractExecutorService

Throws:

InterruptedException

submit

public Future<?> submit(Runnable runnable)

Specified by:

submit in interface ExecutorService

Overrides:

submit in class AbstractExecutorService

submit

public <T> Future<T> submit(Runnable runnable,
                            T t)

Specified by:

submit in interface ExecutorService

Overrides:

submit in class AbstractExecutorService

submit

public <T> Future<T> submit(Callable<T> callable)

Specified by:

submit in interface ExecutorService

Overrides:

submit in class AbstractExecutorService

execute

public void execute(Runnable runnable)