PriorityQueue

public final class PriorityQueue

A queue that produces elements sorted by the first component value.

Note that the PriorityQueue requires the first component of any element to be a scalar int64, in addition to the other elements declared by component_types. Therefore calls to Enqueue and EnqueueMany (resp. Dequeue and DequeueMany) on a PriorityQueue will all require (resp. output) one extra entry in their input (resp. output) lists.

Nested Classes

class PriorityQueue.Options Optional attributes for PriorityQueue  

Constants

String OP_NAME The name of this op, as known by TensorFlow core engine

Public Methods

Output<TType>
asOutput()
Returns the symbolic handle of the tensor.
static PriorityQueue.Options
capacity(Long capacity)
static PriorityQueue.Options
container(String container)
static PriorityQueue
create(Scope scope, List<Class<? extends TType>> componentTypes, List<Shape> shapes, Options... options)
Factory method to create a class wrapping a new PriorityQueue operation.
Output<?>
handle()
The handle to the queue.
static PriorityQueue.Options
sharedName(String sharedName)

Inherited Methods

org.tensorflow.op.RawOp
final boolean
equals(Object obj)
final int
hashCode()
Operation
op()
Return this unit of computation as a single Operation.
final String
toString()
boolean
equals(Object arg0)
final Class<?>
getClass()
int
hashCode()
final void
notify()
final void
notifyAll()
String
toString()
final void
wait(long arg0, int arg1)
final void
wait(long arg0)
final void
wait()
org.tensorflow.op.Op
abstract ExecutionEnvironment
env()
Return the execution environment this op was created in.
abstract Operation
op()
Return this unit of computation as a single Operation.
org.tensorflow.Operand
abstract Output<TType>
asOutput()
Returns the symbolic handle of the tensor.
abstract TType
asTensor()
Returns the tensor at this operand.
abstract Shape
shape()
Returns the (possibly partially known) shape of the tensor referred to by the Output of this operand.
abstract Class<TType>
type()
Returns the tensor type of this operand
org.tensorflow.ndarray.Shaped
abstract int
rank()
abstract Shape
shape()
abstract long
size()
Computes and returns the total size of this container, in number of values.

Constants

public static final String OP_NAME

The name of this op, as known by TensorFlow core engine

Constant Value: "PriorityQueueV2"

Public Methods

public Output<TType> asOutput ()

Returns the symbolic handle of the tensor.

Inputs to TensorFlow operations are outputs of another TensorFlow operation. This method is used to obtain a symbolic handle that represents the computation of the input.

public static PriorityQueue.Options capacity (Long capacity)

Parameters
capacity The upper bound on the number of elements in this queue. Negative numbers mean no limit.

public static PriorityQueue.Options container (String container)

Parameters
container If non-empty, this queue is placed in the given container. Otherwise, a default container is used.

public static PriorityQueue create (Scope scope, List<Class<? extends TType>> componentTypes, List<Shape> shapes, Options... options)

Factory method to create a class wrapping a new PriorityQueue operation.

Parameters
scope current scope
componentTypes The type of each component in a value.
shapes The shape of each component in a value. The length of this attr must be either 0 or the same as the length of component_types. If the length of this attr is 0, the shapes of queue elements are not constrained, and only one element may be dequeued at a time.
options carries optional attributes values
Returns
  • a new instance of PriorityQueue

public Output<?> handle ()

The handle to the queue.

public static PriorityQueue.Options sharedName (String sharedName)

Parameters
sharedName If non-empty, this queue will be shared under the given name across multiple sessions.