UNPKG

1.72 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/minimum" />
18import { Tensor } from '../tensor';
19import { TensorLike } from '../types';
20/**
21 * Returns the min of a and b (`a < b ? a : b`) element-wise.
22 * Supports broadcasting.
23 *
24 * We also expose `minimumStrict` which has the same signature as this op and
25 * asserts that `a` and `b` are the same shape (does not broadcast).
26 *
27 * ```js
28 * const a = tf.tensor1d([1, 4, 3, 16]);
29 * const b = tf.tensor1d([1, 2, 9, 4]);
30 *
31 * a.minimum(b).print(); // or tf.minimum(a, b)
32 * ```
33 *
34 * ```js
35 * // Broadcast minimum a with b.
36 * const a = tf.tensor1d([2, 4, 6, 8]);
37 * const b = tf.scalar(5);
38 *
39 * a.minimum(b).print(); // or tf.minimum(a, b)
40 * ```
41 *
42 * @param a The first tensor.
43 * @param b The second tensor. Must have the same type as `a`.
44 *
45 * @doc {heading: 'Operations', subheading: 'Arithmetic'}
46 */
47declare function minimum_<T extends Tensor>(a: Tensor | TensorLike, b: Tensor | TensorLike): T;
48export declare const minimum: typeof minimum_;
49export {};