-
-
Notifications
You must be signed in to change notification settings - Fork 400
/
index.d.ts
46 lines (39 loc) · 1.18 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
/*
* @license Apache-2.0
*
* Copyright (c) 2021 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// TypeScript Version: 2.0
/// <reference types="@stdlib/types"/>
import { Complex64 } from '@stdlib/types/object';
/**
* Computes the squared absolute value of a single-precision complex floating-point number.
*
* ## Notes
*
* - The absolute value of a complex number is its distance from zero.
*
* @param z - complex number
* @returns squared absolute value
*
* @example
* var Complex64 = require( `@stdlib/complex/float32` );
*
* var v = cabs2f( new Complex64( 5.0, 3.0 ) );
* // returns 34.0
*/
declare function cabs2f( z: Complex64 ): number;
// EXPORTS //
export = cabs2f;