UNPKG

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