From cc621bd4dd9ab55ac606a440efa0a561f4d5d989 Mon Sep 17 00:00:00 2001 From: Planeshifter <1913638+Planeshifter@users.noreply.github.com> Date: Wed, 21 Jan 2026 18:36:44 +0000 Subject: [PATCH] docs: update namespace table of contents Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> --- .../@stdlib/_tools/eslint/rules/README.md | 3 + .../@stdlib/complex/float64/base/README.md | 3 + lib/node_modules/@stdlib/ndarray/README.md | 2 +- .../@stdlib/ndarray/base/README.md | 32 +++++++++-- lib/node_modules/@stdlib/object/README.md | 57 +++++++++++++++++++ .../@stdlib/random/tools/README.md | 6 ++ lib/node_modules/@stdlib/utils/README.md | 39 ------------- 7 files changed, 98 insertions(+), 44 deletions(-) diff --git a/lib/node_modules/@stdlib/_tools/eslint/rules/README.md b/lib/node_modules/@stdlib/_tools/eslint/rules/README.md index 275f084c96ba..64f53a1c648d 100644 --- a/lib/node_modules/@stdlib/_tools/eslint/rules/README.md +++ b/lib/node_modules/@stdlib/_tools/eslint/rules/README.md @@ -72,6 +72,7 @@ var eslint = rules; - [`no-dynamic-exports`][@stdlib/_tools/eslint/rules/no-dynamic-exports]: ESLint rule enforcing that only statically analyzable values are exported. - [`no-dynamic-require`][@stdlib/_tools/eslint/rules/no-dynamic-require]: ESLint rule enforcing that `require()` calls have only string literals as arguments. - [`no-empty-comments`][@stdlib/_tools/eslint/rules/no-empty-comments]: ESLint rule to disallow empty comments. +- [`no-empty-lines-between-requires`][@stdlib/_tools/eslint/rules/no-empty-lines-between-requires]: ESLint rule to enforce no empty lines between module-level require statements. - [`no-error-string-concat`][@stdlib/_tools/eslint/rules/no-error-string-concat]: ESLint rule disallowing string concatenation in error messages. - [`no-immediate-require`][@stdlib/_tools/eslint/rules/no-immediate-require]: ESLint rule enforcing that `require()` expressions are not immediately invoked. - [`no-internal-require`][@stdlib/_tools/eslint/rules/no-internal-require]: ESLint rule disallowing `require()` calls into internals of another stdlib package. @@ -417,6 +418,8 @@ console.log( getKeys( rules ) ); [@stdlib/_tools/eslint/rules/no-empty-comments]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/no-empty-comments +[@stdlib/_tools/eslint/rules/no-empty-lines-between-requires]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/no-empty-lines-between-requires + [@stdlib/_tools/eslint/rules/no-error-string-concat]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/no-error-string-concat [@stdlib/_tools/eslint/rules/no-immediate-require]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/no-immediate-require diff --git a/lib/node_modules/@stdlib/complex/float64/base/README.md b/lib/node_modules/@stdlib/complex/float64/base/README.md index aa2b701d30a5..533241d9731a 100644 --- a/lib/node_modules/@stdlib/complex/float64/base/README.md +++ b/lib/node_modules/@stdlib/complex/float64/base/README.md @@ -58,6 +58,7 @@ The namespace contains the following functions:
- [`add( z1, z2 )`][@stdlib/complex/float64/base/add]: add two double-precision complex floating-point numbers. +- [`add3( z1, z2, z3 )`][@stdlib/complex/float64/base/add3]: compute the sum of three double-precision complex floating-point numbers. - [`div( z1, z2 )`][@stdlib/complex/float64/base/div]: divide two double-precision complex floating-point numbers. - [`identity( z )`][@stdlib/complex/float64/base/identity]: evaluate the identity function of a double-precision complex floating-point number. - [`muladd( alpha, x, y )`][@stdlib/complex/float64/base/mul-add]: perform a multiply-add operation involving three double-precision complex floating-point numbers. @@ -117,6 +118,8 @@ console.log( objectKeys( ns ) ); [@stdlib/complex/float64/base/add]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/add +[@stdlib/complex/float64/base/add3]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/add3 + [@stdlib/complex/float64/base/div]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/div [@stdlib/complex/float64/base/identity]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/identity diff --git a/lib/node_modules/@stdlib/ndarray/README.md b/lib/node_modules/@stdlib/ndarray/README.md index 09226745040e..1fe20e7ef386 100644 --- a/lib/node_modules/@stdlib/ndarray/README.md +++ b/lib/node_modules/@stdlib/ndarray/README.md @@ -77,7 +77,7 @@ In addition, the namespace contains the following multidimensional array utility - [`broadcastArray( x, shape )`][@stdlib/ndarray/broadcast-array]: broadcast an ndarray to a specified shape. - [`broadcastArrays( ...arrays )`][@stdlib/ndarray/broadcast-arrays]: broadcast ndarrays to a common shape. - [`castingModes()`][@stdlib/ndarray/casting-modes]: list of ndarray casting modes. -- [`concat( arrays[, dim] )`][@stdlib/ndarray/concat]: concatenate a list of ndarrays along a specified ndarray dimension. +- [`concat( arrays[, options] )`][@stdlib/ndarray/concat]: concatenate a list of ndarrays along a specified ndarray dimension. - [`copy( x[, options] )`][@stdlib/ndarray/copy]: copy an input ndarray to a new ndarray having the same shape and data type. - [`countFalsy( x[, options] )`][@stdlib/ndarray/count-falsy]: count the number of falsy elements along one or more `ndarray` dimensions. - [`countIf( x[, options], predicate[, thisArg] )`][@stdlib/ndarray/count-if]: count the number of truthy elements along one or more `ndarray` dimensions. diff --git a/lib/node_modules/@stdlib/ndarray/base/README.md b/lib/node_modules/@stdlib/ndarray/base/README.md index 52e31c43cb78..f5737b30f9b0 100644 --- a/lib/node_modules/@stdlib/ndarray/base/README.md +++ b/lib/node_modules/@stdlib/ndarray/base/README.md @@ -58,7 +58,7 @@ var o = ns; - [`broadcastArrayExceptDimensions( arr, shape, dims )`][@stdlib/ndarray/base/broadcast-array-except-dimensions]: broadcast an input ndarray to a target shape while keeping a list of specified dimensions unchanged. - [`broadcastArray( arr, shape )`][@stdlib/ndarray/base/broadcast-array]: broadcast an ndarray to a specified shape. - [`broadcastArrays( arrays )`][@stdlib/ndarray/base/broadcast-arrays]: broadcast ndarrays to a common shape. -- [`broadcastScalar( value, dtype, shape, order )`][@stdlib/ndarray/base/broadcast-scalar]: broadcast a scalar value to an `ndarray` having a specified shape. +- [`broadcastScalar( value, dtype, shape, order )`][@stdlib/ndarray/base/broadcast-scalar]: broadcast a scalar value to an ndarray having a specified shape. - [`broadcastShapes( shapes )`][@stdlib/ndarray/base/broadcast-shapes]: broadcast array shapes to a single shape. - [`bufferCtors( dtype )`][@stdlib/ndarray/base/buffer-ctors]: ndarray data buffer constructors. - [`bufferDataTypeEnum( buffer )`][@stdlib/ndarray/base/buffer-dtype-enum]: return the data type enumeration constant of an ndarray data buffer. @@ -89,11 +89,12 @@ var o = ns; - [`dtype2c( dtype )`][@stdlib/ndarray/base/dtype2c]: return the C data type associated with a provided data type value. - [`dtypes2enums( dtypes )`][@stdlib/ndarray/base/dtypes2enums]: resolve a list of data type enumeration constants. - [`dtypes2signatures( dtypes, nin, nout )`][@stdlib/ndarray/base/dtypes2signatures]: transform a list of array argument data types into a list of signatures. +- [`dtypes2strings( dtypes )`][@stdlib/ndarray/base/dtypes2strings]: resolve a list of data type strings. - [`emptyLike( x )`][@stdlib/ndarray/base/empty-like]: create an uninitialized ndarray having the same shape and data type as a provided ndarray. - [`empty( dtype, shape, order )`][@stdlib/ndarray/base/empty]: create an uninitialized ndarray having a specified shape and data type. - [`everyBy( arrays, predicate[, thisArg] )`][@stdlib/ndarray/base/every-by]: test whether all elements in an ndarray pass a test implemented by a predicate function. - [`every( arrays )`][@stdlib/ndarray/base/every]: test whether every element in an ndarray is truthy. -- [`expandDimensions( x, axis )`][@stdlib/ndarray/base/expand-dimensions]: expand the shape of an array by inserting a new dimension of size one at a specified axis. +- [`expandDimensions( x, dim, writable )`][@stdlib/ndarray/base/expand-dimensions]: expand the shape of an array by inserting a new dimension of size one at a specified dimension index. - [`fillBy( x, fcn[, thisArg] )`][@stdlib/ndarray/base/fill-by]: fill an input ndarray according to a callback function. - [`fill( x, value )`][@stdlib/ndarray/base/fill]: fill an input ndarray with a specified value. - [`find( arrays, predicate[, thisArg] )`][@stdlib/ndarray/base/find]: return the first element in an ndarray which passes a test implemented by a predicate function. @@ -145,7 +146,7 @@ var o = ns; - [`outputPolicyResolveStr( dtype )`][@stdlib/ndarray/base/output-policy-resolve-str]: return the policy string associated with a supported ndarray data type policy value. - [`outputPolicyStr2Enum( policy )`][@stdlib/ndarray/base/output-policy-str2enum]: return the enumeration constant associated with an output ndarray data type policy string. - [`pop( x, dim, writable )`][@stdlib/ndarray/base/pop]: return an array containing a truncated view of an input ndarray and a view of the last element(s) along a specified dimension. -- [`prependSingletonDimensions( x, n )`][@stdlib/ndarray/base/prepend-singleton-dimensions]: prepend singleton dimensions. +- [`prependSingletonDimensions( x, n, writable )`][@stdlib/ndarray/base/prepend-singleton-dimensions]: prepend singleton dimensions. - [`promoteDataTypes( dtypes )`][@stdlib/ndarray/base/promote-dtypes]: resolve the data type that results from applying promotion rules to a provided list of data types. - [`removeSingletonDimensions( x )`][@stdlib/ndarray/base/remove-singleton-dimensions]: remove singleton dimensions. - [`reverseDimension( x, dim, writable )`][@stdlib/ndarray/base/reverse-dimension]: return a view of an input ndarray in which the order of elements along a specified dimension is reversed. @@ -164,14 +165,21 @@ var o = ns; - [`slice( x, slice, strict, writable )`][@stdlib/ndarray/base/slice]: return a view of an input ndarray. - [`someBy( arrays, predicate[, thisArg ] )`][@stdlib/ndarray/base/some-by]: test whether at least `n` elements in an ndarray pass a test implemented by a predicate function. - [`some( arrays )`][@stdlib/ndarray/base/some]: test whether at least `n` elements in an ndarray are truthy. -- [`spreadDimensions( ndims, x, dims )`][@stdlib/ndarray/base/spread-dimensions]: expand the shape of an array to a specified dimensionality by spreading its dimensions to specified dimension indices and inserting dimensions of size one for the remaining dimensions. +- [`spreadDimensions( ndims, x, dims, writable )`][@stdlib/ndarray/base/spread-dimensions]: expand the shape of an array to a specified dimensionality by spreading its dimensions to specified dimension indices and inserting dimensions of size one for the remaining dimensions. - [`stride( x, dim )`][@stdlib/ndarray/base/stride]: return the stride along a specified dimension for a provided ndarray. - [`strides( x, copy )`][@stdlib/ndarray/base/strides]: return the strides of a provided ndarray. - [`strides2offset( shape, strides )`][@stdlib/ndarray/base/strides2offset]: determine the index offset which specifies the location of the first indexed value in a multidimensional array based on a stride array. - [`strides2order( strides )`][@stdlib/ndarray/base/strides2order]: determine the order of a multidimensional array based on a provided stride array. - [`sub2ind( shape, strides, offset, ...subscripts, mode )`][@stdlib/ndarray/base/sub2ind]: convert subscripts to a linear index. +- [`ternaryLoopOrder( shape, stridesX, stridesY, stridesZ, stridesW )`][@stdlib/ndarray/base/ternary-loop-interchange-order]: reorder ndarray dimensions and associated strides for loop interchange. +- [`ternaryOutputDataType( xdtype, ydtype, zdtype, policy )`][@stdlib/ndarray/base/ternary-output-dtype]: resolve the output ndarray data type for a ternary function. +- [`ternaryBlockSize( dtypeX, dtypeY, dtypeZ, dtypeW )`][@stdlib/ndarray/base/ternary-tiling-block-size]: resolve a loop block size for multi-dimensional array tiled loops. +- [`ternary( arrays, fcn )`][@stdlib/ndarray/base/ternary]: apply a ternary callback to elements in input ndarrays and assign results to elements in an output ndarray. - [`ndarray2array( buffer, shape, strides, offset, order )`][@stdlib/ndarray/base/to-array]: convert an ndarray buffer to a generic array. +- [`toFlippedlr( x )`][@stdlib/ndarray/base/to-flippedlr]: return a new ndarray where the order of elements along the last dimension of an input ndarray is reversed. +- [`toFlippedud( x )`][@stdlib/ndarray/base/to-flippedud]: return a new ndarray where the order of elements along the second-to-last dimension of an input ndarray is reversed. - [`toNormalizedIndices( indices, max )`][@stdlib/ndarray/base/to-normalized-indices]: normalize a list of indices to the interval `[0,max]`. +- [`toReversedDimension( x, dim )`][@stdlib/ndarray/base/to-reversed-dimension]: return a new ndarray where the order of elements of an input ndarray along a specified dimension is reversed. - [`toReversed( x )`][@stdlib/ndarray/base/to-reversed]: return a new ndarray where the order of elements of an input ndarray is reversed along each dimension. - [`toUniqueNormalizedIndices( indices, max )`][@stdlib/ndarray/base/to-unique-normalized-indices]: return a list of unique indices after normalizing to the interval `[0,max]`. - [`transpose( x )`][@stdlib/ndarray/base/transpose]: transpose a matrix (or a stack of matrices). @@ -348,6 +356,8 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/base/dtypes2signatures]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/dtypes2signatures +[@stdlib/ndarray/base/dtypes2strings]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/dtypes2strings + [@stdlib/ndarray/base/empty-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/empty-like [@stdlib/ndarray/base/empty]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/empty @@ -510,10 +520,24 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/base/sub2ind]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/sub2ind +[@stdlib/ndarray/base/ternary-loop-interchange-order]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/ternary-loop-interchange-order + +[@stdlib/ndarray/base/ternary-output-dtype]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/ternary-output-dtype + +[@stdlib/ndarray/base/ternary-tiling-block-size]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/ternary-tiling-block-size + +[@stdlib/ndarray/base/ternary]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/ternary + [@stdlib/ndarray/base/to-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/to-array +[@stdlib/ndarray/base/to-flippedlr]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/to-flippedlr + +[@stdlib/ndarray/base/to-flippedud]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/to-flippedud + [@stdlib/ndarray/base/to-normalized-indices]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/to-normalized-indices +[@stdlib/ndarray/base/to-reversed-dimension]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/to-reversed-dimension + [@stdlib/ndarray/base/to-reversed]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/to-reversed [@stdlib/ndarray/base/to-unique-normalized-indices]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/to-unique-normalized-indices diff --git a/lib/node_modules/@stdlib/object/README.md b/lib/node_modules/@stdlib/object/README.md index 0c5b655f6a28..57c3014f7a4b 100644 --- a/lib/node_modules/@stdlib/object/README.md +++ b/lib/node_modules/@stdlib/object/README.md @@ -45,13 +45,32 @@ The namespace contains the following:
+- [`anyInBy( object, predicate[, thisArg ] )`][@stdlib/object/any-in-by]: test whether at least one property in an object passes a test implemented by a predicate function. +- [`anyOwnBy( object, predicate[, thisArg ] )`][@stdlib/object/any-own-by]: test whether at least one own property of a provided object passes a test implemented by a predicate function. - [`assignIn( target, source1[, source2[,...,sourceN]] )`][@stdlib/object/assign-in]: copy enumerable own and inherited properties from one or more source objects to a target object. - [`assign( target, source1[, source2[,...,sourceN]] )`][@stdlib/object/assign]: copy enumerable own properties from one or more source objects to a target object. +- [`bifurcateIn( obj, [options,] predicate )`][@stdlib/object/bifurcate-in]: split an object's **own** and **inherited** property values into two groups according to a predicate function. +- [`bifurcateOwn( obj, [options,] predicate )`][@stdlib/object/bifurcate-own]: split an object's **own** property values into two groups according to a predicate function. +- [`capitalizeKeys( obj )`][@stdlib/object/capitalize-keys]: convert the first letter of each object key to uppercase. +- [`commonKeysIn( obj1, obj2[, obj3[,...,objN]] )`][@stdlib/object/common-keys-in]: return the common own and inherited property names of two or more objects. +- [`commonKeys( obj1, obj2[, obj3[,...,objN]] )`][@stdlib/object/common-keys]: return the common own property names of two or more objects. - [`Object( value )`][@stdlib/object/ctor]: object constructor. +- [`deepGet( obj, path[, options] )`][@stdlib/object/deep-get]: get a nested property value. +- [`deepSet( obj, path, value[, options] )`][@stdlib/object/deep-set]: set a nested property value. - [`everyInBy( object, predicate[, thisArg ] )`][@stdlib/object/every-in-by]: test whether all properties (own and inherited) of an object pass a test implemented by a predicate function. - [`everyOwnBy( object, predicate[, thisArg ] )`][@stdlib/object/every-own-by]: test whether all own propertes of an object pass a test implemented by a predicate function. +- [`forIn( obj, fcn[, thisArg ] )`][@stdlib/object/for-in]: invoke a function for each own and inherited enumerable property of an object. +- [`forOwn( obj, fcn[, thisArg ] )`][@stdlib/object/for-own]: invoke a function for each own enumerable property of an object. +- [`inverseBy( obj, [options,] transform )`][@stdlib/object/inverse-by]: invert an object, such that keys become values and values become keys, according to a transform function. +- [`inverse( obj[, options] )`][@stdlib/object/inverse]: invert an object, such that keys become values and values become keys. +- [`lowercaseKeys( obj )`][@stdlib/object/lowercase-keys]: convert each object key to lowercase. +- [`moveProperty( source, prop, target )`][@stdlib/object/move-property]: move a property from one object to another object. - [`noneInBy( object, predicate[, thisArg ] )`][@stdlib/object/none-in-by]: test whether every property of an object fails a test implemented by a predicate function. +- [`noneOwnBy( object, predicate[, thisArg ] )`][@stdlib/object/none-own-by]: tests whether every own property of an object fails a test implemented by a predicate function. - [`someInBy( obj, n, predicate[, thisArg ] )`][@stdlib/object/some-in-by]: test whether an object contains at least `n` properties which pass a test implemented by a predicate function. +- [`someOwnBy( obj, n, predicate[, thisArg ] )`][@stdlib/object/some-own-by]: test whether an object contains at least `n` own properties which pass a test implemented by a predicate function. +- [`uncapitalizeKeys( obj )`][@stdlib/object/uncapitalize-keys]: convert the first letter of each object key to lowercase. +- [`uppercaseKeys( obj )`][@stdlib/object/uppercase-keys]: convert each object key to uppercase.
@@ -94,20 +113,58 @@ console.log( objectKeys( ns ) ); +[@stdlib/object/any-in-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/any-in-by + +[@stdlib/object/any-own-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/any-own-by + [@stdlib/object/assign-in]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/assign-in [@stdlib/object/assign]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/assign +[@stdlib/object/bifurcate-in]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/bifurcate-in + +[@stdlib/object/bifurcate-own]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/bifurcate-own + +[@stdlib/object/capitalize-keys]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/capitalize-keys + +[@stdlib/object/common-keys-in]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/common-keys-in + +[@stdlib/object/common-keys]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/common-keys + [@stdlib/object/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/ctor +[@stdlib/object/deep-get]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/deep-get + +[@stdlib/object/deep-set]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/deep-set + [@stdlib/object/every-in-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/every-in-by [@stdlib/object/every-own-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/every-own-by +[@stdlib/object/for-in]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/for-in + +[@stdlib/object/for-own]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/for-own + +[@stdlib/object/inverse-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/inverse-by + +[@stdlib/object/inverse]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/inverse + +[@stdlib/object/lowercase-keys]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/lowercase-keys + +[@stdlib/object/move-property]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/move-property + [@stdlib/object/none-in-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/none-in-by +[@stdlib/object/none-own-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/none-own-by + [@stdlib/object/some-in-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/some-in-by +[@stdlib/object/some-own-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/some-own-by + +[@stdlib/object/uncapitalize-keys]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/uncapitalize-keys + +[@stdlib/object/uppercase-keys]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/uppercase-keys + diff --git a/lib/node_modules/@stdlib/random/tools/README.md b/lib/node_modules/@stdlib/random/tools/README.md index 66ee0ea317cf..90763e4e5486 100644 --- a/lib/node_modules/@stdlib/random/tools/README.md +++ b/lib/node_modules/@stdlib/random/tools/README.md @@ -57,6 +57,8 @@ The namespace exports the following: - [`binaryFactory( prng, idtypes, odtypes, policies[, options] )`][@stdlib/random/tools/binary-factory]: create a function for generating pseudorandom values drawn from a binary PRNG. - [`binary( prng, idtypes, odtypes, policies[, options] )`][@stdlib/random/tools/binary]: constructor for creating ndarrays filled with pseudorandom values drawn from a binary PRNG. +- [`ternaryFactory( prng, idtypes, odtypes, policies[, options] )`][@stdlib/random/tools/ternary-factory]: create a function for generating pseudorandom values drawn from a ternary PRNG. +- [`ternary( prng, idtypes, odtypes, policies[, options] )`][@stdlib/random/tools/ternary]: constructor for creating ndarrays filled with pseudorandom values drawn from a ternary PRNG. - [`unaryFactory( prng, idtypes, odtypes, policies[, options] )`][@stdlib/random/tools/unary-factory]: create a function for generating pseudorandom values drawn from a unary PRNG. - [`unary( prng, idtypes, odtypes, policies[, options] )`][@stdlib/random/tools/unary]: constructor for creating ndarrays filled with pseudorandom values drawn from a unary PRNG. @@ -115,6 +117,10 @@ console.log( objectKeys( ns ) ); [@stdlib/random/tools/binary]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/tools/binary +[@stdlib/random/tools/ternary-factory]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/tools/ternary-factory + +[@stdlib/random/tools/ternary]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/tools/ternary + [@stdlib/random/tools/unary-factory]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/tools/unary-factory [@stdlib/random/tools/unary]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/tools/unary diff --git a/lib/node_modules/@stdlib/utils/README.md b/lib/node_modules/@stdlib/utils/README.md index ba0bda00cb85..54b3266c530d 100644 --- a/lib/node_modules/@stdlib/utils/README.md +++ b/lib/node_modules/@stdlib/utils/README.md @@ -62,8 +62,6 @@ The namespace has the following sub-namespaces: - [`any( collection )`][@stdlib/utils/any]: test whether at least one element in a collection is truthy. - [`append( collection1, collection2 )`][@stdlib/utils/append]: add elements from one collection to the end of another collection. - [`bifurcateBy( collection, [options,] predicate )`][@stdlib/utils/bifurcate-by]: split values into two groups according to a predicate function. -- [`bifurcateIn( obj, [options,] predicate )`][@stdlib/utils/bifurcate-in]: split an object's **own** and **inherited** property values into two groups according to a predicate function. -- [`bifurcateOwn( obj, [options,] predicate )`][@stdlib/utils/bifurcate-own]: split an object's **own** property values into two groups according to a predicate function. - [`bifurcate( collection, [options,] filter )`][@stdlib/utils/bifurcate]: split values into two groups. - [`countBy( collection, [options,] indicator )`][@stdlib/utils/count-by]: group values according to an indicator function and return group counts. - [`everyByRight( collection, predicate[, thisArg ] )`][@stdlib/utils/every-by-right]: test whether all elements in a collection pass a test implemented by a predicate function, iterating from right to left. @@ -129,9 +127,6 @@ The namespace has the following sub-namespaces:
-- [`commonKeys( obj1, obj2[, obj3[,...,objN]] )`][@stdlib/utils/common-keys]: return the common own property names of two or more objects. -- [`deepGet( obj, path[, options] )`][@stdlib/utils/deep-get]: get a nested property value. -- [`deepSet( obj, path, value[, options] )`][@stdlib/utils/deep-set]: set a nested property value. - [`setConfigurableReadOnlyAccessor( obj, prop, getter )`][@stdlib/utils/define-configurable-read-only-accessor]: define a configurable **read-only** accessor. - [`setConfigurableReadOnly( obj, prop, value )`][@stdlib/utils/define-configurable-read-only-property]: define a configurable **read-only** property. - [`setConfigurableReadWriteAccessor( obj, prop, getter, setter )`][@stdlib/utils/define-configurable-read-write-accessor]: define a configurable **read-write** accessor. @@ -157,8 +152,6 @@ The namespace has the following sub-namespaces: - [`enumerablePropertySymbolsIn( obj )`][@stdlib/utils/enumerable-property-symbols-in]: return an array of an object's own and inherited enumerable symbol properties. - [`enumerablePropertySymbols( obj )`][@stdlib/utils/enumerable-property-symbols]: return an array of an object's own enumerable symbol properties. - [`flattenObject( obj[, options] )`][@stdlib/utils/flatten-object]: flatten an object. -- [`forIn( obj, fcn[, thisArg ] )`][@stdlib/utils/for-in]: invoke a function for each own and inherited enumerable property of an object. -- [`forOwn( obj, fcn[, thisArg ] )`][@stdlib/utils/for-own]: invoke a function for each own enumerable property of an object. - [`getPrototypeOf( value )`][@stdlib/utils/get-prototype-of]: return the prototype of a provided object. - [`inheritedEnumerableProperties( obj[, level] )`][@stdlib/utils/inherited-enumerable-properties]: return an array of an object's inherited enumerable property names and symbols. - [`inheritedEnumerablePropertySymbols( obj[, level] )`][@stdlib/utils/inherited-enumerable-property-symbols]: return an array of an object's inherited enumerable symbol properties. @@ -175,7 +168,6 @@ The namespace has the following sub-namespaces: - [`inheritedWritablePropertyNames( obj[, level] )`][@stdlib/utils/inherited-writable-property-names]: return an array of an object's inherited writable property names. - [`inheritedWritablePropertySymbols( obj[, level] )`][@stdlib/utils/inherited-writable-property-symbols]: return an array of an object's inherited writable symbol properties. - [`keysIn( obj )`][@stdlib/utils/keys-in]: return an array of an object's own and inherited enumerable property names. -- [`lowercaseKeys( obj )`][@stdlib/utils/lowercase-keys]: convert each object key to lowercase. - [`mapKeys( obj, transform )`][@stdlib/utils/map-keys]: map keys from one object to a new object having the same values. - [`mapValues( obj, transform )`][@stdlib/utils/map-values]: map values from one object to a new object having the same keys. - [`merge( target, source1[, source2[,...,sourceN]] )`][@stdlib/utils/merge]: merge and extend objects. @@ -186,8 +178,6 @@ The namespace has the following sub-namespaces: - [`nonEnumerablePropertySymbolsIn( obj )`][@stdlib/utils/nonenumerable-property-symbols-in]: return an array of an object's own and inherited non-enumerable symbol properties. - [`nonEnumerablePropertySymbols( obj )`][@stdlib/utils/nonenumerable-property-symbols]: return an array of an object's own non-enumerable symbol properties. - [`nonIndexKeys( obj )`][@stdlib/utils/nonindex-keys]: return an array of an object's own enumerable property names which are not integer indices. -- [`objectInverseBy( obj, [options,] transform )`][@stdlib/utils/object-inverse-by]: invert an object, such that keys become values and values become keys, according to a transform function. -- [`objectInverse( obj[, options] )`][@stdlib/utils/object-inverse]: invert an object, such that keys become values and values become keys. - [`omitBy( obj, predicate )`][@stdlib/utils/omit-by]: return a partial object copy excluding properties for which a predicate (function) returns a truthy value. - [`omit( obj, keys )`][@stdlib/utils/omit]: return a partial object copy excluding specified keys. - [`pickArguments( fcn, indices[, thisArg] )`][@stdlib/utils/pick-arguments]: create a function that invokes a provided function with specified arguments. @@ -203,8 +193,6 @@ The namespace has the following sub-namespaces: - [`propertyNames( obj )`][@stdlib/utils/property-names]: return an array of an object's own enumerable and non-enumerable property names. - [`propertySymbolsIn( obj )`][@stdlib/utils/property-symbols-in]: return an array of an object's own and inherited symbol properties. - [`propertySymbols( obj )`][@stdlib/utils/property-symbols]: return an array of an object's own symbol properties. -- [`uncapitalizeKeys( obj )`][@stdlib/utils/uncapitalize-keys]: convert the first letter of each object key to lowercase. -- [`uppercaseKeys( obj )`][@stdlib/utils/uppercase-keys]: convert each object key to uppercase. - [`objectValuesIn( obj )`][@stdlib/utils/values-in]: return an array of an object's own and inherited enumerable property values. - [`objectValues( obj )`][@stdlib/utils/values]: return an array of an object's own enumerable property values. - [`writablePropertiesIn( obj )`][@stdlib/utils/writable-properties-in]: return an array of an object's own and inherited writable property names and symbols. @@ -279,7 +267,6 @@ The namespace has the following sub-namespaces:
-- [`commonKeysIn( obj1, obj2[, obj3[,...,objN]] )`][@stdlib/utils/common-keys-in]: return the common own and inherited property names of two or more objects. - [`constructorName( value )`][@stdlib/utils/constructor-name]: determine the name of a value's constructor. - [`convertPath( from, to )`][@stdlib/utils/convert-path]: convert between POSIX and Windows paths. - [`copy( value[, level] )`][@stdlib/utils/copy]: copy or deep clone a value to an arbitrary depth. @@ -363,8 +350,6 @@ console.log( objectKeys( utils ) ); -[@stdlib/utils/common-keys-in]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/common-keys-in - [@stdlib/utils/constructor-name]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/constructor-name [@stdlib/utils/convert-path]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/convert-path @@ -513,12 +498,6 @@ console.log( objectKeys( utils ) ); [@stdlib/utils/while]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/while -[@stdlib/utils/common-keys]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/common-keys - -[@stdlib/utils/deep-get]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/deep-get - -[@stdlib/utils/deep-set]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/deep-set - [@stdlib/utils/define-configurable-read-only-accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/define-configurable-read-only-accessor [@stdlib/utils/define-configurable-read-only-property]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/define-configurable-read-only-property @@ -569,10 +548,6 @@ console.log( objectKeys( utils ) ); [@stdlib/utils/flatten-object]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/flatten-object -[@stdlib/utils/for-in]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/for-in - -[@stdlib/utils/for-own]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/for-own - [@stdlib/utils/get-prototype-of]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/get-prototype-of [@stdlib/utils/inherited-enumerable-properties]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/inherited-enumerable-properties @@ -605,8 +580,6 @@ console.log( objectKeys( utils ) ); [@stdlib/utils/keys-in]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/keys-in -[@stdlib/utils/lowercase-keys]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/lowercase-keys - [@stdlib/utils/map-keys]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/map-keys [@stdlib/utils/map-values]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/map-values @@ -627,10 +600,6 @@ console.log( objectKeys( utils ) ); [@stdlib/utils/nonindex-keys]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/nonindex-keys -[@stdlib/utils/object-inverse-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/object-inverse-by - -[@stdlib/utils/object-inverse]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/object-inverse - [@stdlib/utils/omit-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/omit-by [@stdlib/utils/omit]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/omit @@ -661,10 +630,6 @@ console.log( objectKeys( utils ) ); [@stdlib/utils/property-symbols]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/property-symbols -[@stdlib/utils/uncapitalize-keys]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/uncapitalize-keys - -[@stdlib/utils/uppercase-keys]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/uppercase-keys - [@stdlib/utils/values-in]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/values-in [@stdlib/utils/values]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/values @@ -707,10 +672,6 @@ console.log( objectKeys( utils ) ); [@stdlib/utils/bifurcate-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/bifurcate-by -[@stdlib/utils/bifurcate-in]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/bifurcate-in - -[@stdlib/utils/bifurcate-own]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/bifurcate-own - [@stdlib/utils/bifurcate]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/bifurcate [@stdlib/utils/count-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/count-by