# Roll

public final class **Roll** Rolls the elements of a tensor along an axis.


The elements are shifted positively (towards larger indices) by the offset of
\`shift\` along the dimension of \`axis\`. Negative \`shift\` values will shift
elements in the opposite direction. Elements that roll passed the last position
will wrap around to the first and vice versa. Multiple shifts along multiple
axes may be specified.


For example:

    # 't' is [0, 1, 2, 3, 4]
     roll(t, shift=2, axis=0) ==&gt; [3, 4, 0, 1, 2]
     
     # shifting along multiple dimensions
     # 't' is [[0, 1, 2, 3, 4], [5, 6, 7, 8, 9]]
     roll(t, shift=[1, -2], axis=[0, 1]) ==&gt; [[7, 8, 9, 5, 6], [2, 3, 4, 0, 1]]
     
     # shifting along the same axis multiple times
     # 't' is [[0, 1, 2, 3, 4], [5, 6, 7, 8, 9]]
     roll(t, shift=[2, -3], axis=[1, 1]) ==&gt; [[1, 2, 3, 4, 0], [6, 7, 8, 9, 5]]
     
<br />

<br />

<br />

### 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/Roll#asOutput())() Returns the symbolic handle of a tensor. |
| static \<T, U extends Number, V extends Number\> [Roll](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Roll)\<T\> | [create](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Roll#create(org.tensorflow.op.Scope,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<U>,%20org.tensorflow.Operand<V>))([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\> input, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<U\> shift, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<V\> axis) Factory method to create a class wrapping a new Roll 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/Roll#output())() Has the same shape and size as the input. |

### 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 [Roll](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Roll)\<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\> input, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<U\> shift, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<V\> axis)

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

##### Parameters

| scope | current scope |
| shift | Dimension must be 0-D or 1-D. \`shift\[i\]\` specifies the number of places by which elements are shifted positively (towards larger indices) along the dimension specified by \`axis\[i\]\`. Negative shifts will roll the elements in the opposite direction. |
| axis | Dimension must be 0-D or 1-D. \`axis\[i\]\` specifies the dimension that the shift \`shift\[i\]\` should occur. If the same axis is referenced more than once, the total shift for that axis will be the sum of all the shifts that belong to that axis. |
|---|---|

##### Returns

- a new instance of Roll

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

Has the same shape and size as the input. The elements are shifted
positively (towards larger indices) by the offsets of \`shift\` along the
dimensions of \`axis\`.