# RandomIndexShuffle

public final class **RandomIndexShuffle** Outputs the position of \`value\` in a permutation of \[0, ..., max_index\].


Output values are a bijection of the \`index\` for any combination and \`seed\` and \`max_index\`.


If multiple inputs are vectors (matrix in case of seed) then the size of the
first dimension must match.


The outputs are deterministic.

<br />

<br />

<br />

### Nested Classes

|---|---|---|---|
| class | [RandomIndexShuffle.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/RandomIndexShuffle.Options) || Optional attributes for `https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/RandomIndexShuffle` |

### Public Methods

|---|---|
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [asOutput](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/RandomIndexShuffle#asOutput())() Returns the symbolic handle of a tensor. |
| static \<T extends Number, U extends Number\> [RandomIndexShuffle](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/RandomIndexShuffle)\<T\> | [create](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/RandomIndexShuffle#create(org.tensorflow.op.Scope,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<U>,%20org.tensorflow.Operand<T>,%20org.tensorflow.op.core.RandomIndexShuffle.Options...))([Scope](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/Scope) scope, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> index, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<U\> seed, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> maxIndex, [Options...](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/RandomIndexShuffle.Options) options) Factory method to create a class wrapping a new RandomIndexShuffle operation. |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [output](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/RandomIndexShuffle#output())() A scalar tensor of dtype \`dtype\`, within \[0, max_index\]. |
| static [RandomIndexShuffle.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/RandomIndexShuffle.Options) | [rounds](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/RandomIndexShuffle#rounds(java.lang.Long))(Long rounds) |

### Inherited Methods

From class [org.tensorflow.op.PrimitiveOp](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp)

|---|---|
| final boolean | [equals](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#equals(java.lang.Object))(Object obj) |
| final int | [hashCode](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#hashCode())() |
| [Operation](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operation) | [op](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#op())() Returns the underlying `https://www.tensorflow.org/api_docs/java/org/tensorflow/Operation` |
| final String | [toString](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#toString())() |

From class java.lang.Object

|---|---|
| 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() |

From interface [org.tensorflow.Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)

|---|---|
| abstract [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [asOutput](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand#asOutput())() Returns the symbolic handle of a tensor. |

## Public Methods

#### public [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\>
**asOutput**
()

Returns the symbolic handle of a 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.

<br />

#### public static [RandomIndexShuffle](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/RandomIndexShuffle)\<T\>
**create**
([Scope](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/Scope) scope, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> index, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<U\> seed, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> maxIndex, [Options...](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/RandomIndexShuffle.Options) options)

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

##### Parameters

| scope | current scope |
| index | A scalar tensor or a vector of dtype \`dtype\`. The index (or indices) to be shuffled. Must be within \[0, max_index\]. |
| seed | A tensor of dtype \`Tseed\` and shape \[3\] or \[n, 3\]. The random seed. |
| maxIndex | A scalar tensor or vector of dtype \`dtype\`. The upper bound(s) of the interval (inclusive). |
| options | carries optional attributes values |
|---|---|

##### Returns

- a new instance of RandomIndexShuffle

#### public [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\>
**output**
()

A scalar tensor of dtype \`dtype\`, within \[0, max_index\]. The randomly shuffled index.

#### public static [RandomIndexShuffle.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/RandomIndexShuffle.Options)
**rounds**
(Long rounds)

<br />

##### Parameters

| rounds | The number of rounds to use the in block cipher. |
|---|---|