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