# Tensor

public final class **Tensor**
A statically typed multi-dimensional array whose elements are of a type described by T.


Instances of a Tensor are
**not**
thread-safe.


**WARNING:**
Resources consumed by the Tensor object
**must**
be explicitly freed by
invoking the
`
https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#close()
`
method when the object is no longer needed. For example, using a
try-with-resources block:

    try (Tensor t = Tensor.create(...)) {
       doSomethingWith(t);
     
     }

<br />

<br />

<br />

### Public Methods

|---|---|
| boolean | [booleanValue](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#booleanValue()) () Returns the value in a scalar ` https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html ` tensor. |
| byte\[\] | [bytesValue](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#bytesValue()) () Returns the value in a scalar ` https://docs.oracle.com/javase/8/docs/api/java/lang/String.html ` tensor. |
| void | [close](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#close()) () Release resources associated with the Tensor. |
| \<U\> U | [copyTo](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#copyTo(U)) (U dst) Copies the contents of the tensor to ` dst ` and returns ` dst ` . |
| static [Tensor](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor) \<?\> | [create](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#create(java.lang.Object)) (Object obj) Creates a tensor from an object whose class is inspected to figure out what the underlying data type should be. |
| static \<T\> [Tensor](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor) \<T\> | [create](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#create(java.lang.Class<T>, long[], java.nio.ByteBuffer)) (Class\<T\> type, long\[\] shape, ByteBuffer data) Create a Tensor of any type with data from the given buffer. |
| static [Tensor](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor) \<Double\> | [create](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#create(long[], java.nio.DoubleBuffer)) (long\[\] shape, DoubleBuffer data) Create a ` https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html ` Tensor with data from the given buffer. |
| static [Tensor](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor) \<Long\> | [create](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#create(long[], java.nio.LongBuffer)) (long\[\] shape, LongBuffer data) Create an ` https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html ` Tensor with data from the given buffer. |
| static [Tensor](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor) \<Integer\> | [create](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#create(long[], java.nio.IntBuffer)) (long\[\] shape, IntBuffer data) Create a ` https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html ` Tensor with data from the given buffer. |
| static [Tensor](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor) \<Float\> | [create](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#create(long[], java.nio.FloatBuffer)) (long\[\] shape, FloatBuffer data) Create a ` https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html ` Tensor with data from the given buffer. |
| static \<T\> [Tensor](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor) \<T\> | [create](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#create(java.lang.Object, java.lang.Class<T>)) (Object obj, Class\<T\> type) Creates a Tensor from a Java object. |
| [DataType](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/DataType) | [dataType](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#dataType()) () Returns the ` https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/DataType ` of elements stored in the Tensor. |
| double | [doubleValue](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#doubleValue()) () Returns the value in a scalar ` https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html ` tensor. |
| \<U\> [Tensor](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor) \<U\> | [expect](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#expect(java.lang.Class<U>)) (Class\<U\> type) Returns this Tensor object with the type ` Tensor<U> ` . |
| float | [floatValue](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#floatValue()) () Returns the value in a scalar ` https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html ` tensor. |
| int | [intValue](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#intValue()) () Returns the value in a scalar ` https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html ` tensor. |
| long | [longValue](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#longValue()) () Returns the value in a scalar ` https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html ` tensor. |
| int | [numBytes](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#numBytes()) () Returns the size, in bytes, of the tensor data. |
| int | [numDimensions](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#numDimensions()) () Returns the number of dimensions (sometimes referred to as [rank](https://www.tensorflow.org/resources/dims_types.html#rank) ) of the Tensor. |
| int | [numElements](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#numElements()) () Returns the number of elements in a flattened (1-D) view of the tensor. |
| long\[\] | [shape](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#shape()) () Returns the [shape](https://www.tensorflow.org/resources/dims_types.html#shape) of the Tensor, i.e., the sizes of each dimension. |
| String | [toString](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#toString()) () Returns a string describing the type and shape of the Tensor. |
| void | [writeTo](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#writeTo(java.nio.LongBuffer)) (LongBuffer dst) Write the data of a ` https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html ` tensor into the given buffer. |
| void | [writeTo](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#writeTo(java.nio.DoubleBuffer)) (DoubleBuffer dst) Write the data of a ` https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html ` tensor into the given buffer. |
| void | [writeTo](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#writeTo(java.nio.IntBuffer)) (IntBuffer dst) Write the data of a ` https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html ` tensor into the given buffer. |
| void | [writeTo](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#writeTo(java.nio.ByteBuffer)) (ByteBuffer dst) Write the tensor data into the given buffer. |
| void | [writeTo](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#writeTo(java.nio.FloatBuffer)) (FloatBuffer dst) Write the data of a ` https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html ` tensor into the given buffer. |

### Inherited Methods

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 java.lang.AutoCloseable

|---|---|
| abstract void | close () |

## Public Methods


#### public boolean
**booleanValue**
()


Returns the value in a scalar
`
https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html
`
tensor.

##### Throws

| IllegalArgumentException | if the Tensor does not represent a boolean scalar. |
|---|---|


#### public byte\[\]
**bytesValue**
()


Returns the value in a scalar
`
https://docs.oracle.com/javase/8/docs/api/java/lang/String.html
`
tensor.

##### Throws

| IllegalArgumentException | if the Tensor does not represent a boolean scalar. |
|---|---|


#### public void
**close**
()


Release resources associated with the Tensor.


**WARNING:**
This must be invoked for all tensors that were not been produced by an eager
operation or memory will be leaked.


The Tensor object is no longer usable after
`
close
`
returns.

<br />

<br />


#### public U
**copyTo**
(U dst)


Copies the contents of the tensor to
`
dst
`
and returns
`
dst
`
.


For non-scalar tensors, this method copies the contents of the underlying tensor to a Java
array. For scalar tensors, use one of
`
https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#bytesValue()
`
,
`
https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#floatValue()
`
,
`
https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#doubleValue()
`
,
`
https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#intValue()
`
,
`
https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#longValue()
`
or
`
https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor#booleanValue()
`
instead.
The type and shape of
`
dst
`
must be compatible with the tensor. For example:

    int matrix[2][2] = { {1,2,{3,4} };
     try(Tensor t = Tensor.create(matrix)) {
       // Succeeds and prints "3"
       int[][] copy = new int[2][2];
       System.out.println(t.copyTo(copy)[1][0]);

       // Throws IllegalArgumentException since the shape of dst does not match the shape of t.
       int[][] dst = new int[4][1];
       t.copyTo(dst);
     }
     }

<br />

<br />

##### Throws

| IllegalArgumentException | if the tensor is a scalar or if ` dst ` is not compatible with the tensor (for example, mismatched data types or shapes). |
|---|---|


#### public static [Tensor](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor) \<?\>
**create**
(Object obj)


Creates a tensor from an object whose class is inspected to figure out what the underlying data
type should be.

##### Throws

| IllegalArgumentException | if ` obj ` is not compatible with the TensorFlow type system. |
|---|---|


#### public static [Tensor](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor) \<T\>
**create**
(Class\<T\> type, long\[\] shape, ByteBuffer data)


Create a Tensor of any type with data from the given buffer.


Creates a Tensor with the provided shape of any type where the tensor's data has been
encoded into
`
data
`
as per the specification of the TensorFlow
[C
API](https://www.tensorflow.org/code/tensorflow/c/c_api.h)
.

<br />

##### Parameters

| type | the tensor element type, represented as a class object. |
| shape | the tensor shape. |
| data | a buffer containing the tensor data. |
|---|---|

##### Throws

| IllegalArgumentException | If the tensor datatype or shape is not compatible with the buffer |
|---|---|


#### public static [Tensor](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor) \<Double\>
**create**
(long\[\] shape, DoubleBuffer data)


Create a
`
https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html
`
Tensor with data from the given buffer.


Creates a Tensor with the given shape by copying elements from the buffer (starting from its
current position) into the tensor. For example, if
`
shape = {2,3
`
} (which represents a
2x3 matrix) then the buffer must have 6 elements remaining, which will be consumed by this
method.

<br />

##### Parameters

| shape | the tensor shape. |
| data | a buffer containing the tensor data. |
|---|---|

##### Throws

| IllegalArgumentException | If the tensor shape is not compatible with the buffer |
|---|---|


#### public static [Tensor](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor) \<Long\>
**create**
(long\[\] shape, LongBuffer data)


Create an
`
https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html
`
Tensor with data from the given buffer.


Creates a Tensor with the given shape by copying elements from the buffer (starting from its
current position) into the tensor. For example, if
`
shape = {2,3
`
} (which represents a
2x3 matrix) then the buffer must have 6 elements remaining, which will be consumed by this
method.

<br />

##### Parameters

| shape | the tensor shape. |
| data | a buffer containing the tensor data. |
|---|---|

##### Throws

| IllegalArgumentException | If the tensor shape is not compatible with the buffer |
|---|---|


#### public static [Tensor](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor) \<Integer\>
**create**
(long\[\] shape, IntBuffer data)


Create a
`
https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html
`
Tensor with data from the given buffer.


Creates a Tensor with the given shape by copying elements from the buffer (starting from its
current position) into the tensor. For example, if
`
shape = {2,3
`
} (which represents a
2x3 matrix) then the buffer must have 6 elements remaining, which will be consumed by this
method.

<br />

##### Parameters

| shape | the tensor shape. |
| data | a buffer containing the tensor data. |
|---|---|

##### Throws

| IllegalArgumentException | If the tensor shape is not compatible with the buffer |
|---|---|


#### public static [Tensor](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor) \<Float\>
**create**
(long\[\] shape, FloatBuffer data)


Create a
`
https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html
`
Tensor with data from the given buffer.


Creates a Tensor with the given shape by copying elements from the buffer (starting from its
current position) into the tensor. For example, if
`
shape = {2,3
`
} (which represents a
2x3 matrix) then the buffer must have 6 elements remaining, which will be consumed by this
method.

<br />

##### Parameters

| shape | the tensor shape. |
| data | a buffer containing the tensor data. |
|---|---|

##### Throws

| IllegalArgumentException | If the tensor shape is not compatible with the buffer |
|---|---|


#### public static [Tensor](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor) \<T\>
**create**
(Object obj, Class\<T\> type)


Creates a Tensor from a Java object.


A
`
Tensor
`
is a multi-dimensional array of elements of a limited set of types. Not all
Java objects can be converted to a
`
Tensor
`
. In particular, the argument
`
obj
`
must
be either a primitive (float, double, int, long, boolean, byte) or a multi-dimensional array of
one of those primitives. The argument
`
type
`
specifies how to interpret the first
argument as a TensorFlow type. For example:

    // Valid: A 64-bit integer scalar.
     Tensor<Long> s = Tensor.create(42L, Long.class);

     // Valid: A 3x2 matrix of floats.
     float[][] matrix = new float[3][2];
     Tensor<Float> m = Tensor.create(matrix, Float.class);

     // Invalid: Will throw an IllegalArgumentException as an arbitrary Object
     // does not fit into the TensorFlow type system.
     Tensor<?> o = Tensor.create(new Object())

     // Invalid: Will throw an IllegalArgumentException since there are
     // a differing number of elements in each row of this 2-D array.
     int[][] twoD = new int[2][];
     twoD[0] = new int[1];
     twoD[1] = new int[2];
     Tensor<Integer> x = Tensor.create(twoD, Integer.class);
     
`
https://docs.oracle.com/javase/8/docs/api/java/lang/String.html
` -typed Tensors are multi-dimensional arrays of arbitrary byte sequences, so can be initialized from arrays of `
byte[]
` elements. For example:

    // Valid: A String tensor.
     Tensor<String> s = Tensor.create(new byte[]{1, 2, 3, String.class);

     // Java Strings will need to be encoded into a byte-sequence.
     String mystring = "foo";
     Tensor s = Tensor.create(mystring.getBytes("UTF-8"), String.class);

     // Valid: Matrix of String tensors.
     // Each element might have a different length.
     byte[][][] matrix = new byte[2][2][];
     matrix[0][0] = "this".getBytes("UTF-8");
     matrix[0][1] = "is".getBytes("UTF-8");
     matrix[1][0] = "a".getBytes("UTF-8");
     matrix[1][1] = "matrix".getBytes("UTF-8");
     Tensor m = Tensor.create(matrix, String.class);
     }

<br />

<br />

##### Parameters

| obj | The object to convert to a ` Tensor<T> ` . Note that whether it is compatible with the type T is not checked by the type system. For type-safe creation of tensors, use ` https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensors ` . |
| type | The class object representing the type T. |
|---|---|

##### Throws

| IllegalArgumentException | if ` obj ` is not compatible with the TensorFlow type system. |
|---|---|


#### public [DataType](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/DataType)
**dataType**
()


Returns the
`
https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/DataType
`
of elements stored in the Tensor.

#### public double
**doubleValue**
()


Returns the value in a scalar
`
https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html
`
tensor.

##### Throws

| IllegalArgumentException | if the Tensor does not represent a double scalar. |
|---|---|


#### public [Tensor](https://www.tensorflow.org/versions/r2.5/api_docs/java/org/tensorflow/Tensor) \<U\>
**expect**
(Class\<U\> type)


Returns this Tensor object with the type
`
Tensor<U>
`
. This method is useful when given a
value of type
`
Tensor<?>
`
.

##### Parameters

| type | any (non-null) array of the correct type. |
|---|---|

##### Throws

| IllegalArgumentException | if the actual data type of this object does not match the type ` U ` . |
|---|---|


#### public float
**floatValue**
()


Returns the value in a scalar
`
https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html
`
tensor.

##### Throws

| IllegalArgumentException | if the Tensor does not represent a float scalar. |
|---|---|


#### public int
**intValue**
()


Returns the value in a scalar
`
https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html
`
tensor.

##### Throws

| IllegalArgumentException | if the Tensor does not represent a int scalar. |
|---|---|


#### public long
**longValue**
()


Returns the value in a scalar
`
https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html
`
tensor.

##### Throws

| IllegalArgumentException | if the Tensor does not represent a long scalar. |
|---|---|


#### public int
**numBytes**
()


Returns the size, in bytes, of the tensor data.

#### public int
**numDimensions**
()


Returns the number of dimensions (sometimes referred to as
[rank](https://www.tensorflow.org/resources/dims_types.html#rank)
) of the Tensor.


Will be 0 for a scalar, 1 for a vector, 2 for a matrix, 3 for a 3-dimensional tensor etc.

<br />


#### public int
**numElements**
()


Returns the number of elements in a flattened (1-D) view of the tensor.

#### public long\[\]
**shape**
()


Returns the
[shape](https://www.tensorflow.org/resources/dims_types.html#shape)
of
the Tensor, i.e., the sizes of each dimension.

##### Returns

- an array where the i-th element is the size of the i-th dimension of the tensor.

#### public String
**toString**
()


Returns a string describing the type and shape of the Tensor.

#### public void
**writeTo**
(LongBuffer dst)


Write the data of a
`
https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html
`
tensor into the given buffer.


Copies
`
numElements()
`
elements to the buffer.

<br />

##### Parameters

| dst | the destination buffer |
|---|---|

##### Throws

| BufferOverflowException | If there is insufficient space in the given buffer for the data in this tensor |
| IllegalArgumentException | If the tensor datatype is not ` https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html ` |
|---|---|


#### public void
**writeTo**
(DoubleBuffer dst)


Write the data of a
`
https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html
`
tensor into the given buffer.


Copies
`
numElements()
`
elements to the buffer.

<br />

##### Parameters

| dst | the destination buffer |
|---|---|

##### Throws

| BufferOverflowException | If there is insufficient space in the given buffer for the data in this tensor |
| IllegalArgumentException | If the tensor datatype is not ` https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html ` |
|---|---|


#### public void
**writeTo**
(IntBuffer dst)


Write the data of a
`
https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html
`
tensor into the given buffer.


Copies
`
numElements()
`
elements to the buffer.

<br />

##### Parameters

| dst | the destination buffer |
|---|---|

##### Throws

| BufferOverflowException | If there is insufficient space in the given buffer for the data in this tensor |
| IllegalArgumentException | If the tensor data type is not ` https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html ` |
|---|---|


#### public void
**writeTo**
(ByteBuffer dst)


Write the tensor data into the given buffer.


Copies
`
numBytes()
`
bytes to the buffer in native byte order for primitive types.

<br />

##### Parameters

| dst | the destination buffer |
|---|---|

##### Throws

| BufferOverflowException | If there is insufficient space in the given buffer for the data in this tensor |
|---|---|


#### public void
**writeTo**
(FloatBuffer dst)


Write the data of a
`
https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html
`
tensor into the given buffer.


Copies
`
numElements()
`
elements to the buffer.

<br />

##### Parameters

| dst | the destination buffer |
|---|---|

##### Throws

| BufferOverflowException | If there is insufficient space in the given buffer for the data in this tensor |
| IllegalArgumentException | If the tensor datatype is not ` https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html ` |
|---|---|