Skip to content

Commit 3be1840

Browse files
github-actions[bot]kgryte
github-actions[bot]
and
kgryte
authored
Update namespace TypeScript declarations (stdlib-js#582)
Co-authored-by: kgryte <kgryte@users.noreply.github.com>
1 parent 0b21908 commit 3be1840

File tree

13 files changed

+436
-4
lines changed

13 files changed

+436
-4
lines changed

‎lib/node_modules/@stdlib/assert/docs/types/index.d.ts‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,7 @@ import isDateObjectArray = require( '@stdlib/assert/is-date-object-array' );
125125
import isDigitString = require( '@stdlib/assert/is-digit-string' );
126126
import IS_DOCKER = require( '@stdlib/assert/is-docker' );
127127
import isDomainName = require( '@stdlib/assert/is-domain-name' );
128+
import isDurationString = require( '@stdlib/assert/is-duration-string' );
128129
import IS_ELECTRON = require( '@stdlib/assert/is-electron' );
129130
import IS_ELECTRON_MAIN = require( '@stdlib/assert/is-electron-main' );
130131
import IS_ELECTRON_RENDERER = require( '@stdlib/assert/is-electron-renderer' );
@@ -2447,6 +2448,38 @@ interface Namespace {
24472448
*/
24482449
isDomainName: typeof isDomainName;
24492450

2451+
/**
2452+
* Tests if a value is a duration string.
2453+
*
2454+
* ## Notes
2455+
*
2456+
* - The function validates that a value is a string. For all other types, the function returns `false`.
2457+
*
2458+
* - A duration string is a string containing a sequence of time units. A time unit is a non-negative integer followed by a unit identifier. The following unit identifiers are supported:
2459+
*
2460+
* - `d`: days
2461+
* - `h`: hours
2462+
* - `m`: minutes
2463+
* - `s`: seconds
2464+
* - `ms`: milliseconds
2465+
*
2466+
* For example, the string `1m3s10ms` is a duration string containing three time units: `1m` (1 minute), `3s` (3 seconds), and `10ms` (10 milliseconds). The string `60m` is a duration string containing a single time unit: `60m` (60 minutes). Time units must be supplied in descending order of magnitude (i.e., days, hours, minutes, seconds, milliseconds).
2467+
*
2468+
* - Duration strings are case insensitive. For example, the string `1M3S10MS` is equivalent to `1m3s10ms`.
2469+
*
2470+
* @param value - value to test
2471+
* @returns boolean indicating if a value is a duration string
2472+
*
2473+
* @example
2474+
* var bool = ns.isDurationString( '1d' );
2475+
* // returns true
2476+
*
2477+
* @example
2478+
* var bool = ns.isDurationString( '1d2h' );
2479+
* // returns true
2480+
*/
2481+
isDurationString: typeof isDurationString;
2482+
24502483
/**
24512484
* Boolean indicating if the runtime is Electron.
24522485
*

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

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,55 @@
2121
/* tslint:disable:max-line-length */
2222
/* tslint:disable:max-file-line-count */
2323

24+
import wrap = require( '@stdlib/complex/base/wrap-function' );
25+
2426
/**
2527
* Interface describing the `base` namespace.
2628
*/
27-
interface Namespace {}
29+
interface Namespace {
30+
/**
31+
* Wraps an n-ary function accepting complex number arguments to support providing both real and complex numbers.
32+
*
33+
* ## Notes
34+
*
35+
* - The returned function **assumes** that the wrapped function accepts **only** complex number input arguments (i.e., every argument must be a complex number).
36+
* - The returned function **assumes** that, if an input argument is non-numeric (i.e., not of type `number`), then the input argument is a complex number. The returned function does **not** verify that non-numeric input arguments are, in fact, complex number objects. The returned function passes non-numeric input arguments to the wrapped function without modification.
37+
*
38+
* @param fcn - function to wrap
39+
* @param nargs - number of arguments
40+
* @param ctor - complex number constructor
41+
* @throws second argument must be a nonnegative integer
42+
* @returns wrapped function
43+
*
44+
* @example
45+
* var Complex64 = require( `@stdlib/complex/float32` );
46+
* var realf = require( `@stdlib/complex/realf` );
47+
* var imagf = require( `@stdlib/complex/imagf` );
48+
*
49+
* function add( x, y, z, w, v, t ) {
50+
* var re = realf( x ) + realf( y ) + realf( z ) + realf( w ) + realf( v ) + realf( t );
51+
* var im = imagf( x ) + imagf( y ) + imagf( z ) + imagf( w ) + imagf( v ) + imagf( t );
52+
* return new Complex64( re, im );
53+
* }
54+
*
55+
* var f = ns.wrap( add, 6, Complex64 );
56+
*
57+
* // ...
58+
*
59+
* var z = f( 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 );
60+
* // returns <Complex64>
61+
*
62+
* var re = realf( z );
63+
* // returns 33.0
64+
*
65+
* var im = imagf( z );
66+
* // returns 0.0
67+
*/
68+
wrap: typeof wrap;
69+
}
2870

2971
/**
30-
* Base (i.e., lower-level) complex number functions.
72+
* Base (i.e., lower-level) complex number functions
3173
*/
3274
declare var ns: Namespace;
3375

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
/* tslint:disable:max-line-length */
2222
/* tslint:disable:max-file-line-count */
2323

24+
import base = require( '@stdlib/complex/base' );
2425
import complex = require( '@stdlib/complex/cmplx' );
2526
import conj = require( '@stdlib/complex/conj' );
2627
import conjf = require( '@stdlib/complex/conjf' );
@@ -44,6 +45,11 @@ import reviveComplex128 = require( '@stdlib/complex/reviver-float64' );
4445
* Interface describing the `complex` namespace.
4546
*/
4647
interface Namespace {
48+
/**
49+
* Base (i.e., lower-level) complex number functions
50+
*/
51+
base: typeof base;
52+
4753
/**
4854
* Creates a complex number.
4955
*

‎lib/node_modules/@stdlib/math/base/assert/docs/types/index.d.ts‎

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,16 @@ import isInfinitef = require( '@stdlib/math/base/assert/is-infinitef' );
3333
import isInteger = require( '@stdlib/math/base/assert/is-integer' );
3434
import isnan = require( '@stdlib/math/base/assert/is-nan' );
3535
import isnanf = require( '@stdlib/math/base/assert/is-nanf' );
36+
import isNegativeFinite = require( '@stdlib/math/base/assert/is-negative-finite' );
3637
import isNegativeInteger = require( '@stdlib/math/base/assert/is-negative-integer' );
3738
import isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' );
3839
import isNegativeZerof = require( '@stdlib/math/base/assert/is-negative-zerof' );
40+
import isNonNegativeFinite = require( '@stdlib/math/base/assert/is-nonnegative-finite' );
3941
import isNonNegativeInteger = require( '@stdlib/math/base/assert/is-nonnegative-integer' );
42+
import isNonPositiveFinite = require( '@stdlib/math/base/assert/is-nonpositive-finite' );
4043
import isNonPositiveInteger = require( '@stdlib/math/base/assert/is-nonpositive-integer' );
4144
import isOdd = require( '@stdlib/math/base/assert/is-odd' );
45+
import isPositiveFinite = require( '@stdlib/math/base/assert/is-positive-finite' );
4246
import isPositiveInteger = require( '@stdlib/math/base/assert/is-positive-integer' );
4347
import isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' );
4448
import isPositiveZerof = require( '@stdlib/math/base/assert/is-positive-zerof' );
@@ -300,6 +304,34 @@ interface Namespace {
300304
*/
301305
isnanf: typeof isnanf;
302306

307+
/**
308+
* Tests if a double-precision floating-point numeric value is a negative finite number.
309+
*
310+
* @param x - value to test
311+
* @returns boolean indicating whether the value is a negative finite number
312+
*
313+
* @example
314+
* var bool = ns.isNegativeFinite( -3.14 );
315+
* // returns true
316+
*
317+
* @example
318+
* var bool = ns.isNegativeFinite( -Infinity );
319+
* // returns false
320+
*
321+
* @example
322+
* var bool = ns.isNegativeFinite( 2.0 );
323+
* // returns false
324+
*
325+
* @example
326+
* var bool = ns.isNegativeFinite( NaN );
327+
* // returns false
328+
*
329+
* @example
330+
* var bool = ns.isNegativeFinite( -0.0 );
331+
* // returns false
332+
*/
333+
isNegativeFinite: typeof isNegativeFinite;
334+
303335
/**
304336
* Tests if a finite double-precision floating-point number is a negative integer.
305337
*
@@ -356,6 +388,38 @@ interface Namespace {
356388
*/
357389
isNegativeZerof: typeof isNegativeZerof;
358390

391+
/**
392+
* Tests if a double-precision floating-point numeric value is a nonnegative finite number.
393+
*
394+
* @param x - value to test
395+
* @returns boolean indicating whether the value is a nonnegative finite number
396+
*
397+
* @example
398+
* var bool = ns.isNonNegativeFinite( 5.0 );
399+
* // returns true
400+
*
401+
* @example
402+
* var bool = ns.isNonNegativeFinite( 3.14 );
403+
* // returns true
404+
*
405+
* @example
406+
* var bool = ns.isNonNegativeFinite( 0.0 );
407+
* // returns true
408+
*
409+
* @example
410+
* var bool = ns.isNonNegativeFinite( Infinity );
411+
* // returns false
412+
*
413+
* @example
414+
* var bool = ns.isNonNegativeFinite( -3.14 );
415+
* // returns false
416+
*
417+
* @example
418+
* var bool = ns.isNonNegativeFinite( NaN );
419+
* // returns false
420+
*/
421+
isNonNegativeFinite: typeof isNonNegativeFinite;
422+
359423
/**
360424
* Tests if a finite double-precision floating-point number is a nonnegative integer.
361425
*
@@ -381,6 +445,34 @@ interface Namespace {
381445
*/
382446
isNonNegativeInteger: typeof isNonNegativeInteger;
383447

448+
/**
449+
* Tests if a double-precision floating-point numeric value is a nonpositive finite number.
450+
*
451+
* @param x - value to test
452+
* @returns boolean indicating whether the value is a nonpositive finite number
453+
*
454+
* @example
455+
* var bool = ns.isNonPositiveFinite( -3.14 );
456+
* // returns true
457+
*
458+
* @example
459+
* var bool = ns.isNonPositiveFinite( 0.0 );
460+
* // returns true
461+
*
462+
* @example
463+
* var bool = ns.isNonPositiveFinite( -Infinity );
464+
* // returns false
465+
*
466+
* @example
467+
* var bool = ns.isNonPositiveFinite( 3.14 );
468+
* // returns false
469+
*
470+
* @example
471+
* var bool = ns.isNonPositiveFinite( NaN );
472+
* // returns false
473+
*/
474+
isNonPositiveFinite: typeof isNonPositiveFinite;
475+
384476
/**
385477
* Tests if a finite double-precision floating-point number is a nonpositive integer.
386478
*
@@ -434,6 +526,38 @@ interface Namespace {
434526
*/
435527
isOdd: typeof isOdd;
436528

529+
/**
530+
* Tests if a double-precision floating-point numeric value is a positive finite number.
531+
*
532+
* @param x - value to test
533+
* @returns boolean indicating whether the value is a positive finite number
534+
*
535+
* @example
536+
* var bool = ns.isPositiveFinite( 5.0 );
537+
* // returns true
538+
*
539+
* @example
540+
* var bool = ns.isPositiveFinite( 3.14 );
541+
* // returns true
542+
*
543+
* @example
544+
* var bool = ns.isPositiveFinite( 0.0 );
545+
* // returns false
546+
*
547+
* @example
548+
* var bool = ns.isPositiveFinite( Infinity );
549+
* // returns false
550+
*
551+
* @example
552+
* var bool = ns.isPositiveFinite( -3.14 );
553+
* // returns false
554+
*
555+
* @example
556+
* var bool = ns.isPositiveFinite( NaN );
557+
* // returns false
558+
*/
559+
isPositiveFinite: typeof isPositiveFinite;
560+
437561
/**
438562
* Tests if a finite double-precision floating-point number is a positive integer.
439563
*

‎lib/node_modules/@stdlib/math/base/special/docs/types/index.d.ts‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,7 @@ import gamma1pm1 = require( '@stdlib/math/base/special/gamma1pm1' );
148148
import gammainc = require( '@stdlib/math/base/special/gammainc' );
149149
import gammaincinv = require( '@stdlib/math/base/special/gammaincinv' );
150150
import gammaln = require( '@stdlib/math/base/special/gammaln' );
151+
import gammasgn = require( '@stdlib/math/base/special/gammasgn' );
151152
import gcd = require( '@stdlib/math/base/special/gcd' );
152153
import hacovercos = require( '@stdlib/math/base/special/hacovercos' );
153154
import hacoversin = require( '@stdlib/math/base/special/hacoversin' );
@@ -3659,6 +3660,30 @@ interface Namespace {
36593660
*/
36603661
gammaln: typeof gammaln;
36613662

3663+
/**
3664+
* Computes the sign of the gamma function.
3665+
*
3666+
* @param x - input value
3667+
* @returns sign of the gamma function
3668+
*
3669+
* @example
3670+
* var v = ns.gammasgn( 1.0 );
3671+
* // returns 1.0
3672+
*
3673+
* @example
3674+
* var v = ns.gammasgn( -2.5 );
3675+
* // returns -1.0
3676+
*
3677+
* @example
3678+
* var v = ns.gammasgn( 0.0 );
3679+
* // returns 0.0
3680+
*
3681+
* @example
3682+
* var v = ns.gammasgn( NaN );
3683+
* // returns NaN
3684+
*/
3685+
gammasgn: typeof gammasgn;
3686+
36623687
/**
36633688
* Computes the greatest common divisor (gcd).
36643689
*

‎lib/node_modules/@stdlib/math/strided/docs/types/index.d.ts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,18 @@
2121
/* tslint:disable:max-line-length */
2222
/* tslint:disable:max-file-line-count */
2323

24+
import ops = require( '@stdlib/math/strided/ops' );
2425
import special = require( '@stdlib/math/strided/special' );
2526

2627
/**
2728
* Interface describing the `strided` namespace.
2829
*/
2930
interface Namespace {
31+
/**
32+
* Strided array math operations.
33+
*/
34+
ops: typeof ops;
35+
3036
/**
3137
* Strided array special math functions.
3238
*/

0 commit comments

Comments
 (0)