diff --git a/lib/node_modules/@stdlib/array/README.md b/lib/node_modules/@stdlib/array/README.md index 62a37a8c896c..687e05f79d32 100644 --- a/lib/node_modules/@stdlib/array/README.md +++ b/lib/node_modules/@stdlib/array/README.md @@ -107,12 +107,12 @@ You can use the following functions to retrieve a list of available data types:
-- [`arrayDataTypes( [kind] )`][@stdlib/array/dtypes]: list of array data types. +- [`dtypes( [kind] )`][@stdlib/array/dtypes]: list of array data types. - [`complexarrayDataTypes()`][@stdlib/array/typed-complex-dtypes]: list of complex typed array data types. - [`typedarrayDataTypes()`][@stdlib/array/typed-dtypes]: list of typed array data types. - [`floatarrayDataTypes()`][@stdlib/array/typed-float-dtypes]: list of typed array floating-point data types. - [`intarrayDataTypes()`][@stdlib/array/typed-integer-dtypes]: list of typed array integer data types. -- [`realarrayDataTypes()`][@stdlib/array/typed-real-dtypes]: list of typed array data types. +- [`realarrayDataTypes()`][@stdlib/array/typed-real-dtypes]: list of typed array real-valued data types. - [`realarrayFloatDataTypes()`][@stdlib/array/typed-real-float-dtypes]: list of typed array real-valued floating-point data types. - [`intarraySignedDataTypes()`][@stdlib/array/typed-signed-integer-dtypes]: list of typed array signed integer data types. - [`intarrayUnsignedDataTypes()`][@stdlib/array/typed-unsigned-integer-dtypes]: list of typed array unsigned integer data types. @@ -127,7 +127,8 @@ Furthermore, the namespace contains utility functions to retrieve a given constr
-- [`arrayCtors( dtype )`][@stdlib/array/ctors]: array constructors. +- [`ctors( dtype )`][@stdlib/array/ctors]: array constructors. +- [`ArrayIndex( x[, options] )`][@stdlib/array/index]: array index constructor. - [`complexarrayCtors( dtype )`][@stdlib/array/typed-complex-ctors]: complex typed array constructors. - [`typedarrayCtors( dtype )`][@stdlib/array/typed-ctors]: typed array constructors. - [`floatarrayCtors( dtype )`][@stdlib/array/typed-float-ctors]: floating-point typed array constructors. @@ -156,39 +157,45 @@ Lastly, the namespace contains various other functions for dealing with arrays,
- [`base`][@stdlib/array/base]: base (i.e., lower-level) array utilities. -- [`acartesianPower( x, n )`][@stdlib/array/cartesian-power]: return the Cartesian power. -- [`acartesianProduct( x1, x2 )`][@stdlib/array/cartesian-product]: return the Cartesian product. -- [`acartesianSquare( x )`][@stdlib/array/cartesian-square]: return the Cartesian square. +- [`cartesianPower( x, n )`][@stdlib/array/cartesian-power]: return the Cartesian power. +- [`cartesianProduct( x1, x2 )`][@stdlib/array/cartesian-product]: return the Cartesian product. +- [`cartesianSquare( x )`][@stdlib/array/cartesian-square]: return the Cartesian square. - [`Complex128Array()`][@stdlib/array/complex128]: 128-bit complex number array. - [`Complex64Array()`][@stdlib/array/complex64]: 64-bit complex number array. -- [`convertArraySame( x, y )`][@stdlib/array/convert-same]: convert an array to the same data type as a second input array. -- [`convertArray( arr, dtype )`][@stdlib/array/convert]: convert an array to an array of a different data type. +- [`convertSame( x, y )`][@stdlib/array/convert-same]: convert an array to the same data type as a second input array. +- [`convert( arr, dtype )`][@stdlib/array/convert]: convert an array to an array of a different data type. - [`DataView( buffer[, byteOffset[, byteLength]] )`][@stdlib/array/dataview]: constructor which returns a data view representing a provided array buffer. -- [`arrayDefaults()`][@stdlib/array/defaults]: default array settings. -- [`arrayDataType( array )`][@stdlib/array/dtype]: return the data type of an array. -- [`aemptyLike( x[, dtype] )`][@stdlib/array/empty-like]: create an uninitialized array having the same length and data type as a provided array. -- [`aempty( length[, dtype] )`][@stdlib/array/empty]: create an uninitialized array having a specified length. -- [`filledarrayBy()`][@stdlib/array/filled-by]: create a filled array according to a provided callback function. -- [`filledarray()`][@stdlib/array/filled]: create a filled array. +- [`defaults()`][@stdlib/array/defaults]: default array settings. +- [`dtype( array )`][@stdlib/array/dtype]: return the data type of an array. +- [`emptyLike( x[, dtype] )`][@stdlib/array/empty-like]: create an uninitialized array having the same length and data type as a provided array. +- [`empty( length[, dtype] )`][@stdlib/array/empty]: create an uninitialized array having a specified length. +- [`filledBy()`][@stdlib/array/filled-by]: create a filled array according to a provided callback function. +- [`filled()`][@stdlib/array/filled]: create a filled array. - [`iterator2array( iterator[, out][, mapFcn[, thisArg]] )`][@stdlib/array/from-iterator]: create (or fill) an array from an iterator. -- [`afullLike( x, value[, dtype] )`][@stdlib/array/full-like]: create a filled array having the same length and data type as a provided array. -- [`afull( length, value[, dtype] )`][@stdlib/array/full]: create a filled array having a specified length. -- [`arrayMinDataType( value )`][@stdlib/array/min-dtype]: determine the minimum array data type of the closest "kind" necessary for storing a provided scalar value. -- [`anansLike( x[, dtype] )`][@stdlib/array/nans-like]: create an array filled with NaNs and having the same length and data type as a provided array. -- [`anans( length[, dtype] )`][@stdlib/array/nans]: create an array filled with NaNs and having a specified length. -- [`arrayNextDataType( [dtype] )`][@stdlib/array/next-dtype]: return the next larger array data type of the same kind. -- [`aoneToLike( x[, dtype] )`][@stdlib/array/one-to-like]: generate a linearly spaced numeric array whose elements increment by `1` starting from one and having the same length and data type as a provided input array. -- [`aoneTo( n[, dtype] )`][@stdlib/array/one-to]: generate a linearly spaced numeric array whose elements increment by `1` starting from one. -- [`aonesLike( x[, dtype] )`][@stdlib/array/ones-like]: create an array filled with ones and having the same length and data type as a provided array. -- [`aones( length[, dtype] )`][@stdlib/array/ones]: create an array filled with ones and having a specified length. +- [`scalar2array( value[, dtype] )`][@stdlib/array/from-scalar]: create a single-element array containing a provided scalar value. +- [`fullLike( x, value[, dtype] )`][@stdlib/array/full-like]: create a filled array having the same length and data type as a provided array. +- [`full( length, value[, dtype] )`][@stdlib/array/full]: create a filled array having a specified length. +- [`minDataType( value )`][@stdlib/array/min-dtype]: determine the minimum array data type of the closest "kind" necessary for storing a provided scalar value. +- [`mostlySafeCasts( [dtype] )`][@stdlib/array/mostly-safe-casts]: return a list of array data types to which a provided array data type can be safely cast and, for floating-point data types, can be downcast. +- [`mskfilter( x, mask )`][@stdlib/array/mskfilter]: apply a mask to a provided input array. +- [`mskreject( x, mask )`][@stdlib/array/mskreject]: apply a mask to a provided input array. +- [`nansLike( x[, dtype] )`][@stdlib/array/nans-like]: create an array filled with NaNs and having the same length and data type as a provided array. +- [`nans( length[, dtype] )`][@stdlib/array/nans]: create an array filled with NaNs and having a specified length. +- [`nextDataType( [dtype] )`][@stdlib/array/next-dtype]: return the next larger array data type of the same kind. +- [`oneToLike( x[, dtype] )`][@stdlib/array/one-to-like]: generate a linearly spaced numeric array whose elements increment by `1` starting from one and having the same length and data type as a provided input array. +- [`oneTo( n[, dtype] )`][@stdlib/array/one-to]: generate a linearly spaced numeric array whose elements increment by `1` starting from one. +- [`onesLike( x[, dtype] )`][@stdlib/array/ones-like]: create an array filled with ones and having the same length and data type as a provided array. +- [`ones( length[, dtype] )`][@stdlib/array/ones]: create an array filled with ones and having a specified length. - [`typedarraypool()`][@stdlib/array/pool]: allocate typed arrays from a typed array memory pool. -- [`arrayPromotionRules( [dtype1, dtype2] )`][@stdlib/array/promotion-rules]: return the array data type with the smallest size and closest "kind" to which array data types can be **safely** cast. -- [`reviveTypedArray( key, value )`][@stdlib/array/reviver]: revive a JSON-serialized typed array. -- [`arraySafeCasts( [dtype] )`][@stdlib/array/safe-casts]: return a list of array data types to which a provided array data type can be safely cast. -- [`arraySameKindCasts( [dtype] )`][@stdlib/array/same-kind-casts]: return a list of array data types to which a provided array data type can be safely cast or cast within the same "kind". -- [`arrayShape( arr )`][@stdlib/array/shape]: determine (nested) array dimensions. -- [`aslice( x[, start[, end]] )`][@stdlib/array/slice]: return a shallow copy of a portion of an array. +- [`promotionRules( [dtype1, dtype2] )`][@stdlib/array/promotion-rules]: return the array data type with the smallest size and closest "kind" to which array data types can be **safely** cast. +- [`typedarrayReviver( key, value )`][@stdlib/array/reviver]: revive a JSON-serialized typed array. +- [`safeCasts( [dtype] )`][@stdlib/array/safe-casts]: return a list of array data types to which a provided array data type can be safely cast. +- [`sameKindCasts( [dtype] )`][@stdlib/array/same-kind-casts]: return a list of array data types to which a provided array data type can be safely cast or cast within the same "kind". +- [`shape( arr )`][@stdlib/array/shape]: determine (nested) array dimensions. +- [`slice( x[, start[, end]] )`][@stdlib/array/slice]: return a shallow copy of a portion of an array. +- [`take( x, indices[, options] )`][@stdlib/array/take]: take elements from an array. - [`circarray2iterator( src[, options][, mapFcn[, thisArg]] )`][@stdlib/array/to-circular-iterator]: create an iterator which repeatedly iterates over the elements of an array-like object. +- [`array2fancy( x[, options] )`][@stdlib/array/to-fancy]: convert an array to an object supporting fancy indexing. - [`array2iteratorRight( src[, mapFcn[, thisArg]] )`][@stdlib/array/to-iterator-right]: create an iterator from an array-like object, iterating from right to left. - [`array2iterator( src[, mapFcn[, thisArg]] )`][@stdlib/array/to-iterator]: create an iterator from an array-like object. - [`typedarray2json( typedarray )`][@stdlib/array/to-json]: return a JSON representation of a typed array. @@ -199,10 +206,10 @@ Lastly, the namespace contains various other functions for dealing with arrays, - [`arrayview2iterator( src[, begin[, end]][, mapFcn[, thisArg]] )`][@stdlib/array/to-view-iterator]: create an iterator from an array-like object view. - [`complexarray()`][@stdlib/array/typed-complex]: create a complex number typed array. - [`realarray()`][@stdlib/array/typed-real]: create a typed array. -- [`azeroToLike( x[, dtype] )`][@stdlib/array/zero-to-like]: generate a linearly spaced numeric array whose elements increment by `1` starting from zero and having the same length and data type as a provided input array. -- [`azeroTo( n[, dtype] )`][@stdlib/array/zero-to]: generate a linearly spaced numeric array whose elements increment by `1` starting from zero. -- [`azerosLike( x[, dtype] )`][@stdlib/array/zeros-like]: create a zero-filled array having the same length and data type as a provided array. -- [`azeros( length[, dtype] )`][@stdlib/array/zeros]: create a zero-filled array having a specified length. +- [`zeroToLike( x[, dtype] )`][@stdlib/array/zero-to-like]: generate a linearly spaced numeric array whose elements increment by `1` starting from zero and having the same length and data type as a provided input array. +- [`zeroTo( n[, dtype] )`][@stdlib/array/zero-to]: generate a linearly spaced numeric array whose elements increment by `1` starting from zero. +- [`zerosLike( x[, dtype] )`][@stdlib/array/zeros-like]: create a zero-filled array having the same length and data type as a provided array. +- [`zeros( length[, dtype] )`][@stdlib/array/zeros]: create a zero-filled array having a specified length.
@@ -277,12 +284,20 @@ console.log( objectKeys( ns ) ); [@stdlib/array/from-iterator]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/from-iterator +[@stdlib/array/from-scalar]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/from-scalar + [@stdlib/array/full-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/full-like [@stdlib/array/full]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/full [@stdlib/array/min-dtype]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/min-dtype +[@stdlib/array/mostly-safe-casts]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/mostly-safe-casts + +[@stdlib/array/mskfilter]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/mskfilter + +[@stdlib/array/mskreject]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/mskreject + [@stdlib/array/nans-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/nans-like [@stdlib/array/nans]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/nans @@ -311,8 +326,12 @@ console.log( objectKeys( ns ) ); [@stdlib/array/slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/slice +[@stdlib/array/take]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/take + [@stdlib/array/to-circular-iterator]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/to-circular-iterator +[@stdlib/array/to-fancy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/to-fancy + [@stdlib/array/to-iterator-right]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/to-iterator-right [@stdlib/array/to-iterator]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/to-iterator @@ -343,6 +362,8 @@ console.log( objectKeys( ns ) ); [@stdlib/array/ctors]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/ctors +[@stdlib/array/index]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/index + [@stdlib/array/typed-complex-ctors]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/typed-complex-ctors [@stdlib/array/typed-ctors]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/typed-ctors diff --git a/lib/node_modules/@stdlib/array/base/README.md b/lib/node_modules/@stdlib/array/base/README.md index d51e04107e93..91820a24b21d 100644 --- a/lib/node_modules/@stdlib/array/base/README.md +++ b/lib/node_modules/@stdlib/array/base/README.md @@ -88,10 +88,14 @@ The namespace exports the following: - [`cartesianSquare( x )`][@stdlib/array/base/cartesian-square]: return the Cartesian square. - [`copyIndexed( x )`][@stdlib/array/base/copy-indexed]: copy the elements of an indexed array-like object to a new "generic" array. - [`copy( x )`][@stdlib/array/base/copy]: copy the elements of an array-like object to a new "generic" array. +- [`countFalsy( x )`][@stdlib/array/base/count-falsy]: count the number of falsy elements in an array. +- [`countTruthy( x )`][@stdlib/array/base/count-truthy]: count the number of truthy elements in an array. - [`dedupe( x, limit, equalNaNs )`][@stdlib/array/base/dedupe]: remove consecutive duplicated values. - [`everyByRight( x, predicate[, thisArg] )`][@stdlib/array/base/every-by-right]: test whether all elements in an array pass a test implemented by a predicate function, iterating from right to left. - [`everyBy( x, predicate[, thisArg] )`][@stdlib/array/base/every-by]: test whether all elements in an array pass a test implemented by a predicate function. - [`every( x )`][@stdlib/array/base/every]: test whether all elements in an array are truthy. +- [`fancySliceAssign( x, y, s, strict )`][@stdlib/array/base/fancy-slice-assign]: assign element values from a broadcasted input array to corresponding elements in an output array. +- [`fancySlice( x, s, strict )`][@stdlib/array/base/fancy-slice]: return a shallow copy of a portion of an array. - [`filledBy( len, clbk[, thisArg] )`][@stdlib/array/base/filled-by]: create a filled "generic" array according to a provided callback function. - [`filled( value, len )`][@stdlib/array/base/filled]: create a filled "generic" array. - [`filled2dBy( shape, clbk[, thisArg] )`][@stdlib/array/base/filled2d-by]: create a filled two-dimensional nested array according to a provided callback function. @@ -142,9 +146,11 @@ The namespace exports the following: - [`map3d( x, shape, fcn[, thisArg] )`][@stdlib/array/base/map3d]: apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. - [`map4d( x, shape, fcn[, thisArg] )`][@stdlib/array/base/map4d]: apply a function to elements in a four-dimensional nested input array and assign results to elements in a new four-dimensional nested output array. - [`map5d( x, shape, fcn[, thisArg] )`][@stdlib/array/base/map5d]: apply a function to elements in a five-dimensional nested input array and assign results to elements in a new five-dimensional nested output array. +- [`minSignedIntegerDataType( value )`][@stdlib/array/base/min-signed-integer-dtype]: determine the minimum array data type for storing a provided signed integer value. +- [`minUnsignedIntegerDataType( value )`][@stdlib/array/base/min-unsigned-integer-dtype]: determine the minimum array data type for storing a provided unsigned integer value. - [`mskbinary2d( arrays, shape, fcn )`][@stdlib/array/base/mskbinary2d]: apply a binary callback to elements in two two-dimensional nested input arrays according to elements in a two-dimensional nested mask array and assign results to elements in a two-dimensional nested output array. -- [`mskfilter( x, mask )`][@stdlib/array/base/mskfilter]: return a new array by applying a mask to a provided input array. -- [`mskreject( x, mask )`][@stdlib/array/base/mskreject]: return a new array by applying a mask to a provided input array. +- [`mskfilter( x, mask )`][@stdlib/array/base/mskfilter]: apply a mask to a provided input array. +- [`mskreject( x, mask )`][@stdlib/array/base/mskreject]: apply a mask to a provided input array. - [`mskunary2d( arrays, shape, fcn )`][@stdlib/array/base/mskunary2d]: apply a unary callback to elements in a two-dimensional nested input array according to elements in a two-dimensional nested mask array and assign results to elements in a two-dimensional nested output array. - [`mskunary3d( arrays, shape, fcn )`][@stdlib/array/base/mskunary3d]: apply a unary callback to elements in a three-dimensional nested input array according to elements in a three-dimensional nested mask array and assign results to elements in a three-dimensional nested output array. - [`nCartesianProduct( x1, x2[, ...xN] )`][@stdlib/array/base/n-cartesian-product]: return the n-fold Cartesian product. @@ -177,7 +183,7 @@ The namespace exports the following: - [`strided2array4d( x, shape, strides, offset )`][@stdlib/array/base/strided2array4d]: convert a strided array to a four-dimensional nested array. - [`strided2array5d( x, shape, strides, offset )`][@stdlib/array/base/strided2array5d]: convert a strided array to a five-dimensional nested array. - [`takeIndexed( x, indices )`][@stdlib/array/base/take-indexed]: take elements from an indexed array. -- [`take( x, indices )`][@stdlib/array/base/take]: take elements from an array. +- [`take( x, indices, mode )`][@stdlib/array/base/take]: take elements from an array. - [`take2d( x, indices, dimension, mode )`][@stdlib/array/base/take2d]: take elements from a two-dimensional nested array. - [`take3d( x, indices, dimension, mode )`][@stdlib/array/base/take3d]: take elements from a three-dimensional nested array. - [`ternary2d( arrays, shape, fcn )`][@stdlib/array/base/ternary2d]: apply a ternary callback to elements in three two-dimensional nested input arrays and assign results to elements in a two-dimensional nested output array. @@ -329,6 +335,10 @@ console.log( objectKeys( ns ) ); [@stdlib/array/base/copy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/copy +[@stdlib/array/base/count-falsy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/count-falsy + +[@stdlib/array/base/count-truthy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/count-truthy + [@stdlib/array/base/dedupe]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/dedupe [@stdlib/array/base/every-by-right]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/every-by-right @@ -337,6 +347,10 @@ console.log( objectKeys( ns ) ); [@stdlib/array/base/every]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/every +[@stdlib/array/base/fancy-slice-assign]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/fancy-slice-assign + +[@stdlib/array/base/fancy-slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/fancy-slice + [@stdlib/array/base/filled-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filled-by [@stdlib/array/base/filled]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filled @@ -437,6 +451,10 @@ console.log( objectKeys( ns ) ); [@stdlib/array/base/map5d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map5d +[@stdlib/array/base/min-signed-integer-dtype]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/min-signed-integer-dtype + +[@stdlib/array/base/min-unsigned-integer-dtype]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/min-unsigned-integer-dtype + [@stdlib/array/base/mskbinary2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/mskbinary2d [@stdlib/array/base/mskfilter]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/mskfilter diff --git a/lib/node_modules/@stdlib/array/base/assert/README.md b/lib/node_modules/@stdlib/array/base/assert/README.md index 3fd2580d8b13..b2d27de4888c 100644 --- a/lib/node_modules/@stdlib/array/base/assert/README.md +++ b/lib/node_modules/@stdlib/array/base/assert/README.md @@ -48,8 +48,21 @@ The namespace exports the following: - [`contains( x, value )`][@stdlib/array/base/assert/contains]: test if an array contains a provided search value. - [`hasSameValues( x, y )`][@stdlib/array/base/assert/has-same-values]: test if two arrays have the same values. - [`isAccessorArray( value )`][@stdlib/array/base/assert/is-accessor-array]: test if an array-like object supports the accessor (get/set) protocol. +- [`isComplexFloatingPointDataType( value )`][@stdlib/array/base/assert/is-complex-floating-point-data-type]: test if an input value is a supported array complex-valued floating-point data type. +- [`isComplexTypedArray( value )`][@stdlib/array/base/assert/is-complex-typed-array]: test if a value is a complex typed array. - [`isComplex128Array( value )`][@stdlib/array/base/assert/is-complex128array]: test if a value is a `Complex128Array`. - [`isComplex64Array( value )`][@stdlib/array/base/assert/is-complex64array]: test if a value is a `Complex64Array`. +- [`isDataType( value )`][@stdlib/array/base/assert/is-data-type]: test if an input value is a supported array data type. +- [`isFloatingPointDataType( value )`][@stdlib/array/base/assert/is-floating-point-data-type]: test if an input value is a supported array floating-point data type. +- [`isIntegerDataType( value )`][@stdlib/array/base/assert/is-integer-data-type]: test if an input value is a supported array integer data type. +- [`isMostlySafeDataTypeCast( from, to )`][@stdlib/array/base/assert/is-mostly-safe-data-type-cast]: determine whether an array data type can be safely cast or, for floating-point data types, downcast to another array data type. +- [`isNumericDataType( value )`][@stdlib/array/base/assert/is-numeric-data-type]: test if an input value is a supported array numeric data type. +- [`isRealDataType( value )`][@stdlib/array/base/assert/is-real-data-type]: test if an input value is a supported array real-valued data type. +- [`isRealFloatingPointDataType( value )`][@stdlib/array/base/assert/is-real-floating-point-data-type]: test if an input value is a supported array real-valued floating-point data type. +- [`isSafeDataTypeCast( from, to )`][@stdlib/array/base/assert/is-safe-data-type-cast]: determine whether an array data type can be safely cast to another array data type. +- [`isSameKindDataTypeCast( from, to )`][@stdlib/array/base/assert/is-same-kind-data-type-cast]: determine whether an array data type can be safely cast to, or is of the same "kind" as, another array data type. +- [`isSignedIntegerDataType( value )`][@stdlib/array/base/assert/is-signed-integer-data-type]: test if an input value is a supported array signed integer data type. +- [`isUnsignedIntegerDataType( value )`][@stdlib/array/base/assert/is-unsigned-integer-data-type]: test if an input value is a supported array unsigned integer data type.
@@ -98,10 +111,36 @@ console.log( objectKeys( ns ) ); [@stdlib/array/base/assert/is-accessor-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/is-accessor-array +[@stdlib/array/base/assert/is-complex-floating-point-data-type]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/is-complex-floating-point-data-type + +[@stdlib/array/base/assert/is-complex-typed-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/is-complex-typed-array + [@stdlib/array/base/assert/is-complex128array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/is-complex128array [@stdlib/array/base/assert/is-complex64array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/is-complex64array +[@stdlib/array/base/assert/is-data-type]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/is-data-type + +[@stdlib/array/base/assert/is-floating-point-data-type]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/is-floating-point-data-type + +[@stdlib/array/base/assert/is-integer-data-type]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/is-integer-data-type + +[@stdlib/array/base/assert/is-mostly-safe-data-type-cast]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/is-mostly-safe-data-type-cast + +[@stdlib/array/base/assert/is-numeric-data-type]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/is-numeric-data-type + +[@stdlib/array/base/assert/is-real-data-type]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/is-real-data-type + +[@stdlib/array/base/assert/is-real-floating-point-data-type]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/is-real-floating-point-data-type + +[@stdlib/array/base/assert/is-safe-data-type-cast]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/is-safe-data-type-cast + +[@stdlib/array/base/assert/is-same-kind-data-type-cast]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/is-same-kind-data-type-cast + +[@stdlib/array/base/assert/is-signed-integer-data-type]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/is-signed-integer-data-type + +[@stdlib/array/base/assert/is-unsigned-integer-data-type]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/is-unsigned-integer-data-type + diff --git a/lib/node_modules/@stdlib/ndarray/README.md b/lib/node_modules/@stdlib/ndarray/README.md index 258cbecccbc2..a46df8a058b6 100644 --- a/lib/node_modules/@stdlib/ndarray/README.md +++ b/lib/node_modules/@stdlib/ndarray/README.md @@ -71,52 +71,52 @@ In addition, the namespace contains the following multidimensional array utility
-- [`ndat( x[, ...indices] )`][@stdlib/ndarray/at]: return an `ndarray` element. +- [`at( x[, ...indices] )`][@stdlib/ndarray/at]: return an `ndarray` element. - [`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. -- [`ndarrayCastingModes()`][@stdlib/ndarray/casting-modes]: list of ndarray casting modes. -- [`ndarrayDataBuffer( x )`][@stdlib/ndarray/data-buffer]: return the underlying data buffer of a provided ndarray. +- [`castingModes()`][@stdlib/ndarray/casting-modes]: list of ndarray casting modes. +- [`dataBuffer( x )`][@stdlib/ndarray/data-buffer]: return the underlying data buffer of a provided ndarray. - [`defaults()`][@stdlib/ndarray/defaults]: default ndarray settings. - [`dispatch( fcns, types, data, nargs, nin, nout )`][@stdlib/ndarray/dispatch]: create an ndarray function interface which performs multiple dispatch. -- [`ndarrayDataType( x )`][@stdlib/ndarray/dtype]: return the data type of a provided ndarray. -- [`ndarrayDataTypes( [kind] )`][@stdlib/ndarray/dtypes]: list of ndarray data types. -- [`ndemptyLike( x[, options] )`][@stdlib/ndarray/empty-like]: create an uninitialized ndarray having the same shape and data type as a provided ndarray. -- [`ndempty( shape[, options] )`][@stdlib/ndarray/empty]: create an uninitialized ndarray having a specified shape and data type. +- [`dtype( x )`][@stdlib/ndarray/dtype]: return the data type of a provided ndarray. +- [`dtypes( [kind] )`][@stdlib/ndarray/dtypes]: list of ndarray data types. +- [`emptyLike( x[, options] )`][@stdlib/ndarray/empty-like]: create an uninitialized ndarray having the same shape and data type as a provided ndarray. +- [`empty( shape[, options] )`][@stdlib/ndarray/empty]: create an uninitialized ndarray having a specified shape and data type. - [`FancyArray( dtype, buffer, shape, strides, offset, order[, options] )`][@stdlib/ndarray/fancy]: fancy multidimensional array constructor. -- [`ndarrayFlag( x, name )`][@stdlib/ndarray/flag]: return a specified flag for a provided ndarray. -- [`ndarrayFlags( x )`][@stdlib/ndarray/flags]: return the flags of a provided ndarray. +- [`flag( x, name )`][@stdlib/ndarray/flag]: return a specified flag for a provided ndarray. +- [`flags( x )`][@stdlib/ndarray/flags]: return the flags of a provided ndarray. - [`scalar2ndarray( value[, options] )`][@stdlib/ndarray/from-scalar]: convert a scalar value to a zero-dimensional ndarray. - [`ind2sub( shape, idx[, options] )`][@stdlib/ndarray/ind2sub]: convert a linear index to an array of subscripts. -- [`ndarrayIndexModes()`][@stdlib/ndarray/index-modes]: list of ndarray index modes. +- [`indexModes()`][@stdlib/ndarray/index-modes]: list of ndarray index modes. - [`maybeBroadcastArray( x, shape )`][@stdlib/ndarray/maybe-broadcast-array]: broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. - [`maybeBroadcastArrays( arrays )`][@stdlib/ndarray/maybe-broadcast-arrays]: broadcast ndarrays to a common shape. -- [`ndarrayMinDataType( value )`][@stdlib/ndarray/min-dtype]: determine the minimum ndarray data type of the closest "kind" necessary for storing a provided scalar value. -- [`ndarrayMostlySafeCasts( [dtype] )`][@stdlib/ndarray/mostly-safe-casts]: return a list of ndarray data types to which a provided ndarray data type can be safely cast and, for floating-point data types, can be downcast. +- [`minDataType( value )`][@stdlib/ndarray/min-dtype]: determine the minimum ndarray data type of the closest "kind" necessary for storing a provided scalar value. +- [`mostlySafeCasts( [dtype] )`][@stdlib/ndarray/mostly-safe-casts]: return a list of ndarray data types to which a provided ndarray data type can be safely cast and, for floating-point data types, can be downcast. - [`ndims( x )`][@stdlib/ndarray/ndims]: return the number of ndarray dimensions. -- [`ndarrayNextDataType( [dtype] )`][@stdlib/ndarray/next-dtype]: return the next larger ndarray data type of the same kind. +- [`nextDataType( [dtype] )`][@stdlib/ndarray/next-dtype]: return the next larger ndarray data type of the same kind. - [`numelDimension( x, dim )`][@stdlib/ndarray/numel-dimension]: return the size (i.e., number of elements) of a specified dimension for a provided ndarray. - [`numel( x )`][@stdlib/ndarray/numel]: return the number of elements in an ndarray. -- [`ndarrayOffset( x )`][@stdlib/ndarray/offset]: return the index offset specifying the underlying buffer index of the first iterated ndarray element. -- [`ndarrayOrder( x )`][@stdlib/ndarray/order]: return the layout order of a provided ndarray. -- [`ndarrayOrders()`][@stdlib/ndarray/orders]: list of ndarray orders. -- [`ndarrayOutputDataTypePolicies()`][@stdlib/ndarray/output-dtype-policies]: list of output ndarray data type policies. -- [`ndarrayPromotionRules( [dtype1, dtype2] )`][@stdlib/ndarray/promotion-rules]: return the ndarray data type with the smallest size and closest "kind" to which ndarray data types can be **safely** cast. -- [`ndarraySafeCasts( [dtype] )`][@stdlib/ndarray/safe-casts]: return a list of ndarray data types to which a provided ndarray data type can be safely cast. -- [`ndarraySameKindCasts( [dtype] )`][@stdlib/ndarray/same-kind-casts]: return a list of ndarray data types to which a provided ndarray data type can be safely cast or cast within the same "kind". -- [`ndarrayShape( x )`][@stdlib/ndarray/shape]: return the shape of a provided ndarray. -- [`ndsliceAssign( x, y, ...s[, options] )`][@stdlib/ndarray/slice-assign]: assign element values from a broadcasted input `ndarray` to corresponding elements in an output `ndarray` view. -- [`ndsliceDimensionFrom( x, dim, start[, options] )`][@stdlib/ndarray/slice-dimension-from]: return a read-only shifted view of an input `ndarray` along a specified dimension. -- [`ndsliceDimensionTo( x, dim, stop[, options] )`][@stdlib/ndarray/slice-dimension-to]: return a read-only truncated view of an input `ndarray` along a specified dimension. -- [`ndsliceDimension( x, dim, slice[, options] )`][@stdlib/ndarray/slice-dimension]: return a read-only view of an input `ndarray` when sliced along a specified dimension. -- [`ndsliceFrom( x, ...start[, options] )`][@stdlib/ndarray/slice-from]: return a read-only shifted view of an input ndarray. -- [`ndsliceTo( x, ...stop[, options] )`][@stdlib/ndarray/slice-to]: return a read-only truncated view of an input ndarray. -- [`ndslice( x, ...s[, options] )`][@stdlib/ndarray/slice]: return a read-only view of an input `ndarray`. -- [`ndarrayStride( x, dim )`][@stdlib/ndarray/stride]: return the stride along a specified dimension for a provided ndarray. -- [`ndarrayStrides( x )`][@stdlib/ndarray/strides]: return the strides of a provided ndarray. +- [`offset( x )`][@stdlib/ndarray/offset]: return the index offset specifying the underlying buffer index of the first iterated ndarray element. +- [`order( x )`][@stdlib/ndarray/order]: return the layout order of a provided ndarray. +- [`orders()`][@stdlib/ndarray/orders]: list of ndarray orders. +- [`outputDataTypePolicies()`][@stdlib/ndarray/output-dtype-policies]: list of output ndarray data type policies. +- [`promotionRules( [dtype1, dtype2] )`][@stdlib/ndarray/promotion-rules]: return the ndarray data type with the smallest size and closest "kind" to which ndarray data types can be **safely** cast. +- [`safeCasts( [dtype] )`][@stdlib/ndarray/safe-casts]: return a list of ndarray data types to which a provided ndarray data type can be safely cast. +- [`sameKindCasts( [dtype] )`][@stdlib/ndarray/same-kind-casts]: return a list of ndarray data types to which a provided ndarray data type can be safely cast or cast within the same "kind". +- [`shape( x )`][@stdlib/ndarray/shape]: return the shape of a provided ndarray. +- [`sliceAssign( x, y, ...s[, options] )`][@stdlib/ndarray/slice-assign]: assign element values from a broadcasted input `ndarray` to corresponding elements in an output `ndarray` view. +- [`sliceDimensionFrom( x, dim, start[, options] )`][@stdlib/ndarray/slice-dimension-from]: return a read-only shifted view of an input `ndarray` along a specified dimension. +- [`sliceDimensionTo( x, dim, stop[, options] )`][@stdlib/ndarray/slice-dimension-to]: return a read-only truncated view of an input `ndarray` along a specified dimension. +- [`sliceDimension( x, dim, slice[, options] )`][@stdlib/ndarray/slice-dimension]: return a read-only view of an input `ndarray` when sliced along a specified dimension. +- [`sliceFrom( x, ...start[, options] )`][@stdlib/ndarray/slice-from]: return a read-only shifted view of an input ndarray. +- [`sliceTo( x, ...stop[, options] )`][@stdlib/ndarray/slice-to]: return a read-only truncated view of an input ndarray. +- [`slice( x, ...s[, options] )`][@stdlib/ndarray/slice]: return a read-only view of an input `ndarray`. +- [`stride( x, dim )`][@stdlib/ndarray/stride]: return the stride along a specified dimension for a provided ndarray. +- [`strides( x )`][@stdlib/ndarray/strides]: return the strides of a provided ndarray. - [`sub2ind( shape, ...subscripts[, options] )`][@stdlib/ndarray/sub2ind]: convert subscripts to a linear index. - [`ndarray2array( x )`][@stdlib/ndarray/to-array]: convert an ndarray to a generic array. -- [`ndzerosLike( x[, options] )`][@stdlib/ndarray/zeros-like]: create a zero-filled ndarray having the same shape and data type as a provided ndarray. -- [`ndzeros( shape[, options] )`][@stdlib/ndarray/zeros]: create a zero-filled ndarray having a specified shape and data type. +- [`zerosLike( x[, options] )`][@stdlib/ndarray/zeros-like]: create a zero-filled ndarray having the same shape and data type as a provided ndarray. +- [`zeros( shape[, options] )`][@stdlib/ndarray/zeros]: create a zero-filled ndarray having a specified shape and data type.
diff --git a/lib/node_modules/@stdlib/slice/base/README.md b/lib/node_modules/@stdlib/slice/base/README.md index 270bd9c2dd0f..64afcd721a4d 100644 --- a/lib/node_modules/@stdlib/slice/base/README.md +++ b/lib/node_modules/@stdlib/slice/base/README.md @@ -46,6 +46,7 @@ The namespace contains the following:
- [`args2multislice( args )`][@stdlib/slice/base/args2multislice]: create a `MultiSlice` object from a list of `MultiSlice` constructor arguments. +- [`int2slice( value, max, strict )`][@stdlib/slice/base/int2slice]: convert an integer to a `Slice` object. - [`sliceLength( slice )`][@stdlib/slice/base/length]: compute the number of elements in a normalized slice. - [`nonreducedDimensions( slice )`][@stdlib/slice/base/nonreduced-dimensions]: return a list of non-reduced dimensions in an un-normalized `MultiSlice` object. - [`normalizeMultiSlice( slice, shape, strict )`][@stdlib/slice/base/normalize-multi-slice]: normalize a `MultiSlice` object. @@ -102,6 +103,8 @@ console.log( objectKeys( ns ) ); [@stdlib/slice/base/args2multislice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/args2multislice +[@stdlib/slice/base/int2slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/int2slice + [@stdlib/slice/base/length]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/length [@stdlib/slice/base/nonreduced-dimensions]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/nonreduced-dimensions diff --git a/lib/node_modules/@stdlib/strided/base/README.md b/lib/node_modules/@stdlib/strided/base/README.md index 4d31b38a0f17..6a514ba6ec0d 100644 --- a/lib/node_modules/@stdlib/strided/base/README.md +++ b/lib/node_modules/@stdlib/strided/base/README.md @@ -72,6 +72,7 @@ The following functions are currently exported: - [`offsetView( x, offset )`][@stdlib/strided/base/offset-view]: return a typed array view having the same data type as a provided input typed array and starting at a specified index offset. - [`quaternary( arrays, shape, strides, fcn )`][@stdlib/strided/base/quaternary]: apply a quaternary callback to strided input array elements and assign results to elements in a strided output array. - [`quinary( arrays, shape, strides, fcn )`][@stdlib/strided/base/quinary]: apply a quinary callback to strided input array elements and assign results to elements in a strided output array. +- [`reinterpretComplex( x, offset )`][@stdlib/strided/base/reinterpret-complex]: reinterpret a complex-valued floating-point array as a real-valued floating-point array having the same precision. - [`reinterpretComplex128( x, offset )`][@stdlib/strided/base/reinterpret-complex128]: reinterpret a `Complex128Array` as a `Float64Array`. - [`reinterpretComplex64( x, offset )`][@stdlib/strided/base/reinterpret-complex64]: reinterpret a `Complex64Array` as a `Float32Array`. - [`smap( N, x, strideX, y, strideY, fcn )`][@stdlib/strided/base/smap]: apply a unary function to a single-precision floating-point strided input array and assign results to a single-precision floating-point strided output array. @@ -181,6 +182,8 @@ console.log( objectKeys( ns ) ); [@stdlib/strided/base/quinary]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/quinary +[@stdlib/strided/base/reinterpret-complex]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/reinterpret-complex + [@stdlib/strided/base/reinterpret-complex128]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/reinterpret-complex128 [@stdlib/strided/base/reinterpret-complex64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/reinterpret-complex64 diff --git a/lib/node_modules/@stdlib/string/README.md b/lib/node_modules/@stdlib/string/README.md index e3071107fd26..37ade7527e66 100644 --- a/lib/node_modules/@stdlib/string/README.md +++ b/lib/node_modules/@stdlib/string/README.md @@ -79,7 +79,7 @@ The namespace exposes the following string manipulation functions: - [`repeat( str, n )`][@stdlib/string/repeat]: repeat a string a specified number of times and return the concatenated result. - [`replaceBefore( str, search, replacement )`][@stdlib/string/replace-before]: replace the substring before the first occurrence of a specified search string. - [`replace( str, search, newval )`][@stdlib/string/replace]: replace search occurrences with a replacement string. -- [`reverseString( str[, options] )`][@stdlib/string/reverse]: reverse a string. +- [`reverse( str[, options] )`][@stdlib/string/reverse]: reverse a string. - [`rpad( str, len[, pad] )`][@stdlib/string/right-pad]: right pad a string. - [`rtrimN( str, n[, chars] )`][@stdlib/string/right-trim-n]: trim `n` characters from the end of a string. - [`rtrim( str )`][@stdlib/string/right-trim]: trim whitespace characters from the end of a string.