diff --git a/lib/node_modules/@stdlib/ndarray/README.md b/lib/node_modules/@stdlib/ndarray/README.md index 837c07d3bb9e..09226745040e 100644 --- a/lib/node_modules/@stdlib/ndarray/README.md +++ b/lib/node_modules/@stdlib/ndarray/README.md @@ -71,10 +71,14 @@ In addition, the namespace contains the following multidimensional array utility
+- [`anyBy( x[, options], predicate[, thisArg] )`][@stdlib/ndarray/any-by]: test whether at least one element along one or more `ndarray` dimensions passes a test implemented by a predicate function. +- [`any( x[, options] )`][@stdlib/ndarray/any]: test whether at least one element along one or more `ndarray` dimensions is truthy. - [`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. - [`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. +- [`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. - [`countTruthy( x[, options] )`][@stdlib/ndarray/count-truthy]: count the number of truthy elements along one or more `ndarray` dimensions. @@ -93,9 +97,11 @@ In addition, the namespace contains the following multidimensional array utility - [`fill( x, value )`][@stdlib/ndarray/fill]: fill an input `ndarray` with a specified value. - [`filterMap( x[, options], fcn[, thisArg] )`][@stdlib/ndarray/filter-map]: filter and map elements in an input ndarray to elements in a new output ndarray according to a callback function. - [`filter( x[, options], predicate[, thisArg] )`][@stdlib/ndarray/filter]: return a shallow copy of an ndarray containing only those elements which pass a test implemented by a predicate function. +- [`find( x[, options], predicate[, thisArg] )`][@stdlib/ndarray/find]: return a new ndarray containing the first elements which pass a test implemented by a predicate function along one or more ndarray dimensions. - [`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. - [`flattenBy( x[, options], fcn[, thisArg] )`][@stdlib/ndarray/flatten-by]: flatten an ndarray according to a callback function. +- [`flattenFrom( x, dim[, options] )`][@stdlib/ndarray/flatten-from]: return a copy of an input ndarray where all dimensions of the input ndarray are flattened starting from a specified dimension. - [`flatten( x[, options] )`][@stdlib/ndarray/flatten]: return a flattened copy of an input ndarray. - [`forEach( x, fcn[, thisArg] )`][@stdlib/ndarray/for-each]: invoke a callback function once for each ndarray element. - [`scalar2ndarray( value[, options] )`][@stdlib/ndarray/from-scalar]: convert a scalar value to a zero-dimensional ndarray. @@ -118,11 +124,15 @@ In addition, the namespace contains the following multidimensional array utility - [`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. +- [`pop( x[, options] )`][@stdlib/ndarray/pop]: return an array containing a read-only truncated view of an input `ndarray` and a read-only view of the last element(s) along a specified dimension. - [`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. - [`reject( x[, options], predicate[, thisArg] )`][@stdlib/ndarray/reject]: return a shallow copy of an ndarray containing only those elements which fail a test implemented by a predicate function. +- [`reverseDimension( x, dim )`][@stdlib/ndarray/reverse-dimension]: return a **read-only** view of an input `ndarray` in which the order of elements along a specified dimension is reversed. +- [`reverse( x )`][@stdlib/ndarray/reverse]: return a **read-only** view of an input `ndarray` in which the order of elements along each dimension is reversed. - [`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. +- [`shift( x[, options] )`][@stdlib/ndarray/shift]: return an array containing a read-only truncated view of an input `ndarray` and a read-only view of the first element(s) along a specified dimension. - [`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. @@ -137,6 +147,7 @@ In addition, the namespace contains the following multidimensional array utility - [`ndarray2array( x )`][@stdlib/ndarray/to-array]: convert an ndarray to a generic array. - [`ndarray2fancy( x[, options] )`][@stdlib/ndarray/to-fancy]: convert an ndarray to an object supporting fancy indexing. - [`ndarray2json( x )`][@stdlib/ndarray/to-json]: serialize an ndarray as a JSON object. +- [`toReversed( x )`][@stdlib/ndarray/to-reversed]: return a new `ndarray` where the order of elements of an input `ndarray` is reversed along each dimension. - [`vector`][@stdlib/ndarray/vector]: vector constructors and associated utilities. - [`with( x, indices, value )`][@stdlib/ndarray/with]: return a new ndarray with the element at a specified index replaced by a provided value. - [`zerosLike( x[, options] )`][@stdlib/ndarray/zeros-like]: create a zero-filled ndarray having the same shape and data type as a provided ndarray. @@ -183,6 +194,10 @@ console.log( objectKeys( ns ) ); +[@stdlib/ndarray/any-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/any-by + +[@stdlib/ndarray/any]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/any + [@stdlib/ndarray/at]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/at [@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/broadcast-array @@ -191,6 +206,10 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/casting-modes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/casting-modes +[@stdlib/ndarray/concat]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/concat + +[@stdlib/ndarray/copy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/copy + [@stdlib/ndarray/count-falsy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/count-falsy [@stdlib/ndarray/count-if]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/count-if @@ -227,12 +246,16 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/filter]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/filter +[@stdlib/ndarray/find]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/find + [@stdlib/ndarray/flag]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/flag [@stdlib/ndarray/flags]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/flags [@stdlib/ndarray/flatten-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/flatten-by +[@stdlib/ndarray/flatten-from]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/flatten-from + [@stdlib/ndarray/flatten]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/flatten [@stdlib/ndarray/for-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/for-each @@ -277,16 +300,24 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/output-dtype-policies]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/output-dtype-policies +[@stdlib/ndarray/pop]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/pop + [@stdlib/ndarray/promotion-rules]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/promotion-rules [@stdlib/ndarray/reject]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/reject +[@stdlib/ndarray/reverse-dimension]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/reverse-dimension + +[@stdlib/ndarray/reverse]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/reverse + [@stdlib/ndarray/safe-casts]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/safe-casts [@stdlib/ndarray/same-kind-casts]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/same-kind-casts [@stdlib/ndarray/shape]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/shape +[@stdlib/ndarray/shift]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/shift + [@stdlib/ndarray/slice-assign]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/slice-assign [@stdlib/ndarray/slice-dimension-from]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/slice-dimension-from @@ -315,6 +346,8 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/to-json]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-json +[@stdlib/ndarray/to-reversed]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-reversed + [@stdlib/ndarray/vector]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector [@stdlib/ndarray/with]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/with