Skip to content

Commit 1c8117d

Browse files
Update native.js
Signed-off-by: Gautam sharma <[email protected]>
1 parent 8ed22a1 commit 1c8117d

File tree

1 file changed

+33
-31
lines changed
  • lib/node_modules/@stdlib/math/base/special/cphase/lib

1 file changed

+33
-31
lines changed
Lines changed: 33 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,48 @@
11
/**
2-
* @license Apache-2.0
3-
*
4-
* Copyright (c) 2023 The Stdlib Authors.
5-
*
6-
* Licensed under the Apache License, Version 2.0 (the "License");
7-
* you may not use this file except in compliance with the License.
8-
* You may obtain a copy of the License at
9-
*
10-
* http://www.apache.org/licenses/LICENSE-2.0
11-
*
12-
* Unless required by applicable law or agreed to in writing, software
13-
* distributed under the License is distributed on an "AS IS" BASIS,
14-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15-
* See the License for the specific language governing permissions and
16-
* limitations under the License.
17-
*/
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2023 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
1818

1919
'use strict';
2020

2121
// MODULES //
2222

23-
var addon = require('./../src/addon.node');
23+
var addon = require( './../src/addon.node' );
24+
2425

2526
// MAIN //
2627

2728
/**
28-
* Computes the phase (argument) of a complex number.
29-
*
30-
* @private
31-
* @param {Complex128} z - complex number
32-
* @returns {number} argument
33-
*
34-
* @example
35-
* var Complex128 = require('@stdlib/complex/float64/ctor');
36-
*
37-
* var phi = cphase(new Complex128(5.0, 3.0));
38-
* // returns ~0.5404
39-
*/
40-
function cphase(z) {
41-
return addon(z);
29+
* Computes the argument of a double-precision complex floating-point number in radians.
30+
*
31+
* @private
32+
* @param {Complex128} z - complex number
33+
* @returns {number} argument
34+
*
35+
* @example
36+
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
37+
38+
* var phi = cphase( new Complex128( 5.0, 3.0 ) );
39+
* // returns ~0.5404
40+
*/
41+
function cphase( z ) {
42+
return addon( z );
4243
}
4344

45+
4446
// EXPORTS //
4547

4648
module.exports = cphase;

0 commit comments

Comments
 (0)