UNPKG

1.66 kBTypeScriptView Raw
1/**
2 * @license
3 * Copyright 2020 Google LLC. All Rights Reserved.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 * =============================================================================
16 */
17/// <amd-module name="@tensorflow/tfjs-core/dist/ops/broadcast_to" />
18import { Tensor } from '../tensor';
19import { Rank, ShapeMap, TensorLike } from '../types';
20/**
21 * Broadcast an array to a compatible shape NumPy-style.
22 *
23 * The tensor's shape is compared to the broadcast shape from end to beginning.
24 * Ones are prepended to the tensor's shape until is has the same length as
25 * the broadcast shape. If input.shape[i]==shape[i], the (i+1)-th axis is
26 * already broadcast-compatible. If input.shape[i]==1 and shape[i]==N, then
27 * the input tensor is tiled N times along that axis (using tf.tile).
28 *
29 * @param input The tensor that is to be broadcasted.
30 * @param shape The input is to be broadcast to this shape.
31 *
32 * @doc {heading: 'Tensors', subheading: 'Transformations'}
33 */
34declare function broadcastTo_<R extends Rank>(x: Tensor | TensorLike, shape: ShapeMap[R]): Tensor<R>;
35export declare const broadcastTo: typeof broadcastTo_;
36export {};