org.tensorflow.op.core

Class QueueDequeue

java.lang.Object

org.tensorflow.op.PrimitiveOp

org.tensorflow.op.core.QueueDequeue

All Implemented Interfaces:

Iterable<Operand<Object>>, Op

@Operator
public final class QueueDequeue
extends PrimitiveOp
implements Iterable<Operand<Object>>

Dequeues a tuple of one or more tensors from the given queue.

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.

N.B. If the queue is empty, this operation will block until an element has been dequeued (or 'timeout_ms' elapses, if specified).

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class org.tensorflow.op.PrimitiveOp

operation

Method Summary

Modifier and Type	Method and Description
List<Output<?>>	components() One or more tensors that were dequeued as a tuple.
static QueueDequeue	create(Scope scope, Operand<?> handle, List<Class<?>> componentTypes, QueueDequeue.Options... options) Factory method to create a class to wrap a new QueueDequeue operation to the graph.
Iterator<Operand<Object>>	iterator()
static QueueDequeue.Options	timeoutMs(Long timeoutMs)

Methods inherited from class org.tensorflow.op.PrimitiveOp

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

create

public static QueueDequeue create(Scope scope,
                                  Operand<?> handle,
                                  List<Class<?>> componentTypes,
                                  QueueDequeue.Options... options)

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

Parameters:

scope - current graph scope

handle - The handle to a queue.

componentTypes - The type of each component in a tuple.

options - carries optional attributes values

Returns:

a new instance of QueueDequeue

timeoutMs

public static QueueDequeue.Options timeoutMs(Long timeoutMs)

Parameters:

timeoutMs - If the queue is empty, this operation will block for up to timeout_ms milliseconds. Note: This option is not supported yet.

components

public List<Output<?>> components()

One or more tensors that were dequeued as a tuple.

iterator

public Iterator<Operand<Object>> iterator()

Specified by:

iterator in interface Iterable<Operand<Object>>