org.apache.reef.io.network.group.api.operators

Interface AllReduce<T>

All Superinterfaces:

GroupCommOperator

public interface AllReduce<T>
extends GroupCommOperator

MPI All Reduce Operator. Each task applies this operator on an element of type T. The result will be an element which is result of applying a reduce function on the list of all elements on which this operator has been applied

Method Summary

Methods

Modifier and Type	Method and Description
T	apply(T aElement) Apply the operation on element.
T	apply(T element, List<? extends Identifier> order) Apply the operation on element.
Reduce.ReduceFunction<T>	getReduceFunction() Get the Reduce.ReduceFunction configured.

Methods inherited from interface org.apache.reef.io.network.group.api.operators.GroupCommOperator

getGroupName, getOperName, getVersion, initialize

Method Detail

apply

T apply(T aElement)
        throws InterruptedException,
               NetworkException

Apply the operation on element.

Returns:

result of all-reduce on all elements operation was applied on. Reduce function is applied based on default order.

Throws:

InterruptedException

NetworkException

apply

T apply(T element,
      List<? extends Identifier> order)
        throws InterruptedException,
               NetworkException

Apply the operation on element.

Returns:

result of all-reduce on all elements operation was applied on. Reduce function is applied based on specified order.

Throws:

InterruptedException

NetworkException

getReduceFunction

Reduce.ReduceFunction<T> getReduceFunction()

Get the Reduce.ReduceFunction configured.

Returns:

Reduce.ReduceFunction