org.nd4j.parameterserver.distributed.logic.completion

Class Clipboard

java.lang.Object

org.nd4j.parameterserver.distributed.logic.completion.Clipboard

public class Clipboard
extends Object

Since VoidParameterServer assumes nearly endless asynchronous data flow, we'll use Clipboard approach to aggregate different batches of aggregates coming in un-ordered.

Author:

raver119@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<RequestDescriptor,VoidAggregation>	clipboard
protected AtomicInteger	completedCounter
protected Queue<VoidAggregation>	completedQueue
protected AtomicInteger	trackingCounter

Constructor Summary

Constructors

Constructor and Description
Clipboard()

Method Summary

Modifier and Type	Method and Description
int	getNumberOfCompleteStacks()
int	getNumberOfPinnedStacks()
VoidAggregation	getStackFromClipboard(long originatorId, long taskId)
boolean	hasCandidates() This method checks, if clipboard has ready aggregations available
boolean	isReady(long originatorId, long taskId)
boolean	isReady(VoidAggregation aggregation)
boolean	isTracking(long originatorId, long taskId)
VoidAggregation	nextCandidate() This method returns one of available aggregations, if there's at least 1 ready.
boolean	pin(VoidAggregation aggregation) This method places incoming VoidAggregation into clipboard, for further tracking
VoidAggregation	unpin(long originatorId, long taskId) This method removes given VoidAggregation from clipboard, and returns it
VoidAggregation	unpin(VoidAggregation aggregation) This method removes given VoidAggregation from clipboard, and returns it

Methods inherited from class java.lang.Object

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

Field Detail

clipboard

protected Map<RequestDescriptor,VoidAggregation> clipboard

completedQueue

protected Queue<VoidAggregation> completedQueue

trackingCounter

protected AtomicInteger trackingCounter

completedCounter

protected AtomicInteger completedCounter

Constructor Detail

Clipboard

public Clipboard()

Method Detail

pin

public boolean pin(@NonNull
                   VoidAggregation aggregation)

This method places incoming VoidAggregation into clipboard, for further tracking

Parameters:

aggregation -

Returns:

TRUE, if given VoidAggregation was the last chunk, FALSE otherwise

unpin

public VoidAggregation unpin(@NonNull
                             VoidAggregation aggregation)

This method removes given VoidAggregation from clipboard, and returns it

Parameters:

aggregation -

unpin

public VoidAggregation unpin(long originatorId,
                             long taskId)

This method removes given VoidAggregation from clipboard, and returns it

Parameters:

taskId -

hasCandidates

public boolean hasCandidates()

This method checks, if clipboard has ready aggregations available

Returns:

TRUE, if there's at least 1 candidate ready, FALSE otherwise

nextCandidate

public VoidAggregation nextCandidate()

This method returns one of available aggregations, if there's at least 1 ready.

Returns:

isReady

public boolean isReady(VoidAggregation aggregation)

isReady

public boolean isReady(long originatorId,
                       long taskId)

isTracking

public boolean isTracking(long originatorId,
                          long taskId)

getNumberOfPinnedStacks

public int getNumberOfPinnedStacks()

getNumberOfCompleteStacks

public int getNumberOfCompleteStacks()

getStackFromClipboard

public VoidAggregation getStackFromClipboard(long originatorId,
                                             long taskId)