org.tensorflow.op.core

Class Roll<T>

java.lang.Object

org.tensorflow.op.PrimitiveOp

org.tensorflow.op.core.Roll<T>

Type Parameters:

T - data type for output() output

All Implemented Interfaces:

Op, Operand<T>

@Operator
public final class Roll<T>
extends PrimitiveOp
implements Operand<T>

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) ==> [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]) ==> [[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]) ==> [[1, 2, 3, 4, 0], [6, 7, 8, 9, 5]]
 

Field Summary

Fields inherited from class org.tensorflow.op.PrimitiveOp

operation

Method Summary

Modifier and Type	Method and Description
Output<T>	asOutput() Returns the symbolic handle of a tensor.
static <T,U extends Number,V extends Number> Roll<T>	create(Scope scope, Operand<T> input, Operand<U> shift, Operand<V> axis) Factory method to create a class to wrap a new Roll operation to the graph.
Output<T>	output() Has the same shape and size as the input.

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

Method Detail

create

public static <T,U extends Number,V extends Number> Roll<T> create(Scope scope,
                                                                   Operand<T> input,
                                                                   Operand<U> shift,
                                                                   Operand<V> axis)

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

Parameters:

scope - current graph scope

input -

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

output

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

asOutput

public Output<T> asOutput()

Description copied from interface: Operand

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.

Specified by:

asOutput in interface Operand<T>

See Also:

OperationBuilder.addInput(Output)