From ec99b44d14da78ef1815f7635673a5155c847497 Mon Sep 17 00:00:00 2001 From: Planeshifter Date: Thu, 27 Oct 2022 15:32:35 +0000 Subject: [PATCH 1/4] Update namespace exports --- lib/node_modules/@stdlib/assert/lib/index.js | 9 +++++ lib/node_modules/@stdlib/complex/lib/index.js | 9 +++++ .../@stdlib/math/base/assert/lib/index.js | 36 +++++++++++++++++++ .../@stdlib/math/base/special/lib/index.js | 9 +++++ .../@stdlib/math/strided/lib/index.js | 9 +++++ .../@stdlib/ndarray/base/lib/index.js | 27 ++++++++++++++ lib/node_modules/@stdlib/ndarray/lib/index.js | 9 +++++ .../@stdlib/number/float64/lib/index.js | 18 ++++++++++ .../stats/base/dists/poisson/lib/index.js | 9 +++++ .../stats/base/dists/rayleigh/lib/index.js | 9 +++++ lib/node_modules/@stdlib/stats/lib/index.js | 9 +++++ .../@stdlib/strided/base/lib/index.js | 9 +++++ 12 files changed, 162 insertions(+) diff --git a/lib/node_modules/@stdlib/assert/lib/index.js b/lib/node_modules/@stdlib/assert/lib/index.js index 407da3d6f0df..541616443bf5 100644 --- a/lib/node_modules/@stdlib/assert/lib/index.js +++ b/lib/node_modules/@stdlib/assert/lib/index.js @@ -972,6 +972,15 @@ setReadOnly( ns, 'IS_DOCKER', require( '@stdlib/assert/is-docker' ) ); */ setReadOnly( ns, 'isDomainName', require( '@stdlib/assert/is-domain-name' ) ); +/** +* @name isDurationString +* @memberof ns +* @readonly +* @type {Function} +* @see {@link module:@stdlib/assert/is-duration-string} +*/ +setReadOnly( ns, 'isDurationString', require( '@stdlib/assert/is-duration-string' ) ); + /** * @name IS_ELECTRON * @memberof ns diff --git a/lib/node_modules/@stdlib/complex/lib/index.js b/lib/node_modules/@stdlib/complex/lib/index.js index 465c53e0f54e..fdaeed0d5519 100644 --- a/lib/node_modules/@stdlib/complex/lib/index.js +++ b/lib/node_modules/@stdlib/complex/lib/index.js @@ -36,6 +36,15 @@ var setReadOnly = require( '@stdlib/utils/define-read-only-property' ); */ var ns = {}; +/** +* @name base +* @memberof ns +* @readonly +* @type {Function} +* @see {@link module:@stdlib/complex/base} +*/ +setReadOnly( ns, 'base', require( '@stdlib/complex/base' ) ); + /** * @name complex * @memberof ns diff --git a/lib/node_modules/@stdlib/math/base/assert/lib/index.js b/lib/node_modules/@stdlib/math/base/assert/lib/index.js index b849c14340ec..f05f1bff12a7 100644 --- a/lib/node_modules/@stdlib/math/base/assert/lib/index.js +++ b/lib/node_modules/@stdlib/math/base/assert/lib/index.js @@ -144,6 +144,15 @@ setReadOnly( ns, 'isnan', require( '@stdlib/math/base/assert/is-nan' ) ); */ setReadOnly( ns, 'isnanf', require( '@stdlib/math/base/assert/is-nanf' ) ); +/** +* @name isNegativeFinite +* @memberof ns +* @readonly +* @type {Function} +* @see {@link module:@stdlib/math/base/assert/is-negative-finite} +*/ +setReadOnly( ns, 'isNegativeFinite', require( '@stdlib/math/base/assert/is-negative-finite' ) ); + /** * @name isNegativeInteger * @memberof ns @@ -171,6 +180,15 @@ setReadOnly( ns, 'isNegativeZero', require( '@stdlib/math/base/assert/is-negativ */ setReadOnly( ns, 'isNegativeZerof', require( '@stdlib/math/base/assert/is-negative-zerof' ) ); +/** +* @name isNonnegativeFinite +* @memberof ns +* @readonly +* @type {Function} +* @see {@link module:@stdlib/math/base/assert/is-nonnegative-finite} +*/ +setReadOnly( ns, 'isNonnegativeFinite', require( '@stdlib/math/base/assert/is-nonnegative-finite' ) ); + /** * @name isNonNegativeInteger * @memberof ns @@ -180,6 +198,15 @@ setReadOnly( ns, 'isNegativeZerof', require( '@stdlib/math/base/assert/is-negati */ setReadOnly( ns, 'isNonNegativeInteger', require( '@stdlib/math/base/assert/is-nonnegative-integer' ) ); +/** +* @name isNonpositiveFinite +* @memberof ns +* @readonly +* @type {Function} +* @see {@link module:@stdlib/math/base/assert/is-nonpositive-finite} +*/ +setReadOnly( ns, 'isNonpositiveFinite', require( '@stdlib/math/base/assert/is-nonpositive-finite' ) ); + /** * @name isNonPositiveInteger * @memberof ns @@ -198,6 +225,15 @@ setReadOnly( ns, 'isNonPositiveInteger', require( '@stdlib/math/base/assert/is-n */ setReadOnly( ns, 'isOdd', require( '@stdlib/math/base/assert/is-odd' ) ); +/** +* @name isPositiveFinite +* @memberof ns +* @readonly +* @type {Function} +* @see {@link module:@stdlib/math/base/assert/is-positive-finite} +*/ +setReadOnly( ns, 'isPositiveFinite', require( '@stdlib/math/base/assert/is-positive-finite' ) ); + /** * @name isPositiveInteger * @memberof ns diff --git a/lib/node_modules/@stdlib/math/base/special/lib/index.js b/lib/node_modules/@stdlib/math/base/special/lib/index.js index 2233ae645504..ef769270f539 100644 --- a/lib/node_modules/@stdlib/math/base/special/lib/index.js +++ b/lib/node_modules/@stdlib/math/base/special/lib/index.js @@ -1179,6 +1179,15 @@ setReadOnly( special, 'gammaincinv', require( '@stdlib/math/base/special/gammain */ setReadOnly( special, 'gammaln', require( '@stdlib/math/base/special/gammaln' ) ); +/** +* @name gammasgn +* @memberof special +* @readonly +* @type {Function} +* @see {@link module:@stdlib/math/base/special/gammasgn} +*/ +setReadOnly( special, 'gammasgn', require( '@stdlib/math/base/special/gammasgn' ) ); + /** * @name gcd * @memberof special diff --git a/lib/node_modules/@stdlib/math/strided/lib/index.js b/lib/node_modules/@stdlib/math/strided/lib/index.js index b0e7174061fa..9592b613db1d 100644 --- a/lib/node_modules/@stdlib/math/strided/lib/index.js +++ b/lib/node_modules/@stdlib/math/strided/lib/index.js @@ -36,6 +36,15 @@ var setReadOnly = require( '@stdlib/utils/define-read-only-property' ); */ var ns = {}; +/** +* @name ops +* @memberof ns +* @readonly +* @type {Function} +* @see {@link module:@stdlib/math/strided/ops} +*/ +setReadOnly( ns, 'ops', require( '@stdlib/math/strided/ops' ) ); + /** * @name special * @memberof ns diff --git a/lib/node_modules/@stdlib/ndarray/base/lib/index.js b/lib/node_modules/@stdlib/ndarray/base/lib/index.js index 247e9684dd01..063cc3df23aa 100644 --- a/lib/node_modules/@stdlib/ndarray/base/lib/index.js +++ b/lib/node_modules/@stdlib/ndarray/base/lib/index.js @@ -234,6 +234,15 @@ setReadOnly( ns, 'expandDimensions', require( '@stdlib/ndarray/base/expand-dimen */ setReadOnly( ns, 'scalar2ndarray', require( '@stdlib/ndarray/base/from-scalar' ) ); +/** +* @name functionObject +* @memberof ns +* @readonly +* @type {Function} +* @see {@link module:@stdlib/ndarray/base/function-object} +*/ +setReadOnly( ns, 'functionObject', require( '@stdlib/ndarray/base/function-object' ) ); + /** * @name ind * @memberof ns @@ -306,6 +315,15 @@ setReadOnly( ns, 'minViewBufferIndex', require( '@stdlib/ndarray/base/min-view-b */ setReadOnly( ns, 'minmaxViewBufferIndex', require( '@stdlib/ndarray/base/minmax-view-buffer-index' ) ); +/** +* @name napi +* @memberof ns +* @readonly +* @type {Function} +* @see {@link module:@stdlib/ndarray/base/napi} +*/ +setReadOnly( ns, 'napi', require( '@stdlib/ndarray/base/napi' ) ); + /** * @name ndarraylike2object * @memberof ns @@ -423,6 +441,15 @@ setReadOnly( ns, 'ndarray2array', require( '@stdlib/ndarray/base/to-array' ) ); */ setReadOnly( ns, 'transpose', require( '@stdlib/ndarray/base/transpose' ) ); +/** +* @name unary +* @memberof ns +* @readonly +* @type {Function} +* @see {@link module:@stdlib/ndarray/base/unary} +*/ +setReadOnly( ns, 'unary', require( '@stdlib/ndarray/base/unary' ) ); + /** * @name vind2bind * @memberof ns diff --git a/lib/node_modules/@stdlib/ndarray/lib/index.js b/lib/node_modules/@stdlib/ndarray/lib/index.js index 44350e6aca2d..057c1744dca0 100644 --- a/lib/node_modules/@stdlib/ndarray/lib/index.js +++ b/lib/node_modules/@stdlib/ndarray/lib/index.js @@ -72,6 +72,15 @@ setReadOnly( ns, 'ndarrayCastingModes', require( '@stdlib/ndarray/casting-modes' */ setReadOnly( ns, 'ndarray', require( '@stdlib/ndarray/ctor' ) ); +/** +* @name dispatch +* @memberof ns +* @readonly +* @type {Function} +* @see {@link module:@stdlib/ndarray/dispatch} +*/ +setReadOnly( ns, 'dispatch', require( '@stdlib/ndarray/dispatch' ) ); + /** * @name ndarrayDataTypes * @memberof ns diff --git a/lib/node_modules/@stdlib/number/float64/lib/index.js b/lib/node_modules/@stdlib/number/float64/lib/index.js index bba55baccb66..55510e8d1560 100644 --- a/lib/node_modules/@stdlib/number/float64/lib/index.js +++ b/lib/node_modules/@stdlib/number/float64/lib/index.js @@ -45,6 +45,24 @@ var ns = {}; */ setReadOnly( ns, 'base', require( '@stdlib/number/float64/base' ) ); +/** +* @name reviver +* @memberof ns +* @readonly +* @type {Function} +* @see {@link module:@stdlib/number/float64/reviver} +*/ +setReadOnly( ns, 'reviver', require( '@stdlib/number/float64/reviver' ) ); + +/** +* @name toJson +* @memberof ns +* @readonly +* @type {Function} +* @see {@link module:@stdlib/number/float64/to-json} +*/ +setReadOnly( ns, 'toJson', require( '@stdlib/number/float64/to-json' ) ); + // EXPORTS // diff --git a/lib/node_modules/@stdlib/stats/base/dists/poisson/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/poisson/lib/index.js index 652ba0473f82..f797982727cd 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/poisson/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/poisson/lib/index.js @@ -54,6 +54,15 @@ setReadOnly( poisson, 'cdf', require( '@stdlib/stats/base/dists/poisson/cdf' ) ) */ setReadOnly( poisson, 'Poisson', require( '@stdlib/stats/base/dists/poisson/ctor' ) ); +/** +* @name entropy +* @memberof poisson +* @readonly +* @type {Function} +* @see {@link module:@stdlib/stats/base/dists/poisson/entropy} +*/ +setReadOnly( poisson, 'entropy', require( '@stdlib/stats/base/dists/poisson/entropy' ) ); + /** * @name kurtosis * @memberof poisson diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/lib/index.js index bcc9718b9525..96ae67e48b8d 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/lib/index.js @@ -153,6 +153,15 @@ setReadOnly( rayleigh, 'quantile', require( '@stdlib/stats/base/dists/rayleigh/q */ setReadOnly( rayleigh, 'skewness', require( '@stdlib/stats/base/dists/rayleigh/skewness' ) ); +/** +* @name stdev +* @memberof rayleigh +* @readonly +* @type {Function} +* @see {@link module:@stdlib/stats/base/dists/rayleigh/stdev} +*/ +setReadOnly( rayleigh, 'stdev', require( '@stdlib/stats/base/dists/rayleigh/stdev' ) ); + /** * @name variance * @memberof rayleigh diff --git a/lib/node_modules/@stdlib/stats/lib/index.js b/lib/node_modules/@stdlib/stats/lib/index.js index 04319b596ce5..d7c10ee7cbf2 100644 --- a/lib/node_modules/@stdlib/stats/lib/index.js +++ b/lib/node_modules/@stdlib/stats/lib/index.js @@ -54,6 +54,15 @@ setReadOnly( ns, 'anova1', require( '@stdlib/stats/anova1' ) ); */ setReadOnly( ns, 'bartlettTest', require( '@stdlib/stats/bartlett-test' ) ); +/** +* @name base +* @memberof ns +* @readonly +* @type {Function} +* @see {@link module:@stdlib/stats/base} +*/ +setReadOnly( ns, 'base', require( '@stdlib/stats/base' ) ); + /** * @name binomialTest * @memberof ns diff --git a/lib/node_modules/@stdlib/strided/base/lib/index.js b/lib/node_modules/@stdlib/strided/base/lib/index.js index ba8c4363145f..c102d657dab6 100644 --- a/lib/node_modules/@stdlib/strided/base/lib/index.js +++ b/lib/node_modules/@stdlib/strided/base/lib/index.js @@ -153,6 +153,15 @@ setReadOnly( ns, 'dtypeResolveStr', require( '@stdlib/strided/base/dtype-resolve */ setReadOnly( ns, 'dtypeStr2Enum', require( '@stdlib/strided/base/dtype-str2enum' ) ); +/** +* @name functionObject +* @memberof ns +* @readonly +* @type {Function} +* @see {@link module:@stdlib/strided/base/function-object} +*/ +setReadOnly( ns, 'functionObject', require( '@stdlib/strided/base/function-object' ) ); + /** * @name mapBy * @memberof ns From 1d5ed004afe27bf1efbce755000cf256e748fe60 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Thu, 27 Oct 2022 11:47:17 -0400 Subject: [PATCH 2/4] Update index.js --- .../@stdlib/ndarray/base/lib/index.js | 31 +++---------------- 1 file changed, 4 insertions(+), 27 deletions(-) diff --git a/lib/node_modules/@stdlib/ndarray/base/lib/index.js b/lib/node_modules/@stdlib/ndarray/base/lib/index.js index 063cc3df23aa..e0c1c4354bcb 100644 --- a/lib/node_modules/@stdlib/ndarray/base/lib/index.js +++ b/lib/node_modules/@stdlib/ndarray/base/lib/index.js @@ -22,6 +22,10 @@ * When adding modules to the namespace, ensure that they are added in alphabetical order according to module name. */ +/* +* The following modules are intentionally not exported: function-object, napi, unary +*/ + // MODULES // var setReadOnly = require( '@stdlib/utils/define-read-only-property' ); @@ -234,15 +238,6 @@ setReadOnly( ns, 'expandDimensions', require( '@stdlib/ndarray/base/expand-dimen */ setReadOnly( ns, 'scalar2ndarray', require( '@stdlib/ndarray/base/from-scalar' ) ); -/** -* @name functionObject -* @memberof ns -* @readonly -* @type {Function} -* @see {@link module:@stdlib/ndarray/base/function-object} -*/ -setReadOnly( ns, 'functionObject', require( '@stdlib/ndarray/base/function-object' ) ); - /** * @name ind * @memberof ns @@ -315,15 +310,6 @@ setReadOnly( ns, 'minViewBufferIndex', require( '@stdlib/ndarray/base/min-view-b */ setReadOnly( ns, 'minmaxViewBufferIndex', require( '@stdlib/ndarray/base/minmax-view-buffer-index' ) ); -/** -* @name napi -* @memberof ns -* @readonly -* @type {Function} -* @see {@link module:@stdlib/ndarray/base/napi} -*/ -setReadOnly( ns, 'napi', require( '@stdlib/ndarray/base/napi' ) ); - /** * @name ndarraylike2object * @memberof ns @@ -441,15 +427,6 @@ setReadOnly( ns, 'ndarray2array', require( '@stdlib/ndarray/base/to-array' ) ); */ setReadOnly( ns, 'transpose', require( '@stdlib/ndarray/base/transpose' ) ); -/** -* @name unary -* @memberof ns -* @readonly -* @type {Function} -* @see {@link module:@stdlib/ndarray/base/unary} -*/ -setReadOnly( ns, 'unary', require( '@stdlib/ndarray/base/unary' ) ); - /** * @name vind2bind * @memberof ns From 47f55c3fa8d1491dd7d5db3beeb5a8781ad74a80 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Thu, 27 Oct 2022 11:47:53 -0400 Subject: [PATCH 3/4] Update index.js --- lib/node_modules/@stdlib/strided/base/lib/index.js | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) diff --git a/lib/node_modules/@stdlib/strided/base/lib/index.js b/lib/node_modules/@stdlib/strided/base/lib/index.js index c102d657dab6..c4dc7f408354 100644 --- a/lib/node_modules/@stdlib/strided/base/lib/index.js +++ b/lib/node_modules/@stdlib/strided/base/lib/index.js @@ -22,6 +22,10 @@ * When adding modules to the namespace, ensure that they are added in alphabetical order according to module name. */ +/* +* The following modules are intentionally not exported: function-object +*/ + // MODULES // var setReadOnly = require( '@stdlib/utils/define-read-only-property' ); @@ -153,15 +157,6 @@ setReadOnly( ns, 'dtypeResolveStr', require( '@stdlib/strided/base/dtype-resolve */ setReadOnly( ns, 'dtypeStr2Enum', require( '@stdlib/strided/base/dtype-str2enum' ) ); -/** -* @name functionObject -* @memberof ns -* @readonly -* @type {Function} -* @see {@link module:@stdlib/strided/base/function-object} -*/ -setReadOnly( ns, 'functionObject', require( '@stdlib/strided/base/function-object' ) ); - /** * @name mapBy * @memberof ns From 9cc10c172aa23d874bae93db85b4cc0d1538c123 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Thu, 27 Oct 2022 11:50:14 -0400 Subject: [PATCH 4/4] Apply suggestions from code review --- lib/node_modules/@stdlib/complex/lib/index.js | 2 +- lib/node_modules/@stdlib/math/base/assert/lib/index.js | 8 ++++---- lib/node_modules/@stdlib/math/strided/lib/index.js | 2 +- lib/node_modules/@stdlib/number/float64/lib/index.js | 4 ++-- lib/node_modules/@stdlib/stats/lib/index.js | 2 +- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/lib/node_modules/@stdlib/complex/lib/index.js b/lib/node_modules/@stdlib/complex/lib/index.js index fdaeed0d5519..d9be5e09a84e 100644 --- a/lib/node_modules/@stdlib/complex/lib/index.js +++ b/lib/node_modules/@stdlib/complex/lib/index.js @@ -40,7 +40,7 @@ var ns = {}; * @name base * @memberof ns * @readonly -* @type {Function} +* @type {Namespace} * @see {@link module:@stdlib/complex/base} */ setReadOnly( ns, 'base', require( '@stdlib/complex/base' ) ); diff --git a/lib/node_modules/@stdlib/math/base/assert/lib/index.js b/lib/node_modules/@stdlib/math/base/assert/lib/index.js index f05f1bff12a7..2cba4f92a3aa 100644 --- a/lib/node_modules/@stdlib/math/base/assert/lib/index.js +++ b/lib/node_modules/@stdlib/math/base/assert/lib/index.js @@ -181,13 +181,13 @@ setReadOnly( ns, 'isNegativeZero', require( '@stdlib/math/base/assert/is-negativ setReadOnly( ns, 'isNegativeZerof', require( '@stdlib/math/base/assert/is-negative-zerof' ) ); /** -* @name isNonnegativeFinite +* @name isNonNegativeFinite * @memberof ns * @readonly * @type {Function} * @see {@link module:@stdlib/math/base/assert/is-nonnegative-finite} */ -setReadOnly( ns, 'isNonnegativeFinite', require( '@stdlib/math/base/assert/is-nonnegative-finite' ) ); +setReadOnly( ns, 'isNonNegativeFinite', require( '@stdlib/math/base/assert/is-nonnegative-finite' ) ); /** * @name isNonNegativeInteger @@ -199,13 +199,13 @@ setReadOnly( ns, 'isNonnegativeFinite', require( '@stdlib/math/base/assert/is-no setReadOnly( ns, 'isNonNegativeInteger', require( '@stdlib/math/base/assert/is-nonnegative-integer' ) ); /** -* @name isNonpositiveFinite +* @name isNonPositiveFinite * @memberof ns * @readonly * @type {Function} * @see {@link module:@stdlib/math/base/assert/is-nonpositive-finite} */ -setReadOnly( ns, 'isNonpositiveFinite', require( '@stdlib/math/base/assert/is-nonpositive-finite' ) ); +setReadOnly( ns, 'isNonPositiveFinite', require( '@stdlib/math/base/assert/is-nonpositive-finite' ) ); /** * @name isNonPositiveInteger diff --git a/lib/node_modules/@stdlib/math/strided/lib/index.js b/lib/node_modules/@stdlib/math/strided/lib/index.js index 9592b613db1d..5765030a9f9c 100644 --- a/lib/node_modules/@stdlib/math/strided/lib/index.js +++ b/lib/node_modules/@stdlib/math/strided/lib/index.js @@ -40,7 +40,7 @@ var ns = {}; * @name ops * @memberof ns * @readonly -* @type {Function} +* @type {Namespace} * @see {@link module:@stdlib/math/strided/ops} */ setReadOnly( ns, 'ops', require( '@stdlib/math/strided/ops' ) ); diff --git a/lib/node_modules/@stdlib/number/float64/lib/index.js b/lib/node_modules/@stdlib/number/float64/lib/index.js index 55510e8d1560..7490caece093 100644 --- a/lib/node_modules/@stdlib/number/float64/lib/index.js +++ b/lib/node_modules/@stdlib/number/float64/lib/index.js @@ -55,13 +55,13 @@ setReadOnly( ns, 'base', require( '@stdlib/number/float64/base' ) ); setReadOnly( ns, 'reviver', require( '@stdlib/number/float64/reviver' ) ); /** -* @name toJson +* @name toJSON * @memberof ns * @readonly * @type {Function} * @see {@link module:@stdlib/number/float64/to-json} */ -setReadOnly( ns, 'toJson', require( '@stdlib/number/float64/to-json' ) ); +setReadOnly( ns, 'toJSON', require( '@stdlib/number/float64/to-json' ) ); // EXPORTS // diff --git a/lib/node_modules/@stdlib/stats/lib/index.js b/lib/node_modules/@stdlib/stats/lib/index.js index d7c10ee7cbf2..54cfa9f9d0c3 100644 --- a/lib/node_modules/@stdlib/stats/lib/index.js +++ b/lib/node_modules/@stdlib/stats/lib/index.js @@ -58,7 +58,7 @@ setReadOnly( ns, 'bartlettTest', require( '@stdlib/stats/bartlett-test' ) ); * @name base * @memberof ns * @readonly -* @type {Function} +* @type {Namespace} * @see {@link module:@stdlib/stats/base} */ setReadOnly( ns, 'base', require( '@stdlib/stats/base' ) );