UNPKG

1.57 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 (a - b) * (a - b) element-wise.
21 * Supports broadcasting.
22 *
23 * ```js
24 * const a = tf.tensor1d([1, 4, 3, 16]);
25 * const b = tf.tensor1d([1, 2, 9, 4]);
26 *
27 * a.squaredDifference(b).print(); // or tf.squaredDifference(a, b)
28 * ```
29 *
30 * ```js
31 * // Broadcast squared difference a with b.
32 * const a = tf.tensor1d([2, 4, 6, 8]);
33 * const b = tf.scalar(5);
34 *
35 * a.squaredDifference(b).print(); // or tf.squaredDifference(a, b)
36 * ```
37 *
38 * @param a The first tensor.
39 * @param b The second tensor. Must have the same type as `a`.
40 *
41 * @doc {heading: 'Operations', subheading: 'Arithmetic'}
42 */
43declare function squaredDifference_<T extends Tensor>(a: Tensor | TensorLike, b: Tensor | TensorLike): T;
44export declare const squaredDifference: typeof squaredDifference_;
45export {};