UNPKG

1.65 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/floorDiv" />
18import { Tensor } from '../tensor';
19import { TensorLike } from '../types';
20/**
21 * Divides two `tf.Tensor`s element-wise, A / B. Supports broadcasting.
22 * The result is rounded with floor function.
23 *
24 *
25 * ```js
26 * const a = tf.tensor1d([1, 4, 9, 16]);
27 * const b = tf.tensor1d([1, 2, 3, 4]);
28 *
29 * a.floorDiv(b).print(); // or tf.div(a, b)
30 * ```
31 *
32 * ```js
33 * // Broadcast div a with b.
34 * const a = tf.tensor1d([2, 4, 6, 8]);
35 * const b = tf.scalar(2);
36 *
37 * a.floorDiv(b).print(); // or tf.floorDiv(a, b)
38 * ```
39 *
40 * @param a The first tensor as the numerator.
41 * @param b The second tensor as the denominator. Must have the same dtype as
42 * `a`.
43 *
44 * @doc {heading: 'Operations', subheading: 'Arithmetic'}
45 */
46declare function floorDiv_<T extends Tensor>(a: Tensor | TensorLike, b: Tensor | TensorLike): T;
47export declare const floorDiv: typeof floorDiv_;
48export {};