Package org.tensorflow.op.core

Class BarrierClose

java.lang.Object

org.tensorflow.op.PrimitiveOp

org.tensorflow.op.core.BarrierClose

All Implemented Interfaces:

Op

@Operator
public final class BarrierClose
extends PrimitiveOp

Closes the given barrier.

This operation signals that no more new elements will be inserted in the given barrier. Subsequent InsertMany that try to introduce a new key will fail. Subsequent InsertMany operations that just add missing components to already existing elements will continue to succeed. Subsequent TakeMany operations will continue to succeed if sufficient completed elements remain in the barrier. Subsequent TakeMany operations that would block will fail immediately.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BarrierClose.Options	Optional attributes for BarrierClose

Field Summary

Fields inherited from class org.tensorflow.op.PrimitiveOp

operation

Method Summary

Modifier and Type	Method	Description
static BarrierClose.Options	cancelPendingEnqueues(java.lang.Boolean cancelPendingEnqueues)
static BarrierClose	create(Scope scope, Operand<java.lang.String> handle, BarrierClose.Options... options)	Factory method to create a class to wrap a new BarrierClose operation to the graph.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.tensorflow.op.PrimitiveOp

equals, hashCode, toString

Method Detail

create

public static BarrierClose create(Scope scope,
                                  Operand<java.lang.String> handle,
                                  BarrierClose.Options... options)

Factory method to create a class to wrap a new BarrierClose operation to the graph.

Parameters:

scope - current graph scope

handle - The handle to a barrier.

options - carries optional attributes values

Returns:

a new instance of BarrierClose

cancelPendingEnqueues

public static BarrierClose.Options cancelPendingEnqueues(java.lang.Boolean cancelPendingEnqueues)

Parameters:

cancelPendingEnqueues - If true, all pending enqueue requests that are blocked on the barrier's queue will be canceled. InsertMany will fail, even if no new key is introduced.