# BroadcastTo

public final class **BroadcastTo** Broadcast an array for a compatible shape.


Broadcasting is the process of making arrays to have compatible shapes
for arithmetic operations. Two shapes are compatible if for each
dimension pair they are either equal or one of them is one.


For example:


\>\>\> x = tf.constant(\[\[1, 2, 3\]\]) # Shape (1, 3,)
\>\>\> y = tf.broadcast_to(x, \[2, 3\])
\>\>\> print(y)
tf.Tensor(
\[\[1 2 3\]
\[1 2 3\]\], shape=(2, 3), dtype=int32)


In the above example, the input Tensor with the shape of \`\[1, 3\]\`
is broadcasted to output Tensor with shape of \`\[2, 3\]\`.


When broadcasting, if a tensor has fewer axes than necessary its shape is
padded on the left with ones. So this gives the same result as the previous
example:


\>\>\> x = tf.constant(\[1, 2, 3\]) # Shape (3,)
\>\>\> y = tf.broadcast_to(x, \[2, 3\])


When doing broadcasted operations such as multiplying a tensor
by a scalar, broadcasting (usually) confers some time or space
benefit, as the broadcasted tensor is never materialized.


However, \`broadcast_to\` does not carry with it any such benefits.
The newly-created tensor takes the full memory of the broadcasted
shape. (In a graph context, \`broadcast_to\` might be fused to
subsequent operation and then be optimized away, however.)

<br />

<br />

<br />

<br />

<br />

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

### 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 [BroadcastTo](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/BroadcastTo)\<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\> shape)

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

##### Parameters

| scope | current scope |
| input | A Tensor to broadcast. |
| shape | An 1-D \`int\` Tensor. The shape of the desired output. |
|---|---|

##### Returns

- a new instance of BroadcastTo

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

A Tensor.