Skip to content

Commit e6a30ce

Browse files
authored
feat: update complex/float64/base TypeScript declarations
PR-URL: #9466 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com> Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>
1 parent c681b91 commit e6a30ce

File tree

1 file changed

+39
-0
lines changed
  • lib/node_modules/@stdlib/complex/float64/base/docs/types

1 file changed

+39
-0
lines changed

lib/node_modules/@stdlib/complex/float64/base/docs/types/index.d.ts

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
/* eslint-disable max-lines */
2222

2323
import add = require( '@stdlib/complex/float64/base/add' );
24+
import add3 = require( '@stdlib/complex/float64/base/add3' );
2425
import assert = require( '@stdlib/complex/float64/base/assert' );
2526
import div = require( '@stdlib/complex/float64/base/div' );
2627
import identity = require( '@stdlib/complex/float64/base/identity' );
@@ -70,6 +71,44 @@ interface Namespace {
7071
*/
7172
add: typeof add;
7273

74+
/**
75+
* Computes the sum of three double-precision complex floating-point numbers.
76+
*
77+
* @param z1 - first complex number
78+
* @param z2 - second complex number
79+
* @param z3 - third complex number
80+
* @returns result
81+
*
82+
* @example
83+
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
84+
*
85+
* var z = new Complex128( 5.0, 3.0 );
86+
*
87+
* var out = ns.add3( z, z, z );
88+
* // returns <Complex128>[ 15.0, 9.0 ]
89+
*
90+
* @example
91+
* var Float64Array = require( '@stdlib/array/float64' );
92+
*
93+
* var out = new Float64Array( 2 );
94+
* var v = ns.add3.assign( 5.0, 3.0, 5.0, 3.0, 5.0, 3.0, out, 1, 0 );
95+
* // returns <Float64Array>[ 15.0, 9.0 ]
96+
*
97+
* var bool = ( out === v );
98+
* // returns true
99+
*
100+
* @example
101+
* var Float64Array = require( '@stdlib/array/float64' );
102+
*
103+
* var z1 = new Float64Array( [ 5.0, 3.0 ] );
104+
* var z2 = new Float64Array( [ 5.0, 3.0 ] );
105+
* var z3 = new Float64Array( [ 5.0, 3.0 ] );
106+
*
107+
* var out = ns.add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, new Float64Array( 2 ), 1, 0 );
108+
* // returns <Float64Array>[ 15.0, 9.0 ]
109+
*/
110+
add3: typeof add3;
111+
73112
/**
74113
* Base (i.e., lower-level) double-precision complex number assertion functions.
75114
*/

0 commit comments

Comments
 (0)