diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/README.md b/lib/node_modules/@stdlib/blas/base/ndarray/README.md index 593cc4e8b00a..e17829d00b95 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/README.md +++ b/lib/node_modules/@stdlib/blas/base/ndarray/README.md @@ -48,12 +48,15 @@ The namespace exposes the following APIs: - [`caxpy( arrays )`][@stdlib/blas/base/ndarray/caxpy]: multiply a one-dimensional single-precision complex floating-point ndarray `x` by a constant `alpha` and add the result to a one-dimensional single-precision complex floating-point ndarray `y`. - [`dasum( arrays )`][@stdlib/blas/base/ndarray/dasum]: calculate the sum of absolute values for all elements in a one-dimensional double-precision floating-point ndarray. - [`daxpy( arrays )`][@stdlib/blas/base/ndarray/daxpy]: multiply a one-dimensional double-precision floating-point ndarray `x` by a constant `alpha` and add the result to a one-dimensional double-precision floating-point ndarray `y`. +- [`dcopy( arrays )`][@stdlib/blas/base/ndarray/dcopy]: copy values from a one-dimensional double-precision floating-point ndarray `x` into a one-dimensional double-precision floating-point ndarray `y`. - [`ddot( arrays )`][@stdlib/blas/base/ndarray/ddot]: calculate the dot product of two one-dimensional double-precision floating-point ndarrays. - [`gasum( arrays )`][@stdlib/blas/base/ndarray/gasum]: calculate the sum of absolute values for all elements in a one-dimensional ndarray. - [`gaxpy( arrays )`][@stdlib/blas/base/ndarray/gaxpy]: multiply a one-dimensional ndarray `x` by a constant `alpha` and add the result to a one-dimensional ndarray `y`. +- [`gcopy( arrays )`][@stdlib/blas/base/ndarray/gcopy]: copy values from a one-dimensional ndarray `x` into a one-dimensional ndarray `y`. - [`gdot( arrays )`][@stdlib/blas/base/ndarray/gdot]: calculate the dot product of two one-dimensional ndarrays. - [`sasum( arrays )`][@stdlib/blas/base/ndarray/sasum]: calculate the sum of absolute values for all elements in a one-dimensional single-precision floating-point ndarray. - [`saxpy( arrays )`][@stdlib/blas/base/ndarray/saxpy]: multiply a one-dimensional single-precision floating-point ndarray `x` by a constant `alpha` and add the result to a one-dimensional single-precision floating-point ndarray `y`. +- [`scopy( arrays )`][@stdlib/blas/base/ndarray/scopy]: copy values from a one-dimensional single-precision floating-point ndarray `x` into a one-dimensional single-precision floating-point ndarray `y`. - [`sdot( arrays )`][@stdlib/blas/base/ndarray/sdot]: calculate the dot product of two one-dimensional single-precision floating-point ndarrays. - [`zaxpy( arrays )`][@stdlib/blas/base/ndarray/zaxpy]: multiply a one-dimensional double-precision complex floating-point ndarray `x` by a constant `alpha` and add the result to a one-dimensional double-precision complex floating-point ndarray `y`. @@ -104,18 +107,24 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/base/ndarray/daxpy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/daxpy +[@stdlib/blas/base/ndarray/dcopy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/dcopy + [@stdlib/blas/base/ndarray/ddot]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/ddot [@stdlib/blas/base/ndarray/gasum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/gasum [@stdlib/blas/base/ndarray/gaxpy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/gaxpy +[@stdlib/blas/base/ndarray/gcopy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/gcopy + [@stdlib/blas/base/ndarray/gdot]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/gdot [@stdlib/blas/base/ndarray/sasum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/sasum [@stdlib/blas/base/ndarray/saxpy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/saxpy +[@stdlib/blas/base/ndarray/scopy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/scopy + [@stdlib/blas/base/ndarray/sdot]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/sdot [@stdlib/blas/base/ndarray/zaxpy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/zaxpy diff --git a/lib/node_modules/@stdlib/blas/ext/base/README.md b/lib/node_modules/@stdlib/blas/ext/base/README.md index 0f35b4341311..ceb39187a5e8 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/README.md @@ -158,6 +158,7 @@ var o = ns; - [`gsumkbn2( N, x, strideX )`][@stdlib/blas/ext/base/gsumkbn2]: calculate the sum of strided array elements using a second-order iterative Kahan–Babuška algorithm. - [`gsumors( N, x, strideX )`][@stdlib/blas/ext/base/gsumors]: calculate the sum of strided array elements using ordinary recursive summation. - [`gsumpw( N, x, strideX )`][@stdlib/blas/ext/base/gsumpw]: calculate the sum of strided array elements using pairwise summation. +- [`gunitspace( N, start, x, strideX )`][@stdlib/blas/ext/base/gunitspace]: fill a strided array with linearly spaced numeric elements which increment by `1` starting from a specified value. - [`gvander( order, mode, M, N, x, strideX, out, ldo )`][@stdlib/blas/ext/base/gvander]: generate a Vandermonde matrix. - [`gwhere( N, condition, strideC, x, strideX, y, strideY, out, strideOut )`][@stdlib/blas/ext/base/gwhere]: take elements from one of two strided arrays depending on a condition. - [`gzeroTo( N, x, strideX )`][@stdlib/blas/ext/base/gzero-to]: fill a strided array with linearly spaced numeric elements which increment by `1` starting from zero. @@ -211,6 +212,7 @@ var o = ns; - [`wasm`][@stdlib/blas/ext/base/wasm]: extensions to basic linear algebra subprograms (BLAS) compiled to WebAssembly. - [`zfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/zfill]: fill a double-precision complex floating-point strided array with a specified scalar constant. - [`zindexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/zindex-of-row]: return the index of the first row in a double-precision complex floating-point input matrix which has the same elements as a provided search vector. +- [`znancount( N, x, strideX )`][@stdlib/blas/ext/base/znancount]: calculate the number of non-`NaN` elements in a double-precision complex floating-point strided array. - [`zoneTo( N, x, strideX )`][@stdlib/blas/ext/base/zone-to]: fill a double-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from one. - [`zsum( N, x, strideX )`][@stdlib/blas/ext/base/zsum]: calculate the sum of double-precision complex floating-point strided array elements. - [`zsumkbn( N, x, strideX )`][@stdlib/blas/ext/base/zsumkbn]: calculate the sum of double-precision complex floating-point strided array elements using an improved Kahan–Babuška algorithm. @@ -495,6 +497,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/gsumpw]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gsumpw +[@stdlib/blas/ext/base/gunitspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gunitspace + [@stdlib/blas/ext/base/gvander]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gvander [@stdlib/blas/ext/base/gwhere]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gwhere @@ -601,6 +605,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/zindex-of-row]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zindex-of-row +[@stdlib/blas/ext/base/znancount]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/znancount + [@stdlib/blas/ext/base/zone-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zone-to [@stdlib/blas/ext/base/zsum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zsum diff --git a/lib/node_modules/@stdlib/math/base/tools/README.md b/lib/node_modules/@stdlib/math/base/tools/README.md index 064389dccaf4..9489669a923d 100644 --- a/lib/node_modules/@stdlib/math/base/tools/README.md +++ b/lib/node_modules/@stdlib/math/base/tools/README.md @@ -44,6 +44,7 @@ var o = tools;
- [`chebyshevSeries( x, c )`][@stdlib/math/base/tools/chebyshev-series]: evaluate a Chebyshev series using double-precision floating-point arithmetic. +- [`chebyshevSeriesf( x, c )`][@stdlib/math/base/tools/chebyshev-seriesf]: evaluate a Chebyshev series using single-precision floating-point arithmetic. - [`continuedFraction( generator[, options ] )`][@stdlib/math/base/tools/continued-fraction]: continued fraction approximation. - [`evalpoly( c, x )`][@stdlib/math/base/tools/evalpoly]: evaluate a polynomial using double-precision floating-point arithmetic. - [`evalpolyf( c, x )`][@stdlib/math/base/tools/evalpolyf]: evaluate a polynomial using single-precision floating-point arithmetic. @@ -99,6 +100,8 @@ console.log( objectKeys( tools ) ); [@stdlib/math/base/tools/chebyshev-series]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/tools/chebyshev-series +[@stdlib/math/base/tools/chebyshev-seriesf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/tools/chebyshev-seriesf + [@stdlib/math/base/tools/continued-fraction]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/tools/continued-fraction [@stdlib/math/base/tools/evalpoly]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/tools/evalpoly diff --git a/lib/node_modules/@stdlib/ndarray/README.md b/lib/node_modules/@stdlib/ndarray/README.md index e6909725a7b3..e7c0d1775275 100644 --- a/lib/node_modules/@stdlib/ndarray/README.md +++ b/lib/node_modules/@stdlib/ndarray/README.md @@ -46,7 +46,17 @@ The namespace exports the following functions to create multidimensional arrays:
- [`array( [buffer,] [options] )`][@stdlib/ndarray/array]: create a multidimensional array. +- [`copy( x[, options] )`][@stdlib/ndarray/copy]: copy an input ndarray to a new ndarray having the same shape and data type. - [`ndarray( dtype, buffer, shape, strides, offset, order[, options] )`][@stdlib/ndarray/ctor]: multidimensional array constructor. +- [`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. +- [`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. +- [`ndarraylike2ndarray( x[, options] )`][@stdlib/ndarray/ndarraylike2ndarray]: convert an ndarray-like object to an `ndarray`. +- [`ones( shape[, options] )`][@stdlib/ndarray/ones]: create a ones-filled ndarray having a specified shape and data type. +- [`ndarray2fancy( x[, options] )`][@stdlib/ndarray/to-fancy]: convert an ndarray to an object supporting fancy indexing. +- [`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.
@@ -58,6 +68,50 @@ The namespace exports the following functions to manipulate multidimensional arr
+- [`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. +- [`colcat( arrays )`][@stdlib/ndarray/colcat]: concatenate a list of one-dimensional or two-dimensional ndarrays as columns. +- [`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. +- [`fillBy( x, fcn[, thisArg] )`][@stdlib/ndarray/fill-by]: fill an input ndarray according to a callback function. +- [`fillSlice( x, value, ...s[, options] )`][@stdlib/ndarray/fill-slice]: fill an input `ndarray` view with a specified value. +- [`fill( x, value )`][@stdlib/ndarray/fill]: fill an input `ndarray` with a specified value. +- [`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. +- [`hconcat( arrays )`][@stdlib/ndarray/hconcat]: concatenate a list of ndarrays along the last dimension. +- [`map( x[, options], fcn[, thisArg] )`][@stdlib/ndarray/map]: apply a callback function to elements in an input ndarray and assign results to elements in a new output ndarray. +- [`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. +- [`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. +- [`push( x, ...values )`][@stdlib/ndarray/push]: return a one-dimensional ndarray formed by appending provided scalar values to a one-dimensional input ndarray. +- [`removeSingletonDimensions( x )`][@stdlib/ndarray/remove-singleton-dimensions]: return a read-only view of an input ndarray with singleton dimensions removed. +- [`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. +- [`rotr90( x, k )`][@stdlib/ndarray/rotr90]: return a **read-only** view of a matrix (or a stack of matrices) rotated `90` degrees clockwise. +- [`rowcat( arrays )`][@stdlib/ndarray/rowcat]: concatenate a list of one-dimensional or two-dimensional ndarrays as rows. +- [`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. +- [`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`. +- [`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. +- [`toFlippedlr( x )`][@stdlib/ndarray/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/to-flippedud]: return a new `ndarray` where the order of elements along the second-to-last dimension of an input `ndarray` is reversed. +- [`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. +- [`vconcat( arrays )`][@stdlib/ndarray/vconcat]: concatenate a list of ndarrays along the second-to-last dimension. +- [`ndarrayWith( x, indices, value )`][@stdlib/ndarray/with]: return a new ndarray with the element at a specified index replaced by a provided value. +
@@ -68,6 +122,22 @@ The namespace exports the following functions to search multidimensional arrays:
+- [`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. +- [`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. +- [`everyBy( x[, options], predicate[, thisArg] )`][@stdlib/ndarray/every-by]: test whether all elements along one or more `ndarray` dimensions pass a test implemented by a predicate function. +- [`every( x[, options] )`][@stdlib/ndarray/every]: test whether every element along one or more `ndarray` dimensions is truthy. +- [`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. +- [`includes( x, searchElement[, options] )`][@stdlib/ndarray/includes]: test whether an `ndarray` contains a specified value along one or more dimensions. +- [`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. +- [`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. +
@@ -78,6 +148,19 @@ The namespace exports the following functions to inspect multidimensional arrays
+- [`dataBuffer( x )`][@stdlib/ndarray/data-buffer]: return the underlying data buffer of a provided ndarray. +- [`dtype( x )`][@stdlib/ndarray/dtype]: return the data type 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. +- [`ndims( x )`][@stdlib/ndarray/ndims]: return the number of ndarray dimensions. +- [`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. +- [`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. +- [`shape( x )`][@stdlib/ndarray/shape]: return the shape of a provided 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. +
@@ -88,6 +171,11 @@ The namespace exports the following functions to index multidimensional arrays:
+- [`at( x[, ...indices] )`][@stdlib/ndarray/at]: return an `ndarray` element. +- [`ind2sub( shape, idx[, options] )`][@stdlib/ndarray/ind2sub]: convert a linear index to an array of subscripts. +- [`ndindex( x[, options] )`][@stdlib/ndarray/index]: ndarray index constructor. +- [`sub2ind( shape, ...subscripts[, options] )`][@stdlib/ndarray/sub2ind]: convert subscripts to a linear index. +
@@ -100,6 +188,7 @@ The namespace contains the following sub-namespaces: - [`base`][@stdlib/ndarray/base]: base ndarray. - [`iter`][@stdlib/ndarray/iter]: multidimensional array iterators. +- [`vector`][@stdlib/ndarray/vector]: vector constructors and associated utilities.
@@ -111,109 +200,27 @@ 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. -- [`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. -- [`colcat( arrays )`][@stdlib/ndarray/colcat]: concatenate a list of one-dimensional or two-dimensional ndarrays as columns. -- [`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. -- [`countTruthy( x[, options] )`][@stdlib/ndarray/count-truthy]: count the number of truthy elements along one or more `ndarray` dimensions. -- [`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. - [`DataType( value[, options] )`][@stdlib/ndarray/dtype-ctor]: data type constructor. -- [`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. -- [`everyBy( x[, options], predicate[, thisArg] )`][@stdlib/ndarray/every-by]: test whether all elements along one or more `ndarray` dimensions pass a test implemented by a predicate function. -- [`every( x[, options] )`][@stdlib/ndarray/every]: test whether every element along one or more `ndarray` dimensions is truthy. - [`FancyArray( dtype, buffer, shape, strides, offset, order[, options] )`][@stdlib/ndarray/fancy]: fancy multidimensional array constructor. -- [`fillBy( x, fcn[, thisArg] )`][@stdlib/ndarray/fill-by]: fill an input ndarray according to a callback function. -- [`fillSlice( x, value, ...s[, options] )`][@stdlib/ndarray/fill-slice]: fill an input `ndarray` view with a specified value. -- [`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. - [`indexModes()`][@stdlib/ndarray/index-modes]: list of ndarray index modes. -- [`ndindex( x[, options] )`][@stdlib/ndarray/index]: ndarray index constructor. - [`inputCastingPolicies()`][@stdlib/ndarray/input-casting-policies]: list of input ndarray casting policies. -- [`map( x[, options], fcn[, thisArg] )`][@stdlib/ndarray/map]: apply a callback function to elements in an input ndarray and assign results to elements in a new output ndarray. -- [`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. - [`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. -- [`ndarraylike2ndarray( x[, options] )`][@stdlib/ndarray/ndarraylike2ndarray]: convert an ndarray-like object to an `ndarray`. -- [`ndims( x )`][@stdlib/ndarray/ndims]: return the number of ndarray dimensions. - [`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. -- [`offset( x )`][@stdlib/ndarray/offset]: return the index offset specifying the underlying buffer index of the first iterated ndarray element. -- [`ones( shape[, options] )`][@stdlib/ndarray/ones]: create a ones-filled ndarray having a specified shape and data type. -- [`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. -- [`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. -- [`removeSingletonDimensions( x )`][@stdlib/ndarray/remove-singleton-dimensions]: return a read-only view of an input ndarray with singleton dimensions removed. -- [`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. -- [`rowcat( arrays )`][@stdlib/ndarray/rowcat]: concatenate a list of one-dimensional or two-dimensional ndarrays as rows. - [`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. -- [`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`. -- [`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. -- [`toFlippedlr( x )`][@stdlib/ndarray/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/to-flippedud]: return a new `ndarray` where the order of elements along the second-to-last dimension of an input `ndarray` is reversed. - [`ndarray2json( x )`][@stdlib/ndarray/to-json]: serialize an ndarray as a JSON object. - [`ndarray2localeString( x[, locales[, options]] )`][@stdlib/ndarray/to-locale-string]: serialize an ndarray as a locale-aware string. -- [`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. - [`ndarray2string( x )`][@stdlib/ndarray/to-string]: serialize an ndarray as a string. -- [`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. -- [`zeros( shape[, options] )`][@stdlib/ndarray/zeros]: create a zero-filled ndarray having a specified shape and data type.
@@ -256,155 +263,169 @@ 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/casting-modes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/casting-modes -[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/broadcast-array +[@stdlib/ndarray/defaults]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/defaults -[@stdlib/ndarray/broadcast-arrays]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/broadcast-arrays +[@stdlib/ndarray/dispatch]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dispatch -[@stdlib/ndarray/broadcast-scalar]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/broadcast-scalar +[@stdlib/ndarray/dtype-ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dtype-ctor -[@stdlib/ndarray/casting-modes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/casting-modes +[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dtypes -[@stdlib/ndarray/colcat]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/colcat +[@stdlib/ndarray/fancy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/fancy -[@stdlib/ndarray/concat]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/concat +[@stdlib/ndarray/for-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/for-each -[@stdlib/ndarray/concat1d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/concat1d +[@stdlib/ndarray/index-modes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/index-modes -[@stdlib/ndarray/copy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/copy +[@stdlib/ndarray/input-casting-policies]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/input-casting-policies -[@stdlib/ndarray/count-falsy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/count-falsy +[@stdlib/ndarray/min-dtype]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/min-dtype -[@stdlib/ndarray/count-if]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/count-if +[@stdlib/ndarray/mostly-safe-casts]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/mostly-safe-casts -[@stdlib/ndarray/count-truthy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/count-truthy +[@stdlib/ndarray/next-dtype]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/next-dtype -[@stdlib/ndarray/data-buffer]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/data-buffer +[@stdlib/ndarray/orders]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/orders -[@stdlib/ndarray/defaults]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/defaults +[@stdlib/ndarray/output-dtype-policies]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/output-dtype-policies -[@stdlib/ndarray/dispatch]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dispatch +[@stdlib/ndarray/promotion-rules]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/promotion-rules -[@stdlib/ndarray/dtype-ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dtype-ctor +[@stdlib/ndarray/safe-casts]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/safe-casts -[@stdlib/ndarray/dtype]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dtype +[@stdlib/ndarray/same-kind-casts]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/same-kind-casts -[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dtypes +[@stdlib/ndarray/to-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-array -[@stdlib/ndarray/empty-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/empty-like +[@stdlib/ndarray/to-json]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-json -[@stdlib/ndarray/empty]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/empty +[@stdlib/ndarray/to-locale-string]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-locale-string -[@stdlib/ndarray/every-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/every-by +[@stdlib/ndarray/to-string]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-string -[@stdlib/ndarray/every]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/every +[@stdlib/ndarray/base]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base -[@stdlib/ndarray/fancy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/fancy +[@stdlib/ndarray/iter]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter -[@stdlib/ndarray/fill-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/fill-by +[@stdlib/ndarray/vector]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector -[@stdlib/ndarray/fill-slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/fill-slice +[@stdlib/ndarray/at]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/at -[@stdlib/ndarray/fill]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/fill +[@stdlib/ndarray/ind2sub]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[@stdlib/ndarray/filter-map]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/filter-map +[@stdlib/ndarray/index]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/index -[@stdlib/ndarray/filter]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/filter +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/sub2ind -[@stdlib/ndarray/find-last]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/find-last +[@stdlib/ndarray/data-buffer]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/data-buffer -[@stdlib/ndarray/find]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/find +[@stdlib/ndarray/dtype]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dtype [@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/ndims]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ndims -[@stdlib/ndarray/flatten-from-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/flatten-from-by +[@stdlib/ndarray/numel-dimension]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/numel-dimension -[@stdlib/ndarray/flatten-from]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/flatten-from +[@stdlib/ndarray/numel]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/numel -[@stdlib/ndarray/flatten]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/flatten +[@stdlib/ndarray/offset]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/offset -[@stdlib/ndarray/fliplr]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/fliplr +[@stdlib/ndarray/order]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/order -[@stdlib/ndarray/flipud]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/flipud +[@stdlib/ndarray/shape]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/shape -[@stdlib/ndarray/for-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/for-each +[@stdlib/ndarray/stride]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/stride -[@stdlib/ndarray/from-scalar-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/from-scalar-like +[@stdlib/ndarray/strides]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/strides -[@stdlib/ndarray/from-scalar]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/from-scalar +[@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/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 + +[@stdlib/ndarray/count-truthy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/count-truthy + +[@stdlib/ndarray/every-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/every-by + +[@stdlib/ndarray/every]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/every + +[@stdlib/ndarray/filter-map]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/filter-map + +[@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/includes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/includes -[@stdlib/ndarray/ind2sub]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub +[@stdlib/ndarray/reject]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/reject -[@stdlib/ndarray/index-modes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/index-modes +[@stdlib/ndarray/some-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/some-by -[@stdlib/ndarray/index]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/index +[@stdlib/ndarray/some]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/some -[@stdlib/ndarray/input-casting-policies]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/input-casting-policies +[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/broadcast-array -[@stdlib/ndarray/map]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/map +[@stdlib/ndarray/broadcast-arrays]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/broadcast-arrays -[@stdlib/ndarray/maybe-broadcast-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array +[@stdlib/ndarray/broadcast-scalar]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/broadcast-scalar -[@stdlib/ndarray/maybe-broadcast-arrays]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-arrays +[@stdlib/ndarray/colcat]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/colcat -[@stdlib/ndarray/min-dtype]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/min-dtype +[@stdlib/ndarray/concat]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/concat -[@stdlib/ndarray/mostly-safe-casts]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/mostly-safe-casts +[@stdlib/ndarray/concat1d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/concat1d -[@stdlib/ndarray/ndarraylike2ndarray]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ndarraylike2ndarray +[@stdlib/ndarray/fill-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/fill-by -[@stdlib/ndarray/ndims]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ndims +[@stdlib/ndarray/fill-slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/fill-slice -[@stdlib/ndarray/next-dtype]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/next-dtype +[@stdlib/ndarray/fill]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/fill -[@stdlib/ndarray/numel-dimension]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/numel-dimension +[@stdlib/ndarray/flatten-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/flatten-by -[@stdlib/ndarray/numel]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/numel +[@stdlib/ndarray/flatten-from-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/flatten-from-by -[@stdlib/ndarray/offset]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/offset +[@stdlib/ndarray/flatten-from]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/flatten-from -[@stdlib/ndarray/ones]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ones +[@stdlib/ndarray/flatten]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/flatten -[@stdlib/ndarray/order]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/order +[@stdlib/ndarray/fliplr]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/fliplr -[@stdlib/ndarray/orders]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/orders +[@stdlib/ndarray/flipud]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/flipud -[@stdlib/ndarray/output-dtype-policies]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/output-dtype-policies +[@stdlib/ndarray/hconcat]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/hconcat + +[@stdlib/ndarray/map]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/map + +[@stdlib/ndarray/maybe-broadcast-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array + +[@stdlib/ndarray/maybe-broadcast-arrays]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-arrays [@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/remove-singleton-dimensions]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/remove-singleton-dimensions [@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/rowcat]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/rowcat - -[@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/rotr90]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/rotr90 -[@stdlib/ndarray/shape]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/shape +[@stdlib/ndarray/rowcat]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/rowcat [@stdlib/ndarray/shift]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/shift @@ -422,54 +443,46 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/slice -[@stdlib/ndarray/some-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/some-by +[@stdlib/ndarray/spread-dimensions]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/spread-dimensions -[@stdlib/ndarray/some]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/some +[@stdlib/ndarray/to-flippedlr]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-flippedlr -[@stdlib/ndarray/spread-dimensions]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/spread-dimensions +[@stdlib/ndarray/to-flippedud]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-flippedud -[@stdlib/ndarray/stride]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/stride +[@stdlib/ndarray/to-reversed-dimension]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-reversed-dimension -[@stdlib/ndarray/strides]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/strides +[@stdlib/ndarray/to-reversed]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-reversed -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/sub2ind +[@stdlib/ndarray/unshift]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/unshift -[@stdlib/ndarray/to-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-array +[@stdlib/ndarray/vconcat]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vconcat -[@stdlib/ndarray/to-fancy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-fancy +[@stdlib/ndarray/with]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/with -[@stdlib/ndarray/to-flippedlr]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-flippedlr +[@stdlib/ndarray/array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/array -[@stdlib/ndarray/to-flippedud]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-flippedud +[@stdlib/ndarray/copy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/copy -[@stdlib/ndarray/to-json]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-json +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor -[@stdlib/ndarray/to-locale-string]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-locale-string +[@stdlib/ndarray/empty-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/empty-like -[@stdlib/ndarray/to-reversed-dimension]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-reversed-dimension +[@stdlib/ndarray/empty]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/empty -[@stdlib/ndarray/to-reversed]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-reversed +[@stdlib/ndarray/from-scalar-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/from-scalar-like -[@stdlib/ndarray/to-string]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-string +[@stdlib/ndarray/from-scalar]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/from-scalar -[@stdlib/ndarray/unshift]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/unshift +[@stdlib/ndarray/ndarraylike2ndarray]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ndarraylike2ndarray -[@stdlib/ndarray/vector]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector +[@stdlib/ndarray/ones]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ones -[@stdlib/ndarray/with]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/with +[@stdlib/ndarray/to-fancy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-fancy [@stdlib/ndarray/zeros-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/zeros-like [@stdlib/ndarray/zeros]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/zeros -[@stdlib/ndarray/base]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base - -[@stdlib/ndarray/iter]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter - -[@stdlib/ndarray/array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/array - -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor - diff --git a/lib/node_modules/@stdlib/ndarray/base/README.md b/lib/node_modules/@stdlib/ndarray/base/README.md index 20195567664c..e56502865f71 100644 --- a/lib/node_modules/@stdlib/ndarray/base/README.md +++ b/lib/node_modules/@stdlib/ndarray/base/README.md @@ -169,6 +169,7 @@ var o = ns; - [`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. +- [`rotl90( x, k, writable )`][@stdlib/ndarray/base/rotl90]: rotate a matrix (or a stack of matrices) 90 degrees counterclockwise. - [`rotr90( x, k, writable )`][@stdlib/ndarray/base/rotr90]: rotate a matrix (or a stack of matrices) 90 degrees clockwise. - [`serializeMetaData( x )`][@stdlib/ndarray/base/serialize-meta-data]: serialize ndarray meta data. - [`shape( x, copy )`][@stdlib/ndarray/base/shape]: return the shape of a provided ndarray. @@ -542,6 +543,8 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/base/reverse]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/reverse +[@stdlib/ndarray/base/rotl90]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/rotl90 + [@stdlib/ndarray/base/rotr90]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/rotr90 [@stdlib/ndarray/base/serialize-meta-data]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/serialize-meta-data diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/README.md index 0c37fc555508..ae1a476ba0d5 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/README.md +++ b/lib/node_modules/@stdlib/stats/base/ndarray/README.md @@ -213,6 +213,11 @@ The namespace exposes the following APIs: - [`stdevwd( arrays )`][@stdlib/stats/base/ndarray/stdevwd]: calculate the standard deviation of a one-dimensional ndarray using Welford's algorithm. - [`stdevyc( arrays )`][@stdlib/stats/base/ndarray/stdevyc]: calculate the standard deviation of a one-dimensional ndarray using a one-pass algorithm proposed by Youngs and Cramer. - [`svariance( arrays )`][@stdlib/stats/base/ndarray/svariance]: calculate the variance of a one-dimensional single-precision floating-point ndarray. +- [`svariancech( arrays )`][@stdlib/stats/base/ndarray/svariancech]: calculate the variance of a one-dimensional single-precision floating-point ndarray using a one-pass trial mean algorithm. +- [`svariancepn( arrays )`][@stdlib/stats/base/ndarray/svariancepn]: calculate the variance of a one-dimensional single-precision floating-point ndarray using a two-pass algorithm. +- [`svariancetk( arrays )`][@stdlib/stats/base/ndarray/svariancetk]: calculate the variance of a one-dimensional single-precision floating-point ndarray using a one-pass textbook algorithm. +- [`svariancewd( arrays )`][@stdlib/stats/base/ndarray/svariancewd]: calculate the variance of a one-dimensional single-precision floating-point ndarray using Welford's algorithm. +- [`svarianceyc( arrays )`][@stdlib/stats/base/ndarray/svarianceyc]: calculate the variance of a one-dimensional single-precision floating-point ndarray using a one-pass algorithm proposed by Youngs and Cramer. - [`sztest( arrays )`][@stdlib/stats/base/ndarray/sztest]: compute a one-sample Z-test for a one-dimensional single-precision floating-point ndarray. - [`sztest2( arrays )`][@stdlib/stats/base/ndarray/sztest2]: compute a two-sample Z-test for two one-dimensional single-precision floating-point ndarrays. - [`variance( arrays )`][@stdlib/stats/base/ndarray/variance]: calculate the variance of a one-dimensional ndarray. @@ -601,6 +606,16 @@ console.log( objectKeys( ns ) ); [@stdlib/stats/base/ndarray/svariance]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/svariance +[@stdlib/stats/base/ndarray/svariancech]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/svariancech + +[@stdlib/stats/base/ndarray/svariancepn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/svariancepn + +[@stdlib/stats/base/ndarray/svariancetk]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/svariancetk + +[@stdlib/stats/base/ndarray/svariancewd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/svariancewd + +[@stdlib/stats/base/ndarray/svarianceyc]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/svarianceyc + [@stdlib/stats/base/ndarray/sztest]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/sztest [@stdlib/stats/base/ndarray/sztest2]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/sztest2