8000 Auto-generated commit · stdlib-js/complex@98fe8e3 · GitHub
[go: up one dir, main page]
Skip to content

Commit 98fe8e3

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent 30cb6ac commit 98fe8e3

File tree

2 files changed

+116
-0
lines changed

2 files changed

+116
-0
lines changed

‎CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@
5454

5555
##### Features
5656

57+
- [`8409bd1`](https://github.com/stdlib-js/stdlib/commit/8409bd17639c21c94be23d8498789fca5352892b) - update namespace TypeScript declarations [(#4856)](https://github.com/stdlib-js/stdlib/pull/4856)
5758
- [`a4340c8`](https://github.com/stdlib-js/stdlib/commit/a4340c8e2aea6c40af52e3665c82e35af7b50f96) - add `muladd` to namespace
5859
- [`82ba934`](https://github.com/stdlib-js/stdlib/commit/82ba9342e9964589c7742757380c72049d5389d4) - add `scale` to namespace
5960

@@ -191,6 +192,7 @@ A total of 2 people contributed to this release. Thank you to the following cont
191192

192193
<details>
193194

195+
- [`8409bd1`](https://github.com/stdlib-js/stdlib/commit/8409bd17639c21c94be23d8498789fca5352892b) - **feat:** update namespace TypeScript declarations [(#4856)](https://github.com/stdlib-js/stdlib/pull/4856) _(by stdlib-bot)_
194196
- [`15204d7`](https://github.com/stdlib-js/stdlib/commit/15204d79d9a8dfeb4c520e6948813f29972e0aa2) - **docs:** update namespace table of contents [(#4858)](https://github.com/stdlib-js/stdlib/pull/4858) _(by stdlib-bot)_
195197
- [`eb938ff`](https://github.com/stdlib-js/stdlib/commit/eb938fff22223cbbfb04568e30a4f62f8455d3bc) - **bench:** fix incomplete refactoring _(by Athan Reines)_
196198
- [`a4340c8`](https://github.com/stdlib-js/stdlib/commit/a4340c8e2aea6c40af52e3665c82e35af7b50f96) - **feat:** add `muladd` to namespace _(by Athan Reines)_

‎float64/base/docs/types/index.d.ts

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@
2323
import add = require( './../../../../float64/base/add' );
2424
import assert = require( './../../../../float64/base/assert' );
2525
import mul = require( './../../../../float64/base/mul' );
26+
import muladd = require( './../../../../float64/base/mul-add' );
27+
import scale = require( './../../../../float64/base/scale' );
2628

2729
/**
2830
* Interface describing the `base` namespace.
@@ -51,6 +53,25 @@ interface Namespace {
5153
*
5254
* var im = imag( out );
5355
* // returns 6.0
56+
*
57+
* @example
58+
* var Float64Array = require( '@stdlib/array/float64' );
59+
*
60+
* var out = new Float64Array( 2 );
61+
* var v = ns.add.assign( 5.0, 3.0, 5.0, 3.0, out, 1, 0 );
62+
* // returns <Float64Array>[ 10.0, 6.0 ]
63+
*
64+
* var bool = ( out === v );
65+
* // returns true
66+
*
67+
* @example
68+
* var Float64Array = require( '@stdlib/array/float64' );
69+
*
70+
* var z1 = new Float64Array( [ 5.0, 3.0 ] );
71+
* var z2 = new Float64Array( [ 5.0, 3.0 ] );
72+
*
73+
* var out = ns.add.strided( z1, 1, 0, z2, 1, 0, new Float64Array( 2 ), 1, 0 );
74+
* // returns <Float64Array>[ 10.0, 6.0 ]
5475
*/
5576
add: typeof add;
5677

@@ -106,6 +127,99 @@ interface Namespace {
106127
* // returns <Float64Array>[ -13.0, -1.0 ]
107128
*/
108129
mul: typeof mul;
130+
131+
/**
132+
* Performs a multiply-add operation involving three double-precision complex floating-point numbers.
133+
*
134+
* @param alpha - complex number
135+
* @param x - complex number
136+
* @param y - complex number
137+
* @returns result
138+
*
139+
* @example
140+
* var Complex128 = require( './../../../../float64/ctor' );
141+
* var real = require( './../../../../float64/real' );
142+
* var imag = require( './../../../../float64/imag' );
143+
*
144+
* var z1 = new Complex128( 5.0, 3.0 );
145+
* // returns <Complex128>
146+
*
147+
* var z2 = new Complex128( -2.0, 1.0 );
148+
* // returns <Complex128>
149+
*
150+
* var z3 = new Complex128( 7.0, -8.0 );
151+
* // returns <Complex128>
152+
*
153+
* var out = ns.muladd( z1, z2, z3 );
154+
* // returns <Complex128>
155+
*
156+
* var re = real( out );
157+
* // returns -6.0
158+
*
159+
* var im = imag( out );
160+
* // returns -9.0
161+
*
162+
* @example
163+
* var Float64Array = require( '@stdlib/array/float64' );
164+
*
165+
* var out = ns.muladd.assign( 5.0, 3.0, -2.0, 1.0, 7.0, -8.0, new Float64Array( 2 ), 1, 0 );
166+
* // returns <Float64Array>[ -6.0, -9.0 ]
167+
*
168+
* @example
169+
* var Float64Array = require( '@stdlib/array/float64' );
170+
*
171+
* var alpha = new Float64Array( [ 5.0, 3.0 ] );
172+
* var x = new Float64Array( [ -2.0, 1.0 ] );
173+
* var y = new Float64Array( [ 7.0, -8.0 ] );
174+
*
175+
* var out = ns.muladd.strided( alpha, 1, 0, x, 1, 0, y, 1, 0, new Float64Array( 2 ), 1, 0 );
176+
* // returns <Float64Array>[ -6.0, -9.0 ]
177+
*/
178+
muladd: typeof muladd;
179+
180+
/**
181+
* Scales a double-precision complex floating-point number by a real-valued double-precision floating-point scalar constant.
182+
*
183+
* @param alpha - scalar constant
184+
* @param z - complex number
185+
* @returns result
186+
*
187+
* @example
188+
* var Complex128 = require( './../../../../float64/ctor' );
189+
* var real = require( './../../../../float64/real' );
190+
* var imag = require( './../../../../float64/imag' );
191+
*
192+
* var z = new Complex128( 5.0, 3.0 );
193+
* // returns <Complex128>
194+
*
195+
* var out = ns.scale( 5.0, z );
196+
* // returns <Complex128>
197+
*
198+
* var re = real( out );
199+
* // returns 25.0
200+
*
201+
* var im = imag( out );
202+
* // returns 15.0
203+
*
204+
* @example
205+
* var Float64Array = require( '@stdlib/array/float64' );
206+
*
207+
* var out = new Float64Array( 2 );
208+
* var v = ns.scale.assign( 5.0, 5.0, 3.0, out, 1, 0 );
209+
* // returns <Float64Array>[ 25.0, 15.0 ]
210+
*
211+
* var bool = ( out === v );
212+
* // returns true
213+
*
214+
* @example
215+
* var Float64Array = require( '@stdlib/array/float64' );
216+
*
217+
* var z = new Float64Array( [ 5.0, 3.0 ] );
218+
*
219+
* var out = ns.scale.strided( 5.0, z, 1, 0, new Float64Array( 2 ), 1, 0 );
220+
* // returns <Float64Array>[ 25.0, 15.0 ]
221+
*/
222+
scale: typeof scale;
109223
}
110224

111225
/**

0 commit comments

Comments
 (0)
0