pu.pi

Class ParIteratorFactory<E>

java.lang.Object

pu.pi.ParIteratorFactory<E>

Type Parameters:

E - The type of the elements in the collection.

public class ParIteratorFactory<E>
extends java.lang.Object

This class defines the functionality of a Parallel Iterator factory. The methods return a ParIterator instance depending on the respective parameters provided.

Author:

Nasser Giacaman, Oliver Sinnen, Lama Akeila

Method Summary

Modifier and Type	Method and Description
static <E> ParIterator<E>	createParIterator(java.util.Collection<E> collection, int threadCount) A convenience method for createParIterator(Collection, int, ParIterator.Schedule, int).
static <E> ParIterator<E>	createParIterator(java.util.Collection<E> collection, int threadCount, ParIterator.Schedule schedulePol) A convenience method for createParIterator(Collection, int, ParIterator.Schedule, int).
static <E> ParIterator<E>	createParIterator(java.util.Collection<E> collection, int threadCount, ParIterator.Schedule schedulePol, int chunksize) Creates a Parallel Iterator for the specified collection, using the specified schedule policy and chunk size.
static <E> ParIterator<E>	createParIterator(java.util.Collection<E> collection, int threadCount, ParIterator.Schedule schedulePol, int chunksize, boolean ignoreBarrier) Creates a Parallel Iterator for the specified collection, using the specified schedule policy and chunk size.
static <E> ParIterator<E>	createParIterator(E[] collection, int threadCount, ParIterator.Schedule schedulePol, int chunksize, boolean ignoreBarrier) Returns a Parallel Iterator, where the collection is specified in the form of an array.
static ParIterator<java.lang.Integer>	createParIterator(int start, int size, int increment, int threadCount, ParIterator.Schedule schedulePol, int chunksize, boolean ignoreBarrier) Returns a Parallel Iterator, where the collection is specified in the form of a uniform range of integers.
static <V> ParIterator	getParDFSWorkStealingIterator(GraphAdapterInterface tree, V root, int numOfThreads) Returns a DFS Parallel Iterator with Local Stacks and work stealing mechanism.
static <V> ParIterator	getTreeIteratorDFSonDAGBottomTop(GraphAdapterInterface tree, V root, int numOfThreads)
static <V> ParIterator	getTreeIteratorDFSonDAGs(GraphAdapterInterface tree, V root, int numOfThreads)
static <V> ParIterator	getTreeParIteratorDFSonDAGBottomTop(GraphAdapterInterface graph, V root, int numOfThreads) Returns a DFS Parallel Iterator with Local Stacks and work stealing mechanism.
static <V> ParIterator	getTreeParIteratorDFSonDAGTopBottom(GraphAdapterInterface tree, V root, int numOfThreads) Returns a DFS Parallel Iterator with Local Stacks and work stealing mechanism.

Methods inherited from class java.lang.Object

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

Method Detail

createParIterator

public static <E> ParIterator<E> createParIterator(java.util.Collection<E> collection,
                                                   int threadCount,
                                                   ParIterator.Schedule schedulePol,
                                                   int chunksize,
                                                   boolean ignoreBarrier)

Creates a Parallel Iterator for the specified collection, using the specified schedule policy and chunk size. The number of threads that will be accessing the Parallel Iterator must also be provided.

Parameters:

collection - The collection that contains the elements to be shared amongst the threads.

threadCount - The number of threads that will be sharing the Parallel Iterator.

schedulePol - The schedule to use to distribute the elements.

chunksize - The chunk size used in the scheduling policy.

