# tensorflow::ops::QueueDequeueUpTo

`#include <data_flow_ops.h>`

Dequeues `n` tuples of one or more tensors from the given queue.

## Summary

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](https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/ops/queue-dequeue-many#classtensorflow_1_1ops_1_1_queue_dequeue_many), 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](https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/ops/queue-dequeue-many#classtensorflow_1_1ops_1_1_queue_dequeue_many). Otherwise the behavior is identical to [QueueDequeueMany](https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/ops/queue-dequeue-many#classtensorflow_1_1ops_1_1_queue_dequeue_many):

This operation concatenates queue-element component tensors along the 0th dimension to make a single component tensor. [All](https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/ops/all#classtensorflow_1_1ops_1_1_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.

Arguments:

- scope: A [Scope](https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope) object
- handle: The handle to a queue.
- n: The number of tuples to dequeue.
- component_types: The type of each component in a tuple.

<br />

Optional attributes (see `https://www.tensorflow.org/versions/r2.0/api_docs/cc/struct/tensorflow/ops/queue-dequeue-up-to/attrs#structtensorflow_1_1ops_1_1_queue_dequeue_up_to_1_1_attrs`):

- timeout_ms: 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.

<br />

Returns:

- `OutputList`: One or more tensors that were dequeued as a tuple.

<br />

| ### Constructors and Destructors ||
|---|---|
| `https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/ops/queue-dequeue-up-to#classtensorflow_1_1ops_1_1_queue_dequeue_up_to_1aca97813734e5ee8336249c2d1cee8630(const ::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope & scope, ::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input handle, ::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input n, const DataTypeSlice & component_types)` ||
| `https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/ops/queue-dequeue-up-to#classtensorflow_1_1ops_1_1_queue_dequeue_up_to_1a6e43ee993ab5a91d42cf6bb2ae59a53f(const ::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope & scope, ::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input handle, ::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input n, const DataTypeSlice & component_types, const https://www.tensorflow.org/versions/r2.0/api_docs/cc/struct/tensorflow/ops/queue-dequeue-up-to/attrs#structtensorflow_1_1ops_1_1_queue_dequeue_up_to_1_1_attrs & attrs)` ||

| ### Public attributes ||
|---|---|
| `https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/ops/queue-dequeue-up-to#classtensorflow_1_1ops_1_1_queue_dequeue_up_to_1a0679388d38032e4520a34428aeae1a31` | `::https://www.tensorflow.org/versions/r2.0/api_docs/cc/group/core#group__core_1gab449e6a3abd500c2f4ea93f9e89ba96c` |
| `https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/ops/queue-dequeue-up-to#classtensorflow_1_1ops_1_1_queue_dequeue_up_to_1a20f6d60f9d0837a67db6bd29d2078fad` | `https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/operation#classtensorflow_1_1_operation` |

| ### Public functions ||
|---|---|
| `https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/ops/queue-dequeue-up-to#classtensorflow_1_1ops_1_1_queue_dequeue_up_to_1a30cf1d991c2f78f4edb53783d1bda37e(size_t index) const ` | `::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/output#classtensorflow_1_1_output` |

| ### Public static functions ||
|---|---|
| `https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/ops/queue-dequeue-up-to#classtensorflow_1_1ops_1_1_queue_dequeue_up_to_1a5a0258537ccd1cc274cd984b6f97a364(int64 x)` | `https://www.tensorflow.org/versions/r2.0/api_docs/cc/struct/tensorflow/ops/queue-dequeue-up-to/attrs#structtensorflow_1_1ops_1_1_queue_dequeue_up_to_1_1_attrs` |

| ### Structs ||
|---|---|
| [tensorflow::ops::QueueDequeueUpTo::Attrs](https://www.tensorflow.org/versions/r2.0/api_docs/cc/struct/tensorflow/ops/queue-dequeue-up-to/attrs) | Optional attribute setters for [QueueDequeueUpTo](https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/ops/queue-dequeue-up-to#classtensorflow_1_1ops_1_1_queue_dequeue_up_to). |

## Public attributes

### components

```
::tensorflow::OutputList components
```

### operation

```
Operation operation
```

## Public functions

### QueueDequeueUpTo

```
 QueueDequeueUpTo(
  const ::tensorflow::Scope & scope,
  ::tensorflow::Input handle,
  ::tensorflow::Input n,
  const DataTypeSlice & component_types
)
```

### QueueDequeueUpTo

```
 QueueDequeueUpTo(
  const ::tensorflow::Scope & scope,
  ::tensorflow::Input handle,
  ::tensorflow::Input n,
  const DataTypeSlice & component_types,
  const QueueDequeueUpTo::Attrs & attrs
)
```

### operator\[\]

```
::tensorflow::Output operator[](
  size_t index
) const 
```

## Public static functions

### TimeoutMs

```
Attrs TimeoutMs(
  int64 x
)
```