UNPKG

1.54 kBJavaScriptView 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 { ENGINE } from '../engine';
18import { Imag } from '../kernel_names';
19import { convertToTensor } from '../tensor_util_env';
20import { op } from './operation';
21/**
22 * Returns the imaginary part of a complex (or real) tensor.
23 *
24 * Given a tensor input, this operation returns a tensor of type float that is
25 * the imaginary part of each element in input considered as a complex number.
26 * If input is real, a tensor of all zeros is returned.
27 *
28 * ```js
29 * const x = tf.complex([-2.25, 3.25], [4.75, 5.75]);
30 * tf.imag(x).print();
31 * ```
32 *
33 * @doc {heading: 'Tensors', subheading: 'Creation'}
34 */
35function imag_(input) {
36 const $input = convertToTensor(input, 'input', 'imag');
37 const inputs = { input: $input };
38 return ENGINE.runKernel(Imag, inputs);
39}
40export const imag = op({ imag_ });
41//# sourceMappingURL=imag.js.map
\No newline at end of file