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.

Nested Classes

class RandomIndexShuffle.Options Optional attributes for RandomIndexShuffle  

Public Methods

Output<T>
asOutput()
Returns the symbolic handle of a tensor.
static <T extends Number, U extends Number> RandomIndexShuffle<T>
create(Scope scope, Operand<T> index, Operand<U> seed, Operand<T> maxIndex, Options... options)
Factory method to create a class wrapping a new RandomIndexShuffle operation.
Output<T>
output()
A scalar tensor of dtype `dtype`, within [0, max_index].
static RandomIndexShuffle.Options
rounds(Long rounds)

Inherited Methods

Public Methods

public 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.

public static RandomIndexShuffle<T> create (Scope scope, Operand<T> index, Operand<U> seed, Operand<T> maxIndex, 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<T> output ()

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

public static RandomIndexShuffle.Options rounds (Long rounds)

Parameters
rounds The number of rounds to use the in block cipher.