edu.iu.dsc.tws.comms.dfw

Class AllReduce

java.lang.Object

edu.iu.dsc.tws.comms.dfw.AllReduce

All Implemented Interfaces:

DataFlowOperation

public class AllReduce
extends java.lang.Object
implements DataFlowOperation

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<java.lang.Integer>	sources

Constructor Summary

Constructors

Constructor and Description
AllReduce(Config config, TWSChannel chnl, LogicalPlan instancePlan, java.util.Set<java.lang.Integer> sources, java.util.Set<java.lang.Integer> destination, int middleTask, ReduceFunction reduceFn, SingularReceiver finalRecv, MessageType t, int redEdge, int broadEdge, boolean strm, MessageSchema messageSchema)

Method Summary

Modifier and Type	Method and Description
void	close() Close the operation
void	finish(int source) If this is a larger transfer of dataflow style, we need to finish
LogicalPlan	getLogicalPlan() Task plan associated with this operation
java.lang.String	getUniqueId() Returns a unique id for this operation.
boolean	isComplete() Weather the operation doesn't have any pending sends or receives
boolean	progress() Progress the pending dataflow operations
void	reset() Reset and get the operation to initial state
boolean	send(int source, java.lang.Object message, int flags) Send a send message, this call will work asynchronously
boolean	send(int source, java.lang.Object message, int flags, int target) Send the message on a specific path
boolean	sendPartial(int source, java.lang.Object message, int flags) Use this to inject partial results in a distributed dataflow operation
boolean	sendPartial(int source, java.lang.Object message, int flags, int target) Send partial message on a specific path

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.iu.dsc.tws.api.comms.DataFlowOperation

getDataType, getKeyType, getReceiveDataType, getReceiveKeyType, getSources, getTargets, isDelegateComplete

Field Detail

sources

protected java.util.Set<java.lang.Integer> sources

Constructor Detail

AllReduce

public AllReduce(Config config,
                 TWSChannel chnl,
                 LogicalPlan instancePlan,
                 java.util.Set<java.lang.Integer> sources,
                 java.util.Set<java.lang.Integer> destination,
                 int middleTask,
                 ReduceFunction reduceFn,
                 SingularReceiver finalRecv,
                 MessageType t,
                 int redEdge,
                 int broadEdge,
                 boolean strm,
                 MessageSchema messageSchema)

Method Detail

sendPartial

public boolean sendPartial(int source,
                           java.lang.Object message,
                           int flags)

Description copied from interface: DataFlowOperation

Use this to inject partial results in a distributed dataflow operation

Specified by:

sendPartial in interface DataFlowOperation

message - message

Returns:

true if message is accepted

send

public boolean send(int source,
                    java.lang.Object message,
                    int flags)

Description copied from interface: DataFlowOperation

Send a send message, this call will work asynchronously

Specified by:

send in interface DataFlowOperation

Parameters:

source - source task

message - message as a generic object

Returns:

true if message is accepted

send

public boolean send(int source,
                    java.lang.Object message,
                    int flags,
                    int target)

Description copied from interface: DataFlowOperation

Send the message on a specific path

Specified by:

send in interface DataFlowOperation

Parameters:

source - source task

message - a generic java object

target - target task

Returns:

true if message is accepted

sendPartial

public boolean sendPartial(int source,
                           java.lang.Object message,
                           int flags,
                           int target)

Description copied from interface: DataFlowOperation

Send partial message on a specific path

Specified by:

sendPartial in interface DataFlowOperation

Parameters:

source - the source

message - message as a generic object

target - the final target

Returns:

true if message is accepted

progress

public boolean progress()

Description copied from interface: DataFlowOperation

Progress the pending dataflow operations

Specified by:

progress in interface DataFlowOperation

Returns:

true if there is more messages to communicationProgress, unless return false

isComplete

public boolean isComplete()

Description copied from interface: DataFlowOperation

Weather the operation doesn't have any pending sends or receives

Specified by:

isComplete in interface DataFlowOperation

Returns:

is complete

close

public void close()

Description copied from interface: DataFlowOperation

Close the operation

Specified by:

close in interface DataFlowOperation

reset

public void reset()

Description copied from interface: DataFlowOperation

Reset and get the operation to initial state

Specified by:

reset in interface DataFlowOperation

finish

public void finish(int source)

Description copied from interface: DataFlowOperation

If this is a larger transfer of dataflow style, we need to finish

Specified by:

finish in interface DataFlowOperation

getLogicalPlan

public LogicalPlan getLogicalPlan()

Description copied from interface: DataFlowOperation

Task plan associated with this operation

Specified by:

getLogicalPlan in interface DataFlowOperation

Returns:

task plan

getUniqueId

public java.lang.String getUniqueId()

Description copied from interface: DataFlowOperation

Returns a unique id for this operation. This would in most case be the edge number for the given operation.

Specified by:

getUniqueId in interface DataFlowOperation

Returns:

an unique id as a String