@Operator(group="io") public final class QueueDequeueUpTo extends PrimitiveOp implements Iterable<Operand<Object>>
This operation is not supported by all queues. If a queue does not support DequeueUpTo, then an Unimplemented error is returned.
If the queue is closed and there are more than 0 but less than `n` elements remaining, then instead of returning an OutOfRange error like QueueDequeueMany, less than `n` elements are returned immediately. If the queue is closed and there are 0 elements left in the queue, then an OutOfRange error is returned just like in QueueDequeueMany. Otherwise the behavior is identical to QueueDequeueMany:
This operation concatenates queue-element component tensors along the 0th dimension to make a single component tensor. All of the components in the dequeued tuple will have size n in the 0th dimension.
This operation has `k` outputs, where `k` is the number of components in the tuples stored in the given queue, and output `i` is the ith component of the dequeued tuple.
Modifier and Type | Class and Description |
---|---|
static class |
QueueDequeueUpTo.Options
Optional attributes for
QueueDequeueUpTo |
operation
Modifier and Type | Method and Description |
---|---|
List<Output<?>> |
components()
One or more tensors that were dequeued as a tuple.
|
static QueueDequeueUpTo |
create(Scope scope,
Operand<?> handle,
Operand<Integer> n,
List<Class<?>> componentTypes,
QueueDequeueUpTo.Options... options)
Factory method to create a class wrapping a new QueueDequeueUpTo operation.
|
Iterator<Operand<Object>> |
iterator() |
static QueueDequeueUpTo.Options |
timeoutMs(Long timeoutMs) |
equals, hashCode, op, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
forEach, spliterator
public static QueueDequeueUpTo create(Scope scope, Operand<?> handle, Operand<Integer> n, List<Class<?>> componentTypes, QueueDequeueUpTo.Options... options)
scope
- current scopehandle
- The handle to a queue.n
- The number of tuples to dequeue.componentTypes
- The type of each component in a tuple.options
- carries optional attributes valuespublic static QueueDequeueUpTo.Options timeoutMs(Long timeoutMs)
timeoutMs
- If the queue has fewer than n elements, this operation
will block for up to timeout_ms milliseconds.
Note: This option is not supported yet.Copyright © 2022. All rights reserved.