UNPKG

1.4 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/imag" />
18import { Tensor } from '../tensor';
19import { TensorLike } from '../types';
20/**
21 * Returns the imaginary part of a complex (or real) tensor.
22 *
23 * Given a tensor input, this operation returns a tensor of type float that is
24 * the imaginary part of each element in input considered as a complex number.
25 * If input is real, a tensor of all zeros is returned.
26 *
27 * ```js
28 * const x = tf.complex([-2.25, 3.25], [4.75, 5.75]);
29 * tf.imag(x).print();
30 * ```
31 *
32 * @doc {heading: 'Tensors', subheading: 'Creation'}
33 */
34declare function imag_<T extends Tensor>(input: T | TensorLike): T;
35export declare const imag: typeof imag_;
36export {};