Skip to content

Commit a921830

Browse files
authored
feat: update complex/float32/base TypeScript declarations
PR-URL: #11112 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent b6cd4ce commit a921830

File tree

1 file changed

+76
-0
lines changed
  • lib/node_modules/@stdlib/complex/float32/base/docs/types

1 file changed

+76
-0
lines changed

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

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

2323
import add = require( '@stdlib/complex/float32/base/add' );
24+
import add3 = require( '@stdlib/complex/float32/base/add3' );
2425
import assert = require( '@stdlib/complex/float32/base/assert' );
2526
import identity = require( '@stdlib/complex/float32/base/identity' );
2627
import mul = require( '@stdlib/complex/float32/base/mul' );
28+
import muladd = require( '@stdlib/complex/float32/base/mul-add' );
2729
import neg = require( '@stdlib/complex/float32/base/neg' );
2830
import scale = require( '@stdlib/complex/float32/base/scale' );
2931
import sub = require( '@stdlib/complex/float32/base/sub' );
@@ -68,6 +70,44 @@ interface Namespace {
6870
*/
6971
add: typeof add;
7072

73+
/**
74+
* Computes the sum of three single-precision complex floating-point numbers.
75+
*
76+
* @param z1 - first complex number
77+
* @param z2 - second complex number
78+
* @param z3 - third complex number
79+
* @returns result
80+
*
81+
* @example
82+
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
83+
*
84+
* var z = new Complex64( 5.0, 3.0 );
85+
*
86+
* var out = ns.add3( z, z, z );
87+
* // returns <Complex64>[ 15.0, 9.0 ]
88+
*
89+
* @example
90+
* var Float32Array = require( '@stdlib/array/float32' );
91+
*
92+
* var out = new Float32Array( 2 );
93+
* var v = ns.add3.assign( 5.0, 3.0, 5.0, 3.0, 5.0, 3.0, out, 1, 0 );
94+
* // returns <Float32Array>[ 15.0, 9.0 ]
95+
*
96+
* var bool = ( out === v );
97+
* // returns true
98+
*
99+
* @example
100+
* var Float32Array = require( '@stdlib/array/float32' );
101+
*
102+
* var z1 = new Float32Array( [ 5.0, 3.0 ] );
103+
* var z2 = new Float32Array( [ 5.0, 3.0 ] );
104+
* var z3 = new Float32Array( [ 5.0, 3.0 ] );
105+
*
106+
* var out = ns.add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, new Float32Array( 2 ), 1, 0 );
107+
* // returns <Float32Array>[ 15.0, 9.0 ]
108+
*/
109+
add3: typeof add3;
110+
71111
/**
72112
* Base (i.e., lower-level) single-precision complex number assertion functions.
73113
*/
@@ -124,6 +164,42 @@ interface Namespace {
124164
*/
125165
mul: typeof mul;
126166

167+
/**
168+
* Performs a multiply-add operation involving three single-precision complex floating-point numbers.
169+
*
170+
* @param alpha - complex number
171+
* @param x - complex number
172+
* @param y - complex number
173+
* @returns result
174+
*
175+
* @example
176+
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
177+
*
178+
* var z1 = new Complex64( 5.0, 3.0 );
179+
* var z2 = new Complex64( -2.0, 1.0 );
180+
* var z3 = new Complex64( 7.0, -8.0 );
181+
*
182+
* var out = ns.muladd( z1, z2, z3 );
183+
* // returns <Complex64>[ -6.0, -9.0 ]
184+
*
185+
* @example
186+
* var Float32Array = require( '@stdlib/array/float32' );
187+
*
188+
* var out = ns.muladd.assign( 5.0, 3.0, -2.0, 1.0, 7.0, -8.0, new Float32Array( 2 ), 1, 0 );
189+
* // returns <Float32Array>[ -6.0, -9.0 ]
190+
*
191+
* @example
192+
* var Float32Array = require( '@stdlib/array/float32' );
193+
*
194+
* var alpha = new Float32Array( [ 5.0, 3.0 ] );
195+
* var x = new Float32Array( [ -2.0, 1.0 ] );
196+
* var y = new Float32Array( [ 7.0, -8.0 ] );
197+
*
198+
* var out = ns.muladd.strided( alpha, 1, 0, x, 1, 0, y, 1, 0, new Float32Array( 2 ), 1, 0 );
199+
* // returns <Float32Array>[ -6.0, -9.0 ]
200+
*/
201+
muladd: typeof muladd;
202+
127203
/**
128204
* Negates a single-precision complex floating-point number.
129205
*

0 commit comments

Comments
 (0)