Skip to content

docs: update namespace TypeScript declarations #5308

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 19, 2025
Merged

docs: update namespace TypeScript declarations #5308

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
60 changes: 30 additions & 30 deletions lib/node_modules/@stdlib/math/base/ops/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ import caddf = require( '@stdlib/complex/float32/base/add' );
import cmulf = require( '@stdlib/complex/float32/base/mul' );
import cadd = require( '@stdlib/complex/float64/base/add' );
import cmul = require( '@stdlib/complex/float64/base/mul' );
import addf = require( '@stdlib/number/float32/base/add' );
import cdiv = require( '@stdlib/math/base/ops/cdiv' );
import cneg = require( '@stdlib/math/base/ops/cneg' );
import cnegf = require( '@stdlib/math/base/ops/cnegf' );
Expand All @@ -40,6 +39,7 @@ import sub = require( '@stdlib/math/base/ops/sub' );
import subf = require( '@stdlib/math/base/ops/subf' );
import umul = require( '@stdlib/math/base/ops/umul' );
import umuldw = require( '@stdlib/math/base/ops/umuldw' );
import addf = require( '@stdlib/number/float32/base/add' );

/**
* Interface describing the `ops` namespace.
Expand Down Expand Up @@ -212,35 +212,6 @@ interface Namespace {
*/
cmul: typeof cmul;

/**
* Computes the sum of two single-precision floating-point numbers `x` and `y`.
*
* @param x - first input value
* @param y - second input value
* @returns sum
*
* @example
* var v = ns.addf( -1.0, 5.0 );
* // returns 4.0
*
* @example
* var v = ns.addf( 2.0, 5.0 );
* // returns 7.0
*
* @example
* var v = ns.addf( 0.0, 5.0 );
* // returns 5.0
*
* @example
* var v = ns.addf( -0.0, 0.0 );
* // returns 0.0
*
* @example
* var v = ns.addf( NaN, NaN );
* // returns NaN
*/
addf: typeof addf;

/**
* Divides two double-precision complex floating-point numbers.
*
Expand Down Expand Up @@ -679,6 +650,35 @@ interface Namespace {
* // returns [ 954437176, 1908874354 ]
*/
umuldw: typeof umuldw;

/**
* Computes the sum of two single-precision floating-point numbers `x` and `y`.
*
* @param x - first input value
* @param y - second input value
* @returns sum
*
* @example
* var v = ns.addf( -1.0, 5.0 );
* // returns 4.0
*
* @example
* var v = ns.addf( 2.0, 5.0 );
* // returns 7.0
*
* @example
* var v = ns.addf( 0.0, 5.0 );
* // returns 5.0
*
* @example
* var v = ns.addf( -0.0, 0.0 );
* // returns 0.0
*
* @example
* var v = ns.addf( NaN, NaN );
* // returns NaN
*/
addf: typeof addf;
}

/**
Expand Down
Loading