diff --git a/lib/node_modules/@stdlib/ndarray/README.md b/lib/node_modules/@stdlib/ndarray/README.md index afb681eef393..a7f76dcd90b1 100644 --- a/lib/node_modules/@stdlib/ndarray/README.md +++ b/lib/node_modules/@stdlib/ndarray/README.md @@ -76,8 +76,10 @@ In addition, the namespace contains the following multidimensional array utility - [`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. +- [`broadcastScalar( value, shape[, options] )`][@stdlib/ndarray/broadcast-scalar]: broadcast a scalar value to an ndarray of a specified shape. - [`castingModes()`][@stdlib/ndarray/casting-modes]: list of ndarray casting modes. - [`concat( arrays[, options] )`][@stdlib/ndarray/concat]: concatenate a list of ndarrays along a specified ndarray dimension. +- [`concat1d( ...arrays )`][@stdlib/ndarray/concat1d]: return a one-dimensional ndarray formed by concatenating provided input arguments. - [`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. @@ -97,13 +99,18 @@ 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. +- [`findLast( x[, options], predicate[, thisArg] )`][@stdlib/ndarray/find-last]: return a new ndarray containing the last elements which pass a test implemented by a predicate function along one or more ndarray dimensions. - [`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. +- [`flattenFromBy( x, dim[, options], fcn[, thisArg] )`][@stdlib/ndarray/flatten-from-by]: flatten an ndarray according to a callback function starting from a specified dimension. - [`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. +- [`fliplr( x )`][@stdlib/ndarray/fliplr]: return a **read-only** view of an input `ndarray` in which the order of elements along the last dimension is reversed. +- [`flipud( x )`][@stdlib/ndarray/flipud]: return a **read-only** view of an input `ndarray` in which the order of elements along the second-to-last dimension is reversed. - [`forEach( x, fcn[, thisArg] )`][@stdlib/ndarray/for-each]: invoke a callback function once for each ndarray element. +- [`scalar2ndarrayLike( x, value[, options] )`][@stdlib/ndarray/from-scalar-like]: convert a scalar value to a zero-dimensional ndarray having the same data-type as a provided ndarray. - [`scalar2ndarray( value[, options] )`][@stdlib/ndarray/from-scalar]: convert a scalar value to a zero-dimensional ndarray. - [`includes( x, searchElement[, options] )`][@stdlib/ndarray/includes]: test whether an `ndarray` contains a specified value along one or more dimensions. - [`ind2sub( shape, idx[, options] )`][@stdlib/ndarray/ind2sub]: convert a linear index to an array of subscripts. @@ -125,7 +132,9 @@ In addition, the namespace contains the following multidimensional array utility - [`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. +- [`prependSingletonDimensions( x, n )`][@stdlib/ndarray/prepend-singleton-dimensions]: return a read-only view of an input ndarray with a specified number of prepended singleton dimensions. - [`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. +- [`push( x, ...values )`][@stdlib/ndarray/push]: return a one-dimensional ndarray formed by appending provided scalar values to a one-dimensional input ndarray. - [`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. @@ -141,13 +150,17 @@ In addition, the namespace contains the following multidimensional array utility - [`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`. - [`someBy( x, n[, options], predicate[, thisArg] )`][@stdlib/ndarray/some-by]: test whether at least `n` elements along one or more `ndarray` dimensions pass a test implemented by a predicate function. +- [`some( x, n[, options] )`][@stdlib/ndarray/some]: test whether at least `n` elements along one or more `ndarray` dimensions are truthy. +- [`spreadDimensions( ndims, x, dims )`][@stdlib/ndarray/spread-dimensions]: return a read-only view of an input ndarray where the dimensions of the input ndarray are expanded to a specified dimensionality by spreading dimensions to specified dimension indices and inserting dimensions of size one for the remaining dimensions. - [`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. - [`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. +- [`toReversedDimension( x[, options] )`][@stdlib/ndarray/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/to-reversed]: return a new `ndarray` where the order of elements of an input `ndarray` is reversed along each dimension. +- [`unshift( x, ...values )`][@stdlib/ndarray/unshift]: return a one-dimensional ndarray formed by prepending provided scalar values to a one-dimensional input ndarray. - [`vector`][@stdlib/ndarray/vector]: vector constructors and associated utilities. - [`ndarrayWith( 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. @@ -204,10 +217,14 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/broadcast-arrays]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/broadcast-arrays +[@stdlib/ndarray/broadcast-scalar]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/broadcast-scalar + [@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/concat1d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/concat1d + [@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 @@ -246,6 +263,8 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/filter]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/filter +[@stdlib/ndarray/find-last]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/find-last + [@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 @@ -254,12 +273,20 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/flatten-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/flatten-by +[@stdlib/ndarray/flatten-from-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/flatten-from-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/fliplr]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/fliplr + +[@stdlib/ndarray/flipud]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/flipud + [@stdlib/ndarray/for-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/for-each +[@stdlib/ndarray/from-scalar-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/from-scalar-like + [@stdlib/ndarray/from-scalar]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/from-scalar [@stdlib/ndarray/includes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/includes @@ -302,8 +329,12 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/pop]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/pop +[@stdlib/ndarray/prepend-singleton-dimensions]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/prepend-singleton-dimensions + [@stdlib/ndarray/promotion-rules]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/promotion-rules +[@stdlib/ndarray/push]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/push + [@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 @@ -334,6 +365,10 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/some-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/some-by +[@stdlib/ndarray/some]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/some + +[@stdlib/ndarray/spread-dimensions]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/spread-dimensions + [@stdlib/ndarray/stride]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/stride [@stdlib/ndarray/strides]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/strides @@ -346,8 +381,12 @@ 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-dimension]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-reversed-dimension + [@stdlib/ndarray/to-reversed]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-reversed +[@stdlib/ndarray/unshift]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/unshift + [@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 diff --git a/lib/node_modules/@stdlib/ndarray/base/README.md b/lib/node_modules/@stdlib/ndarray/base/README.md index 947f8db7dc35..96a253936c6d 100644 --- a/lib/node_modules/@stdlib/ndarray/base/README.md +++ b/lib/node_modules/@stdlib/ndarray/base/README.md @@ -46,6 +46,7 @@ var o = ns; - [`anyBy( arrays, predicate[, thisArg] )`][@stdlib/ndarray/base/any-by]: test whether at least one element in an ndarray passes a test implemented by a predicate function. - [`any( arrays )`][@stdlib/ndarray/base/any]: test whether at least one element in an ndarray is truthy. - [`assign( arrays )`][@stdlib/ndarray/base/assign]: assign elements in an input ndarray to elements in an output ndarray. +- [`atleastnd( ndims, arrays )`][@stdlib/ndarray/base/atleastnd]: convert a list of values (scalars and/or ndarrays) to ndarrays having at least a specified number of dimensions. - [`binaryInputCastingDataType( idtype1, idtype2, odtype, policy )`][@stdlib/ndarray/base/binary-input-casting-dtype]: resolve the casting data type for an input ndarray provided to a binary function. - [`binaryLoopOrder( shape, stridesX, stridesY, stridesZ )`][@stdlib/ndarray/base/binary-loop-interchange-order]: reorder ndarray dimensions and associated strides for loop interchange. - [`binaryOutputDataType( xdtype, ydtype, policy )`][@stdlib/ndarray/base/binary-output-dtype]: resolve the output ndarray data type for a binary function. @@ -153,7 +154,7 @@ var o = ns; - [`quaternaryBlockSize( dtypeX, dtypeY, dtypeZ, dtypeW, dtypeU )`][@stdlib/ndarray/base/quaternary-tiling-block-size]: resolve a loop block size for multi-dimensional array tiled loops. - [`quinaryLoopOrder( shape, stridesX, stridesY, stridesZ, stridesW, stridesU, stridesV )`][@stdlib/ndarray/base/quinary-loop-interchange-order]: reorder ndarray dimensions and associated strides for loop interchange. - [`quinaryBlockSize( dtypeX, dtypeY, dtypeZ, dtypeW, dtypeU, dtypeV )`][@stdlib/ndarray/base/quinary-tiling-block-size]: resolve a loop block size for multi-dimensional array tiled loops. -- [`removeSingletonDimensions( x )`][@stdlib/ndarray/base/remove-singleton-dimensions]: remove singleton dimensions. +- [`removeSingletonDimensions( x, writable )`][@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. - [`reverse( x, writable )`][@stdlib/ndarray/base/reverse]: return a view of an input ndarray in which the order of elements along each dimension is reversed. - [`serializeMetaData( x )`][@stdlib/ndarray/base/serialize-meta-data]: serialize ndarray meta data. @@ -187,6 +188,7 @@ var o = ns; - [`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. +- [`toTransposed( x )`][@stdlib/ndarray/base/to-transposed]: return a new ndarray containing the elements of an input ndarray but whose last two dimensions are transposed. - [`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). - [`unaryAccumulate( arrays, initial, clbk )`][@stdlib/ndarray/base/unary-accumulate]: perform a reduction over elements in an input ndarray. @@ -209,6 +211,7 @@ var o = ns; - [`unaryStrided1d( fcn, arrays, dims[, options] )`][@stdlib/ndarray/base/unary-strided1d]: apply a one-dimensional strided array function to a list of specified dimensions in an input ndarray and assign results to a provided output ndarray. - [`unaryBlockSize( dtypeX, dtypeY )`][@stdlib/ndarray/base/unary-tiling-block-size]: resolve a loop block size for multi-dimensional array tiled loops. - [`unary( arrays, fcn )`][@stdlib/ndarray/base/unary]: apply a unary callback to elements in an input ndarray and assign results to elements in an output ndarray. +- [`unflattenShape( shape, dim, sizes )`][@stdlib/ndarray/base/unflatten-shape]: expand a dimension over multiple dimensions. - [`vind2bind( shape, strides, offset, order, idx, mode )`][@stdlib/ndarray/base/vind2bind]: convert a linear index in an array view to a linear index in an underlying data buffer. - [`wrapIndex( idx, max )`][@stdlib/ndarray/base/wrap-index]: wrap an index on the interval `[0,max]`. - [`zerosLike( x )`][@stdlib/ndarray/base/zeros-like]: create a zero-filled ndarray having the same shape and data type as a provided ndarray. @@ -276,6 +279,8 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/base/assign]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/assign +[@stdlib/ndarray/base/atleastnd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/atleastnd + [@stdlib/ndarray/base/binary-input-casting-dtype]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/binary-input-casting-dtype [@stdlib/ndarray/base/binary-loop-interchange-order]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/binary-loop-interchange-order @@ -558,6 +563,8 @@ console.log( objectKeys( ns ) ); [@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-transposed]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/to-transposed + [@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 [@stdlib/ndarray/base/transpose]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/transpose @@ -602,6 +609,8 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/base/unary]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/unary +[@stdlib/ndarray/base/unflatten-shape]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/unflatten-shape + [@stdlib/ndarray/base/vind2bind]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/vind2bind [@stdlib/ndarray/base/wrap-index]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/wrap-index