Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2837,7 +2837,7 @@ interface Namespace {
*
* @param N - number of indexed elements
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns sum
*
* @example
Expand Down Expand Up @@ -2915,7 +2915,7 @@ interface Namespace {
*
* @param N - number of indexed elements
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns input array
*
* @example
Expand Down
114 changes: 114 additions & 0 deletions lib/node_modules/@stdlib/complex/float64/base/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@
import add = require( '@stdlib/complex/float64/base/add' );
import assert = require( '@stdlib/complex/float64/base/assert' );
import mul = require( '@stdlib/complex/float64/base/mul' );
import muladd = require( '@stdlib/complex/float64/base/mul-add' );
import scale = require( '@stdlib/complex/float64/base/scale' );

/**
* Interface describing the `base` namespace.
Expand Down Expand Up @@ -51,6 +53,25 @@ interface Namespace {
*
* var im = imag( out );
* // returns 6.0
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var out = new Float64Array( 2 );
* var v = ns.add.assign( 5.0, 3.0, 5.0, 3.0, out, 1, 0 );
* // returns <Float64Array>[ 10.0, 6.0 ]
*
* var bool = ( out === v );
* // returns true
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var z1 = new Float64Array( [ 5.0, 3.0 ] );
* var z2 = new Float64Array( [ 5.0, 3.0 ] );
*
* var out = ns.add.strided( z1, 1, 0, z2, 1, 0, new Float64Array( 2 ), 1, 0 );
* // returns <Float64Array>[ 10.0, 6.0 ]
*/
add: typeof add;

Expand Down Expand Up @@ -106,6 +127,99 @@ interface Namespace {
* // returns <Float64Array>[ -13.0, -1.0 ]
*/
mul: typeof mul;

/**
* Performs a multiply-add operation involving three double-precision complex floating-point numbers.
*
* @param alpha - complex number
* @param x - complex number
* @param y - complex number
* @returns result
*
* @example
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
* var real = require( '@stdlib/complex/float64/real' );
* var imag = require( '@stdlib/complex/float64/imag' );
*
* var z1 = new Complex128( 5.0, 3.0 );
* // returns <Complex128>
*
* var z2 = new Complex128( -2.0, 1.0 );
* // returns <Complex128>
*
* var z3 = new Complex128( 7.0, -8.0 );
* // returns <Complex128>
*
* var out = ns.muladd( z1, z2, z3 );
* // returns <Complex128>
*
* var re = real( out );
* // returns -6.0
*
* var im = imag( out );
* // returns -9.0
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var out = ns.muladd.assign( 5.0, 3.0, -2.0, 1.0, 7.0, -8.0, new Float64Array( 2 ), 1, 0 );
* // returns <Float64Array>[ -6.0, -9.0 ]
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var alpha = new Float64Array( [ 5.0, 3.0 ] );
* var x = new Float64Array( [ -2.0, 1.0 ] );
* var y = new Float64Array( [ 7.0, -8.0 ] );
*
* var out = ns.muladd.strided( alpha, 1, 0, x, 1, 0, y, 1, 0, new Float64Array( 2 ), 1, 0 );
* // returns <Float64Array>[ -6.0, -9.0 ]
*/
muladd: typeof muladd;

/**
* Scales a double-precision complex floating-point number by a real-valued double-precision floating-point scalar constant.
*
* @param alpha - scalar constant
* @param z - complex number
* @returns result
*
* @example
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
* var real = require( '@stdlib/complex/float64/real' );
* var imag = require( '@stdlib/complex/float64/imag' );
*
* var z = new Complex128( 5.0, 3.0 );
* // returns <Complex128>
*
* var out = ns.scale( 5.0, z );
* // returns <Complex128>
*
* var re = real( out );
* // returns 25.0
*
* var im = imag( out );
* // returns 15.0
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var out = new Float64Array( 2 );
* var v = ns.scale.assign( 5.0, 5.0, 3.0, out, 1, 0 );
* // returns <Float64Array>[ 25.0, 15.0 ]
*
* var bool = ( out === v );
* // returns true
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var z = new Float64Array( [ 5.0, 3.0 ] );
*
* var out = ns.scale.strided( 5.0, z, 1, 0, new Float64Array( 2 ), 1, 0 );
* // returns <Float64Array>[ 25.0, 15.0 ]
*/
scale: typeof scale;
}

/**
Expand Down
19 changes: 19 additions & 0 deletions lib/node_modules/@stdlib/math/base/ops/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,25 @@ interface Namespace {
*
* var im = imag( out );
* // returns 6.0
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var out = new Float64Array( 2 );
* var v = ns.cadd.assign( 5.0, 3.0, 5.0, 3.0, out, 1, 0 );
* // returns <Float64Array>[ 10.0, 6.0 ]
*
* var bool = ( out === v );
* // returns true
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var z1 = new Float64Array( [ 5.0, 3.0 ] );
* var z2 = new Float64Array( [ 5.0, 3.0 ] );
*
* var out = ns.cadd.strided( z1, 1, 0, z2, 1, 0, new Float64Array( 2 ), 1, 0 );
* // returns <Float64Array>[ 10.0, 6.0 ]
*/
cadd: typeof cadd;

Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4736,7 +4736,7 @@ interface Namespace {
*
* @param N - number of indexed elements
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns arithmetic mean
*
* @example
Expand Down
Loading