ignoreBarrier - If the implicit barrier should be turned off (default false.

Returns:

An instance of ParIterator.

createParIterator

public static <E> ParIterator<E> createParIterator(java.util.Collection<E> collection,
                                                   int threadCount,
                                                   ParIterator.Schedule schedulePol,
                                                   int chunksize)

Creates a Parallel Iterator for the specified collection, using the specified schedule policy and chunk size. The number of threads that will be accessing the Parallel Iterator must also be provided.

Parameters:

collection - The collection that contains the elements to be shared amongst the threads.

threadCount - The number of threads that will be sharing the Parallel Iterator.

schedulePol - The schedule to use to distribute the elements.

chunksize - The chunk size used in the scheduling policy.

Returns:

An instance of ParIterator.

createParIterator

public static <E> ParIterator<E> createParIterator(java.util.Collection<E> collection,
                                                   int threadCount)

A convenience method for createParIterator(Collection, int, ParIterator.Schedule, int).

Returns a Parallel Iterator with a dynamic scheduling policy and chunk size of 1.

Parameters:

collection - The collection that contains the elements to be shared amongst the threads.

threadCount - The number of threads that will be sharing the Parallel Iterator.

Returns:

An instance of ParIterator.

createParIterator

public static <E> ParIterator<E> createParIterator(java.util.Collection<E> collection,
                                                   int threadCount,
                                                   ParIterator.Schedule schedulePol)

A convenience method for createParIterator(Collection, int, ParIterator.Schedule, int).

Chunk size used:

• 1 if the specified schedule is DYNAMIC or GUIDED.
• Block chunk if the specified schedule is STATIC.

Parameters:

collection - The collection that contains the elements to be shared amongst the threads.

threadCount - The number of threads that will be sharing the Parallel Iterator.

schedulePol - The schedule to use to distribute the elements.

Returns:

An instance of ParIterator.

createParIterator

public static <E> ParIterator<E> createParIterator(E[] collection,
                                                   int threadCount,
                                                   ParIterator.Schedule schedulePol,
                                                   int chunksize,
                                                   boolean ignoreBarrier)

Returns a Parallel Iterator, where the collection is specified in the form of an array.

Type Parameters:

E - The type of the elements in the array.

Parameters:

collection - The array containing the elements to be shared amongst the threads.

threadCount - The number of threads that will be sharing the Parallel Iterator.

schedulePol - The schedule to use to distribute the elements.

chunksize - The chunk size used in the scheduling policy.

ignoreBarrier - If the implicit barrier should be turned off (default false.

Returns:

An instance of ParIterator.

createParIterator

public static ParIterator<java.lang.Integer> createParIterator(int start,
                                                               int size,
                                                               int increment,
                                                               int threadCount,
                                                               ParIterator.Schedule schedulePol,
                                                               int chunksize,
                                                               boolean ignoreBarrier)

Returns a Parallel Iterator, where the collection is specified in the form of a uniform range of integers.

Parameters:

start - The first value in the set.

size - The number of elements to create.

increment - The increment amongst the values.

threadCount - The number of threads that will be sharing the Parallel Iterator.

schedulePol - The schedule to use to distribute the elements.

chunksize - The chunk size used in the scheduling policy.

ignoreBarrier - If the implicit barrier should be turned off (default false.

Returns:

An instance of ParIterator.

getParDFSWorkStealingIterator

public static <V> ParIterator getParDFSWorkStealingIterator(GraphAdapterInterface tree,
                                                            V root,
                                                            int numOfThreads)

Returns a DFS Parallel Iterator with Local Stacks and work stealing mechanism. The Iterator works on Trees.

Parameters:

tree - The tree to be traversed in DFS

root - The starting node of the search

numOfThreads - The number of threads that will be sharing the DFS Parallel Iterator.

Returns:

An instance of ParIterator.

getTreeParIteratorDFSonDAGTopBottom

public static <V> ParIterator getTreeParIteratorDFSonDAGTopBottom(GraphAdapterInterface tree,
                                                                  V root,
                                                                  int numOfThreads)

Returns a DFS Parallel Iterator with Local Stacks and work stealing mechanism. The Iterator works on Trees and Directed Acyclic Graphs (DAGs). It returns nodes in DFS order from top to bottom.

Parameters:

tree - The tree or DAG to be traversed in DFS

root - The starting node of the search

numOfThreads - The number of threads that will be sharing the DFS Parallel Iterator.

Returns:

An instance of ParIterator.

getTreeParIteratorDFSonDAGBottomTop

public static <V> ParIterator getTreeParIteratorDFSonDAGBottomTop(GraphAdapterInterface graph,
                                                                  V root,
                                                                  int numOfThreads)

Returns a DFS Parallel Iterator with Local Stacks and work stealing mechanism. The Iterator works on Trees and Directed Acyclic Graphs (DAGs). It returns nodes in DFS order from bottom to top.

Parameters:

graph - The tree or DAG to be traversed in DFS

root - The starting node of the search

numOfThreads - The number of threads that will be sharing the DFS Parallel Iterator.

Returns:

An instance of ParIterator.

getTreeIteratorDFSonDAGBottomTop

public static <V> ParIterator getTreeIteratorDFSonDAGBottomTop(GraphAdapterInterface tree,
                                                               V root,
                                                               int numOfThreads)

getTreeIteratorDFSonDAGs

public static <V> ParIterator getTreeIteratorDFSonDAGs(GraphAdapterInterface tree,
                                                       V root,
                                                       int numOfThreads)