diff --git a/lib/node_modules/@stdlib/array/base/assert/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/base/assert/docs/types/index.d.ts index 3bf8ec2445c0..8a8285f76340 100644 --- a/lib/node_modules/@stdlib/array/base/assert/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/array/base/assert/docs/types/index.d.ts @@ -42,6 +42,7 @@ import isRealFloatingPointDataType = require( '@stdlib/array/base/assert/is-real import isSafeDataTypeCast = require( '@stdlib/array/base/assert/is-safe-data-type-cast' ); import isSameKindDataTypeCast = require( '@stdlib/array/base/assert/is-same-kind-data-type-cast' ); import isSignedIntegerDataType = require( '@stdlib/array/base/assert/is-signed-integer-data-type' ); +import isSortedAscending = require( '@stdlib/array/base/assert/is-sorted-ascending' ); import isUnsignedIntegerDataType = require( '@stdlib/array/base/assert/is-unsigned-integer-data-type' ); /** @@ -689,6 +690,38 @@ interface Namespace { */ isSignedIntegerDataType: typeof isSignedIntegerDataType; + /** + * Tests if an array is sorted in ascending order. + * + * @param x - input array + * @returns boolean indicating if an array is sorted in ascending order + * + * @example + * var out = ns.isSortedAscending( [ 1, 2, 3 ] ); + * // returns true + * + * @example + * var out = ns.isSortedAscending( [ 3, 2, 1 ] ); + * // returns false + * + * @example + * var out = ns.isSortedAscending( [ 3, 3, 3 ] ); + * // returns true + * + * @example + * var out = ns.isSortedAscending( [ 3 ] ); + * // returns true + * + * @example + * var out = ns.isSortedAscending( [] ); + * // returns false + * + * @example + * var out = ns.isSortedAscending( [ 1, 3, 2 ] ); + * // returns false + */ + isSortedAscending: typeof isSortedAscending; + /** * Tests whether an input value is a supported array unsigned integer data type. * diff --git a/lib/node_modules/@stdlib/array/base/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/base/docs/types/index.d.ts index 5008dcd1a3cf..524e624f03b9 100644 --- a/lib/node_modules/@stdlib/array/base/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/array/base/docs/types/index.d.ts @@ -52,8 +52,15 @@ import bbinary3d = require( '@stdlib/array/base/broadcasted-binary3d' ); import bbinary4d = require( '@stdlib/array/base/broadcasted-binary4d' ); import bbinary5d = require( '@stdlib/array/base/broadcasted-binary5d' ); import bquaternary2d = require( '@stdlib/array/base/broadcasted-quaternary2d' ); +import bquaternary3d = require( '@stdlib/array/base/broadcasted-quaternary3d' ); +import bquaternary4d = require( '@stdlib/array/base/broadcasted-quaternary4d' ); +import bquaternary5d = require( '@stdlib/array/base/broadcasted-quaternary5d' ); import bquinary2d = require( '@stdlib/array/base/broadcasted-quinary2d' ); +import bquinary4d = require( '@stdlib/array/base/broadcasted-quinary4d' ); import bternary2d = require( '@stdlib/array/base/broadcasted-ternary2d' ); +import bternary3d = require( '@stdlib/array/base/broadcasted-ternary3d' ); +import bternary4d = require( '@stdlib/array/base/broadcasted-ternary4d' ); +import bternary5d = require( '@stdlib/array/base/broadcasted-ternary5d' ); import bunary2d = require( '@stdlib/array/base/broadcasted-unary2d' ); import bunary3d = require( '@stdlib/array/base/broadcasted-unary3d' ); import bunary4d = require( '@stdlib/array/base/broadcasted-unary4d' ); @@ -77,6 +84,7 @@ import everyBy = require( '@stdlib/array/base/every-by' ); import everyByRight = require( '@stdlib/array/base/every-by-right' ); import fancySlice = require( '@stdlib/array/base/fancy-slice' ); import fancySliceAssign = require( '@stdlib/array/base/fancy-slice-assign' ); +import fill = require( '@stdlib/array/base/fill' ); import filled = require( '@stdlib/array/base/filled' ); import filledBy = require( '@stdlib/array/base/filled-by' ); import filled2d = require( '@stdlib/array/base/filled2d' ); @@ -119,6 +127,7 @@ import groupValues = require( '@stdlib/array/base/group-values' ); import groupValuesBy = require( '@stdlib/array/base/group-values-by' ); import incrspace = require( '@stdlib/array/base/incrspace' ); import indexOf = require( '@stdlib/array/base/index-of' ); +import indicesComplement = require( '@stdlib/array/base/indices-complement' ); import join = require( '@stdlib/array/base/join' ); import last = require( '@stdlib/array/base/last' ); import lastIndexOf = require( '@stdlib/array/base/last-index-of' ); @@ -131,11 +140,19 @@ import map5d = require( '@stdlib/array/base/map5d' ); import minSignedIntegerDataType = require( '@stdlib/array/base/min-signed-integer-dtype' ); import minUnsignedIntegerDataType = require( '@stdlib/array/base/min-unsigned-integer-dtype' ); import mskbinary2d = require( '@stdlib/array/base/mskbinary2d' ); +import mskbinary3d = require( '@stdlib/array/base/mskbinary3d' ); +import mskbinary4d = require( '@stdlib/array/base/mskbinary4d' ); +import mskbinary5d = require( '@stdlib/array/base/mskbinary5d' ); import mskfilter = require( '@stdlib/array/base/mskfilter' ); +import mskfilterMap = require( '@stdlib/array/base/mskfilter-map' ); +import mskfilter2 = require( '@stdlib/array/base/mskfilter2' ); +import mskfiltern = require( '@stdlib/array/base/mskfiltern' ); import mskput = require( '@stdlib/array/base/mskput' ); import mskreject = require( '@stdlib/array/base/mskreject' ); import mskunary2d = require( '@stdlib/array/base/mskunary2d' ); import mskunary3d = require( '@stdlib/array/base/mskunary3d' ); +import mskunary4d = require( '@stdlib/array/base/mskunary4d' ); +import mskunary5d = require( '@stdlib/array/base/mskunary5d' ); import nCartesianProduct = require( '@stdlib/array/base/n-cartesian-product' ); import none = require( '@stdlib/array/base/none' ); import noneBy = require( '@stdlib/array/base/none-by' ); @@ -163,6 +180,8 @@ import removeAt = require( '@stdlib/array/base/remove-at' ); import resolveGetter = require( '@stdlib/array/base/resolve-getter' ); import resolveSetter = require( '@stdlib/array/base/resolve-setter' ); import reverse = require( '@stdlib/array/base/reverse' ); +import scatterFilled = require( '@stdlib/array/base/scatter-filled' ); +import scattered = require( '@stdlib/array/base/scattered' ); import setter = require( '@stdlib/array/base/setter' ); import slice = require( '@stdlib/array/base/slice' ); import strided2array2d = require( '@stdlib/array/base/strided2array2d' ); @@ -171,6 +190,7 @@ import strided2array4d = require( '@stdlib/array/base/strided2array4d' ); import strided2array5d = require( '@stdlib/array/base/strided2array5d' ); import take = require( '@stdlib/array/base/take' ); import takeIndexed = require( '@stdlib/array/base/take-indexed' ); +import takeIndexed2 = require( '@stdlib/array/base/take-indexed2' ); import take2d = require( '@stdlib/array/base/take2d' ); import take3d = require( '@stdlib/array/base/take3d' ); import ternary2d = require( '@stdlib/array/base/ternary2d' ); @@ -183,8 +203,11 @@ import toReversed = require( '@stdlib/array/base/to-reversed' ); import unary2d = require( '@stdlib/array/base/unary2d' ); import unary2dBy = require( '@stdlib/array/base/unary2d-by' ); import unary3d = require( '@stdlib/array/base/unary3d' ); +import unary3dBy = require( '@stdlib/array/base/unary3d-by' ); import unary4d = require( '@stdlib/array/base/unary4d' ); +import unary4dBy = require( '@stdlib/array/base/unary4d-by' ); import unary5d = require( '@stdlib/array/base/unary5d' ); +import unary5dBy = require( '@stdlib/array/base/unary5d-by' ); import unarynd = require( '@stdlib/array/base/unarynd' ); import unitspace = require( '@stdlib/array/base/unitspace' ); import where = require( '@stdlib/array/base/where' ); @@ -1042,6 +1065,117 @@ interface Namespace { */ bquaternary2d: typeof bquaternary2d; + /** + * Applies a quaternary callback to elements in four broadcasted input arrays and assigns results to elements in a three-dimensional nested output array. + * + * ## Notes + * + * - The input array shapes must be broadcast compatible with the output array shape. + * + * @param arrays - array containing four input nested arrays and one output nested array + * @param shapes - array shapes + * @param fcn - quaternary callback + * + * @example + * var add = require( '@stdlib/math/base/ops/add4' ); + * var ones3d = require( '@stdlib/array/base/ones3d' ); + * var zeros3d = require( '@stdlib/array/base/zeros3d' ); + * + * var shapes = [ + * [ 1, 1, 3 ], + * [ 3, 1, 1 ], + * [ 1, 3, 1 ], + * [ 3, 3, 3 ], + * [ 3, 3, 3 ] + * ]; + * + * var x = ones3d( shapes[ 0 ] ); + * var y = ones3d( shapes[ 1 ] ); + * var z = ones3d( shapes[ 2 ] ); + * var w = ones3d( shapes[ 3 ] ); + * var out = zeros3d( shapes[ 4 ] ); + * + * ns.bquaternary3d( [ x, y, z, w, out ], shapes, add ); + * + * console.log( out ); + * // => [ [ [ 4.0, 4.0, 4.0 ], [ 4.0, 4.0, 4.0 ], [ 4.0, 4.0, 4.0 ] ], [ [ 4.0, 4.0, 4.0 ], [ 4.0, 4.0, 4.0 ], [ 4.0, 4.0, 4.0 ] ], [ [ 4.0, 4.0, 4.0 ], [ 4.0, 4.0, 4.0 ], [ 4.0, 4.0, 4.0 ] ] ] + */ + bquaternary3d: typeof bquaternary3d; + + /** + * Applies a quaternary callback to elements in four broadcasted input arrays and assigns results to elements in a four-dimensional nested output array. + * + * ## Notes + * + * - The input array shapes must be broadcast compatible with the output array shape. + * + * @param arrays - array containing four input nested arrays and one output nested array + * @param shapes - array shapes + * @param fcn - quaternary callback + * + * @example + * var add = require( '@stdlib/math/base/ops/add4' ); + * var ones4d = require( '@stdlib/array/base/ones4d' ); + * var zeros4d = require( '@stdlib/array/base/zeros4d' ); + * + * var shapes = [ + * [ 1, 3, 1, 1 ], + * [ 1, 1, 3, 1 ], + * [ 1, 1, 1, 3 ], + * [ 1, 1, 1, 1 ], + * [ 1, 3, 3, 3 ] + * ]; + * + * var x = ones4d( shapes[ 0 ] ); + * var y = ones4d( shapes[ 1 ] ); + * var z = ones4d( shapes[ 2 ] ); + * var w = ones4d( shapes[ 3 ] ); + * var out = zeros4d( shapes[ 4 ] ); + * + * ns.bquaternary4d( [ x, y, z, w, out ], shapes, add ); + * + * console.log( out ); + * // => [ [ [ [ 4.0, 4.0, 4.0 ], [ 4.0, 4.0, 4.0 ], [ 4.0, 4.0, 4.0 ] ], [ [ 4.0, 4.0, 4.0 ], [ 4.0, 4.0, 4.0 ], [ 4.0, 4.0, 4.0 ] ], [ [ 4.0, 4.0, 4.0 ], [ 4.0, 4.0, 4.0 ], [ 4.0, 4.0, 4.0 ] ] ] ] + */ + bquaternary4d: typeof bquaternary4d; + + /** + * Applies a quaternary callback to elements in four broadcasted input arrays and assigns results to elements in a five-dimensional nested output array. + * + * ## Notes + * + * - The input array shapes must be broadcast compatible with the output array shape. + * + * @param arrays - array containing four input nested arrays and one output nested array + * @param shapes - array shapes + * @param fcn - quaternary callback + * + * @example + * var add = require( '@stdlib/math/base/ops/add4' ); + * var ones5d = require( '@stdlib/array/base/ones5d' ); + * var zeros5d = require( '@stdlib/array/base/zeros5d' ); + * + * var shapes = [ + * [ 1, 1, 3, 1, 1 ], + * [ 1, 1, 1, 3, 1 ], + * [ 1, 1, 1, 1, 3 ], + * [ 1, 1, 1, 1, 1 ], + * [ 1, 1, 3, 3, 3 ] + * ]; + * + * var x = ones5d( shapes[ 0 ] ); + * var y = ones5d( shapes[ 1 ] ); + * var z = ones5d( shapes[ 2 ] ); + * var w = ones5d( shapes[ 3 ] ); + * var out = zeros5d( shapes[ 4 ] ); + * + * ns.bquaternary5d( [ x, y, z, w, out ], shapes, add ); + * + * console.log( out ); + * // => [ [ [ [ [ 4.0, 4.0, 4.0 ], [ 4.0, 4.0, 4.0 ], [ 4.0, 4.0, 4.0 ] ], [ [ 4.0, 4.0, 4.0 ], [ 4.0, 4.0, 4.0 ], [ 4.0, 4.0, 4.0 ] ], [ [ 4.0, 4.0, 4.0 ], [ 4.0, 4.0, 4.0 ], [ 4.0, 4.0, 4.0 ] ] ] ] ] + */ + bquaternary5d: typeof bquaternary5d; + /** * Applies a quinary callback to elements in five broadcasted input arrays and assigns results to elements in a two-dimensional nested output array. * @@ -1084,6 +1218,48 @@ interface Namespace { */ bquinary2d: typeof bquinary2d; + /** + * Applies a quinary callback to elements in five broadcasted input arrays and assigns results to elements in a four-dimensional nested output array. + * + * ## Notes + * + * - The input array shapes must be broadcast compatible with the output array shape. + * + * @param arrays - array containing five input nested arrays and one output nested array + * @param shapes - array shapes + * @param fcn - quinary callback + * + * @example + * var ones4d = require( '@stdlib/array/base/ones4d' ); + * var zeros4d = require( '@stdlib/array/base/zeros4d' ); + * + * function add( x, y, z, w, v ) { + * return x + y + z + w + v; + * } + * + * var shapes = [ + * [ 1, 1, 1, 2 ], + * [ 1, 1, 2, 1 ], + * [ 1, 1, 2, 2 ], + * [ 1, 2, 1, 1 ], + * [ 2, 2, 2, 2 ], + * [ 2, 2, 2, 2 ] + * ]; + * + * var x = ones4d( shapes[ 0 ] ); + * var y = ones4d( shapes[ 1 ] ); + * var z = ones4d( shapes[ 2 ] ); + * var w = ones4d( shapes[ 3 ] ); + * var v = ones4d( shapes[ 4 ] ); + * var out = zeros4d( shapes[ 5 ] ); + * + * ns.bquinary4d( [ x, y, z, w, v, out ], shapes, add ); + * + * console.log( out ); + * // => [ [ [ [ 5.0, 5.0 ], [ 5.0, 5.0 ] ], [ [ 5.0, 5.0 ], [ 5.0, 5.0 ] ] ], [ [ [ 5.0, 5.0 ], [ 5.0, 5.0 ] ], [ [ 5.0, 5.0 ], [ 5.0, 5.0 ] ] ] ] + */ + bquinary4d: typeof bquinary4d; + /** * Applies a ternary callback to elements in three broadcasted input arrays and assigns results to elements in a two-dimensional nested output array. * @@ -1119,6 +1295,111 @@ interface Namespace { */ bternary2d: typeof bternary2d; + /** + * Applies a ternary callback to elements in three broadcasted input arrays and assigns results to elements in a three-dimensional nested output array. + * + * ## Notes + * + * - The input array shapes must be broadcast compatible with the output array shape. + * + * @param arrays - array containing three input nested arrays and one output nested array + * @param shapes - array shapes + * @param fcn - ternary callback + * + * @example + * var ones3d = require( '@stdlib/array/base/ones3d' ); + * var zeros3d = require( '@stdlib/array/base/zeros3d' ); + * var add = require( '@stdlib/math/base/ops/add3' ); + * + * var shapes = [ + * [ 1, 2, 1 ], + * [ 2, 1, 1 ], + * [ 1, 1, 2 ], + * [ 2, 2, 2 ] + * ]; + * + * var x = ones3d( shapes[ 0 ] ); + * var y = ones3d( shapes[ 1 ] ); + * var z = ones3d( shapes[ 2 ] ); + * var out = zeros3d( shapes[ 3 ] ); + * + * ns.bternary3d( [ x, y, z, out ], shapes, add ); + * + * console.log( out ); + * // => [ [ [ 3.0, 3.0 ], [ 3.0, 3.0 ] ], [ [ 3.0, 3.0 ], [ 3.0, 3.0 ] ] ] + */ + bternary3d: typeof bternary3d; + + /** + * Applies a ternary callback to elements in three broadcasted input arrays and assigns results to elements in a four-dimensional nested output array. + * + * ## Notes + * + * - The input array shapes must be broadcast compatible with the output array shape. + * + * @param arrays - array containing three input nested arrays and one output nested array + * @param shapes - array shapes + * @param fcn - ternary callback + * + * @example + * var ones4d = require( '@stdlib/array/base/ones4d' ); + * var zeros4d = require( '@stdlib/array/base/zeros4d' ); + * var add = require( '@stdlib/math/base/ops/add3' ); + * + * var shapes = [ + * [ 1, 2, 1, 1 ], + * [ 2, 1, 1, 1 ], + * [ 1, 1, 2, 1 ], + * [ 2, 2, 2, 2 ] + * ]; + * + * var x = ones4d( shapes[ 0 ] ); + * var y = ones4d( shapes[ 1 ] ); + * var z = ones4d( shapes[ 2 ] ); + * var out = zeros4d( shapes[ 3 ] ); + * + * ns.bternary4d( [ x, y, z, out ], shapes, add ); + * + * console.log( out ); + * // => [ [ [ 3.0, 3.0 ], [ 3.0, 3.0 ] ], [ [ 3.0, 3.0 ], [ 3.0, 3.0 ] ], [ [ 3.0, 3.0 ], [ 3.0, 3.0 ] ], [ [ 3.0, 3.0 ], [ 3.0, 3.0 ] ] ] + */ + bternary4d: typeof bternary4d; + + /** + * Applies a ternary callback to elements in three broadcasted input arrays and assigns results to elements in a five-dimensional nested output array. + * + * ## Notes + * + * - The input array shapes must be broadcast compatible with the output array shape. + * + * @param arrays - array containing three input nested arrays and one output nested array + * @param shapes - array shapes + * @param fcn - ternary callback + * + * @example + * var ones5d = require( '@stdlib/array/base/ones5d' ); + * var zeros5d = require( '@stdlib/array/base/zeros5d' ); + * var add = require( '@stdlib/math/base/ops/add3' ); + * var ns.bternary5d = require( '@stdlib/array/base/broadcasted-ternary5d' ); + * var shapes = [ + * [ 1, 2, 1, 1, 1 ], + * [ 2, 1, 1, 1, 1 ], + * [ 1, 1, 1, 1, 1 ], + * [ 2, 2, 1, 1, 1 ] + * ]; + * + * var x = ones5d( shapes[ 0 ] ); + * var y = ones5d( shapes[ 1 ] ); + * var z = ones5d( shapes[ 2 ] ); + * var out = zeros5d( shapes[ 3 ] ); + * + * ns.bternary5d( [ x, y, z, out ], shapes, add ); + * + * console.log( out ); + * // => [ [ [ [ [ 3 ] ] ], [ [ [ 3 ] ] ] ], [ [ [ 3 ] ] ], [ [ [ 3 ] ] ] ] ] + */ + bternary5d: typeof bternary5d; + /** * Applies a unary callback to elements in a broadcasted nested input array and assigns results to elements in a two-dimensional nested output array. * @@ -1643,6 +1924,29 @@ interface Namespace { */ fancySliceAssign: typeof fancySliceAssign; + /** + * Fills all elements within a portion of an array with a specified value. + * + * @param x - input array + * @param value - fill value + * @param start - starting index (inclusive) + * @param end - ending index (exclusive) + * @returns modified input array + * + * @example + * var x = [ 1, 2, 3 ]; + * + * var out = ns.fill( x, 4, 0, 3 ); + * // returns [ 4, 4, 4 ] + * + * @example + * var x = [ 1, 2, 3, 4, 5, 6 ]; + * + * var out = ns.fill( x, 8, 0, 3 ); + * // returns [ 8, 8, 8, 4, 5, 6 ] + */ + fill: typeof fill; + /** * Returns a filled "generic" array. * @@ -2513,6 +2817,19 @@ interface Namespace { */ indexOf: typeof indexOf; + /** + * Returns the complement of a list of array indices. + * + * @param N - array length + * @param indices - list of indices + * @returns indices complement + * + * @example + * var idx = ns.indicesComplement( 5, [ 1, 3 ] ); + * // returns [ 0, 2, 4 ] + */ + indicesComplement: typeof indicesComplement; + /** * Returns a string created by joining array elements using a specified separator. * @@ -2888,54 +3205,226 @@ interface Namespace { mskbinary2d: typeof mskbinary2d; /** - * Returns a new array by applying a mask to a provided input array. - * - * @param x - input array - * @param mask - mask array - * @returns output array + * Applies a binary callback to elements in two three-dimensional nested input arrays according to elements in a three-dimensional nested mask array and assigns results to elements in a three-dimensional nested output array. * - * @example - * var x = [ 1, 2, 3, 4 ]; + * ## Notes * - * var y = ns.mskfilter( x, [ 0, 1, 0, 1 ] ); - * // returns [ 2, 4 ] - */ - mskfilter: typeof mskfilter; - - /** - * Replaces elements of an array with provided values according to a provided mask array. + * - The function assumes that the input and output arrays have the same shape. + * - An element in an input array is "masked" if the corresponding element in the mask array is non-zero. * - * @param x - input array - * @param mask - mask array - * @param values - values to set - * @param mode - string specifying behavior when the number of values does not equal the number of falsy values in the mask array - * @returns input array + * @param arrays - array containing two input nested arrays, an input nested mask array, and one output nested array + * @param shape - array shape + * @param fcn - binary callback * * @example - * var x = [ 1, 2, 3, 4 ]; - * - * var mask = [ 1, 0, 0, 1 ]; - * var values = [ 20, 30 ]; + * var ones3d = require( '@stdlib/array/base/ones3d' ); + * var zeros3d = require( '@stdlib/array/base/zeros3d' ); + * var add = require( '@stdlib/math/base/ops/add' ); * - * var out = ns.mskput( x, mask, values, 'strict' ); - * // returns [ 1, 20, 30, 4 ] + * var shape = [ 2, 2, 2 ]; * - * var bool = ( out === x ); - * // returns true + * var x = ones3d( shape ); + * var y = ones3d( shape ); + * var z = zeros3d( shape ); * - * @example - * var x = [ 1, 2, 3, 4 ]; + * var mask = [ + * [ [ 0, 1 ], [ 0, 0 ] ], + * [ [ 1, 0 ], [ 0, 1 ] ] + * ]; * - * var out = ns.mskput( x, [ 1, 0, 0, 1 ], [ 30 ], 'strict_broadcast' ); - * // returns [ 1, 30, 30, 4 ] + * ns.mskbinary3d( [ x, y, mask, z ], shape, add ); * - * var bool = ( out === x ); - * // returns true + * console.log( z ); + * // => [ [ [ 2.0, 0.0 ], [ 2.0, 2.0 ] ], [ [ 0.0, 2.0 ], [ 2.0, 0.0 ] ] ] */ - mskput: typeof mskput; + mskbinary3d: typeof mskbinary3d; /** - * Returns a new array by applying a mask to a provided input array. + * Applies a binary callback to elements in two four-dimensional nested input arrays according to elements in a four-dimensional nested mask array and assigns results to elements in a four-dimensional nested output array. + * + * ## Notes + * + * - The function assumes that the input and output arrays have the same shape. + * - An element in an input array is "masked" if the corresponding element in the mask array is non-zero. + * + * @param arrays - array containing two input nested arrays, an input nested mask array, and one output nested array + * @param shape - array shape + * @param fcn - binary callback + * + * @example + * var ones4d = require( '@stdlib/array/base/ones4d' ); + * var zeros4d = require( '@stdlib/array/base/zeros4d' ); + * var add = require( '@stdlib/math/base/ops/add' ); + * + * var shape = [ 1, 1, 2, 2 ]; + * + * var x = ones4d( shape ); + * var y = ones4d( shape ); + * var z = zeros4d( shape ); + * + * var mask = [ [ [ [ 0, 1 ], [ 0, 0 ] ] ] ]; + * + * mskbinary2d( [ x, y, mask, z ], shape, add ); + * + * console.log( z ); + * // => [ [ [ [ 2.0, 0.0 ], [ 2.0, 2.0 ] ] ] ] + */ + mskbinary4d: typeof mskbinary4d; + + /** + * Applies a binary callback to elements in two five-dimensional nested input arrays according to elements in a five-dimensional nested mask array and assigns results to elements in a five-dimensional nested output array. + * + * ## Notes + * + * - The function assumes that the input and output arrays have the same shape. + * - An element in an input array is "masked" if the corresponding element in the mask array is non-zero. + * + * @param arrays - array containing two input nested arrays, an input nested mask array, and one output nested array + * @param shape - array shape + * @param fcn - binary callback + * + * @example + * var ones5d = require( '@stdlib/array/base/ones5d' ); + * var zeros5d = require( '@stdlib/array/base/zeros5d' ); + * var add = require( '@stdlib/math/base/ops/add' ); + * + * var shape = [ 1, 1, 1, 2, 2 ]; + * + * var x = ones5d( shape ); + * var y = ones5d( shape ); + * var z = zeros5d( shape ); + * + * var mask = [ [ [ [ [ 0, 1 ], [ 0, 0 ] ] ] ] ]; + * + * ns.mskbinary5d( [ x, y, mask, z ], shape, add ); + * + * console.log( z ); + * // => [ [ [ [ [ 2.0, 0.0 ], [ 2.0, 2.0 ] ] ] ] ] + */ + mskbinary5d: typeof mskbinary5d; + + /** + * Returns a new array by applying a mask to a provided input array. + * + * @param x - input array + * @param mask - mask array + * @returns output array + * + * @example + * var x = [ 1, 2, 3, 4 ]; + * + * var y = ns.mskfilter( x, [ 0, 1, 0, 1 ] ); + * // returns [ 2, 4 ] + */ + mskfilter: typeof mskfilter; + + /** + * Returns a new array after applying a mask and a callback function to a provided input array. + * + * @param x - input array + * @param mask - mask array + * @param clbk - callback function + * @param thisArg - callback execution context + * @returns output array + * + * @example + * var x = [ 1, 2, 3, 4 ]; + * + * function scale( val ) { + * return 10 * val; + * } + * + * var y = ns.mskfilterMap( x, [ 0, 1, 0, 1 ], scale ); + * // returns [ 20, 40 ] + * + * @example + * var x = [ 1, 2, 3, 4 ]; + * var mask = [ 0, 1, 0, 1 ]; + * + * var out = [ 0, 0, 0, 0 ]; + * + * function scale( x ) { + * return x * 10; + * } + * + * var arr = ns.mskfilterMap.assign( x, mask, out, 1, 0, scale ); + * // returns [ 20, 40, 0, 0 ] + * + * var bool = ( arr === out ); + * // returns true + */ + mskfilterMap: typeof mskfilterMap; + + /** + * Returns new arrays by applying a mask to two provided input arrays in a single pass. + * + * @param x - first input array + * @param y - second input array + * @param mask - mask array + * @returns output arrays + * + * @example + * var x = [ 1, 2, 3, 4 ]; + * var idx = [ 5, 6, 7, 8 ]; + * var mask = [ 0, 1, 0, 1 ]; + * + * var out = ns.mskfilter2( x, idx, mask ); + * // returns [ [ 2, 4 ], [ 6, 8 ] ] + */ + mskfilter2: typeof mskfilter2; + + /** + * Returns new arrays by applying a mask to one or more provided input arrays in a single pass. + * + * @param x - first input array + * @param y - second input array (or mask) + * @param arrays - additional input arrays and mask + * @returns output arrays + * + * @example + * var x = [ 1, 2, 3, 4 ]; + * var y = [ 5, 6, 7, 8 ]; + * var mask = [ 0, 1, 0, 1 ]; + * + * var out = ns.mskfiltern( x, y, mask ); + * // returns [ [ 2, 4 ], [ 6, 8 ] ] + */ + mskfiltern: typeof mskfiltern; + + /** + * Replaces elements of an array with provided values according to a provided mask array. + * + * @param x - input array + * @param mask - mask array + * @param values - values to set + * @param mode - string specifying behavior when the number of values does not equal the number of falsy values in the mask array + * @returns input array + * + * @example + * var x = [ 1, 2, 3, 4 ]; + * + * var mask = [ 1, 0, 0, 1 ]; + * var values = [ 20, 30 ]; + * + * var out = ns.mskput( x, mask, values, 'strict' ); + * // returns [ 1, 20, 30, 4 ] + * + * var bool = ( out === x ); + * // returns true + * + * @example + * var x = [ 1, 2, 3, 4 ]; + * + * var out = ns.mskput( x, [ 1, 0, 0, 1 ], [ 30 ], 'strict_broadcast' ); + * // returns [ 1, 30, 30, 4 ] + * + * var bool = ( out === x ); + * // returns true + */ + mskput: typeof mskput; + + /** + * Returns a new array by applying a mask to a provided input array. * * @param x - input array * @param mask - mask array @@ -3017,6 +3506,74 @@ interface Namespace { */ mskunary3d: typeof mskunary3d; + /** + * Applies a unary callback to elements in a four-dimensional nested input array according to elements in a four-dimensional nested mask array and assigns results to elements in a four-dimensional nested output array. + * + * ## Notes + * + * - The function assumes that the input and output arrays have the same shape. + * - An element in an input array is "masked" if the corresponding element in the mask array is non-zero. + * + * @param arrays - array containing one input nested array, an input nested mask array, and one output nested array + * @param shape - array shape + * @param fcn - unary callback + * + * @example + * var ones4d = require( '@stdlib/array/base/ones4d' ); + * var zeros4d = require( '@stdlib/array/base/zeros4d' ); + * + * function scale( x ) { + * return x * 10.0; + * } + * + * var shape = [ 1, 1, 2, 2 ]; + * + * var x = ones4d( shape ); + * var y = zeros4d( shape ); + * + * var mask = [ [ [ [ 0, 1 ], [ 0, 0 ] ] ] ]; + * + * ns.mskunary4d( [ x, mask, y ], shape, scale ); + * + * console.log( y ); + * // => [ [ [ [ 10.0, 0.0 ], [ 10.0, 10.0 ] ] ] ] + */ + mskunary4d: typeof mskunary4d; + + /** + * Applies a unary callback to elements in a five-dimensional nested input array according to elements in a five-dimensional nested mask array and assigns results to elements in a five-dimensional nested output array. + * + * ## Notes + * + * - The function assumes that the input and output arrays have the same shape. + * - An element in an input array is "masked" if the corresponding element in the mask array is non-zero. + * + * @param arrays - array containing one input nested array, an input nested mask array, and one output nested array + * @param shape - array shape + * @param fcn - unary callback + * + * @example + * var ones5d = require( '@stdlib/array/base/ones5d' ); + * var zeros5d = require( '@stdlib/array/base/zeros5d' ); + * + * function scale( x ) { + * return x * 10.0; + * } + * + * var shape = [ 1, 1, 1, 2, 2 ]; + * + * var x = ones5d( shape ); + * var y = zeros5d( shape ); + * + * var mask = [ [ [ [ [ 0, 1 ], [ 0, 0 ] ] ] ] ]; + * + * ns.mskunary5d( [ x, mask, y ], shape, scale ); + * + * console.log( y ); + * // => [ [ [ [ [ 10.0, 0.0 ], [ 10.0, 10.0 ] ] ] ] ] + */ + mskunary5d: typeof mskunary5d; + /** * Returns the n-fold Cartesian product. * @@ -3618,6 +4175,51 @@ interface Namespace { */ reverse: typeof reverse; + /** + * Scatters a list of provided values to specified indices in a new filled "generic" array. + * + * @param fill - fill value + * @param len - output array length + * @param indices - list of element indices + * @param values - values to scatter + * @param mode - index mode + * @returns output array + * + * @example + * var indices = [ 1, 2 ]; + * var values = [ 20, 30 ]; + * + * var out = ns.scatterFilled( null, 4, indices, values, 'throw' ); + * // returns [ null, 20, 30, null ] + * + * @example + * var out = ns.scatterFilled( null, 4, [ 1, 2 ], [ 30 ], 'throw' ); + * // returns [ null, 30, 30, null ] + */ + scatterFilled: typeof scatterFilled; + + /** + * Scatters a list of provided values to specified indices in a new zero-filled "generic" array. + * + * @param len - output array length + * @param indices - list of element indices + * @param values - values to scatter + * @param mode - index mode + * @returns output array + * + * @example + * var indices = [ 1, 2 ]; + * var values = [ 20, 30 ]; + * + * var out = ns.scattered( 4, indices, values, 'throw' ); + * // returns [ 0, 20, 30, 0 ] + * + * @example + * var out = ns.scattered( 4, [ 1, 2 ], [ 30 ], 'throw' ); + * // returns [ 0, 30, 30, 0 ] + */ + scattered: typeof scattered; + /** * Returns an accessor function for setting an element in an indexed array-like object. * @@ -3794,7 +4396,7 @@ interface Namespace { take: typeof take; /** - * Takes element from an indexed array. + * Takes elements from an indexed array. * * ## Notes * @@ -3812,6 +4414,28 @@ interface Namespace { */ takeIndexed: typeof takeIndexed; + /** + * Takes elements from two indexed arrays in a single pass. + * + * ## Notes + * + * - The function does **not** perform bounds checking. If an index is less than zero or greater than the maximum index of `x` or `y`, the value of the corresponding element in the respective output array is undefined. + * + * @param x - first input array + * @param y - second input array + * @param indices - list of element indices + * @returns output arrays + * + * @example + * var x = [ 1, 2, 3, 4 ]; + * var y = [ 5, 6, 7, 8 ]; + * var indices = [ 3, 1, 2, 0 ]; + * + * var out = ns.takeIndexed2( x, y, indices ); + * // returns [ [ 4, 2, 3, 1 ], [ 8, 6, 7, 5 ] ] + */ + takeIndexed2: typeof takeIndexed2; + /** * Takes elements from a two-dimensional nested array. * @@ -4153,6 +4777,43 @@ interface Namespace { */ unary3d: typeof unary3d; + /** + * Applies a unary function to each element retrieved from a three-dimensional nested input array according to a callback function and assigns results to elements in a three-dimensional nested output array. + * + * ## Notes + * + * - The function assumes that the input and output arrays have the same shape. + * + * @param arrays - array containing one input nested array and one output nested array + * @param shape - array shape + * @param fcn - unary function to apply to callback return values + * @param clbk - callback function + * @param thisArg - callback execution context + * + * @example + * var ones3d = require( '@stdlib/array/base/ones3d' ); + * var zeros3d = require( '@stdlib/array/base/zeros3d' ); + * + * function accessor( v ) { + * return v - 2.0; + * } + * + * function scale( x ) { + * return x * 10.0; + * } + * + * var shape = [ 1, 2, 2 ]; + * + * var x = ones3d( shape ); + * var y = zeros3d( shape ); + * + * ns.unary3dBy( [ x, y ], shape, scale ); + * + * console.log( y ); + * // => [ [ [ -10.0, -10.0 ], [ -10.0, -10.0 ] ] ] + */ + unary3dBy: typeof unary3dBy; + /** * Applies a unary callback to elements in a four-dimensional nested input array and assigns results to elements in a four-dimensional nested output array. * @@ -4184,6 +4845,43 @@ interface Namespace { */ unary4d: typeof unary4d; + /** + * Applies a unary function to each element retrieved from a four-dimensional nested input array according to a callback function and assigns results to elements in a four-dimensional nested output array. + * + * ## Notes + * + * - The function assumes that the input and output arrays have the same shape. + * + * @param arrays - array containing one input nested array and one output nested array + * @param shape - array shape + * @param fcn - unary function to apply to callback return values + * @param clbk - callback function + * @param thisArg - callback execution context + * + * @example + * var ones4d = require( '@stdlib/array/base/ones4d' ); + * var zeros4d = require( '@stdlib/array/base/zeros4d' ); + * + * function accessor( v ) { + * return v - 2.0; + * } + * + * function scale( x ) { + * return x * 10.0; + * } + * + * var shape = [ 1, 1, 2, 2 ]; + * + * var x = ones4d( shape ); + * var y = zeros4d( shape ); + * + * ns.unary4dBy( [ x, y ], shape, scale ); + * + * console.log( y ); + * // => [ [ [ [ -10.0, -10.0 ], [ -10.0, -10.0 ] ] ] ] + */ + unary4dBy: typeof unary4dBy; + /** * Applies a unary callback to elements in a five-dimensional nested input array and assigns results to elements in a five-dimensional nested output array. * @@ -4215,6 +4913,43 @@ interface Namespace { */ unary5d: typeof unary5d; + /** + * Applies a unary function to each element retrieved from a five-dimensional nested input array according to a callback function and assigns results to elements in a five-dimensional nested output array. + * + * ## Notes + * + * - The function assumes that the input and output arrays have the same shape. + * + * @param arrays - array containing one input nested array and one output nested array + * @param shape - array shape + * @param fcn - unary function to apply to callback return values + * @param clbk - callback function + * @param thisArg - callback execution context + * + * @example + * var ones5d = require( '@stdlib/array/base/ones5d' ); + * var zeros5d = require( '@stdlib/array/base/zeros5d' ); + * + * function accessor( v ) { + * return v - 2.0; + * } + * + * function scale( x ) { + * return x * 10.0; + * } + * + * var shape = [ 1, 1, 1, 2, 2 ]; + * + * var x = ones5d( shape ); + * var y = zeros5d( shape ); + * + * unary2dBy( [ x, y ], shape, scale ); + * + * console.log( y ); + * // => [ [ [ [ [ -10.0, -10.0 ], [ -10.0, -10.0 ] ] ] ] ] + */ + unary5dBy: typeof unary5dBy; + /** * Applies a unary callback to elements in an n-dimensional nested input array and assigns results to elements in an n-dimensional nested output array. * diff --git a/lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts index 3120fe7e9293..9467dd6841ea 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts @@ -1690,9 +1690,9 @@ interface Namespace { * @param N - number of indexed elements * @param sum - initial sum * @param x - input array - * @param strideX - `x` stride length + * @param strideX - stride length for `x` * @param y - output array - * @param strideY - `y` stride length + * @param strideY - stride length for `y` * @returns output array * * @example @@ -1945,7 +1945,7 @@ interface Namespace { * * @param N - number of indexed elements * @param x - input array - * @param stride - stride length + * @param strideX - stride length * @returns `x` * * @example diff --git a/lib/node_modules/@stdlib/ndarray/base/assert/docs/types/index.d.ts b/lib/node_modules/@stdlib/ndarray/base/assert/docs/types/index.d.ts index 1d7dd395fa53..dac43c256839 100644 --- a/lib/node_modules/@stdlib/ndarray/base/assert/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/ndarray/base/assert/docs/types/index.d.ts @@ -28,6 +28,7 @@ import isBufferLengthCompatibleShape = require( '@stdlib/ndarray/base/assert/is- import isCastingMode = require( '@stdlib/ndarray/base/assert/is-casting-mode' ); import isColumnMajor = require( '@stdlib/ndarray/base/assert/is-column-major' ); import isColumnMajorContiguous = require( '@stdlib/ndarray/base/assert/is-column-major-contiguous' ); +import isColumnMajorString = require( '@stdlib/ndarray/base/assert/is-column-major-string' ); import isComplexFloatingPointDataType = require( '@stdlib/ndarray/base/assert/is-complex-floating-point-data-type' ); import isContiguous = require( '@stdlib/ndarray/base/assert/is-contiguous' ); import isDataType = require( '@stdlib/ndarray/base/assert/is-data-type' ); @@ -42,6 +43,7 @@ import isRealDataType = require( '@stdlib/ndarray/base/assert/is-real-data-type' import isRealFloatingPointDataType = require( '@stdlib/ndarray/base/assert/is-real-floating-point-data-type' ); import isRowMajor = require( '@stdlib/ndarray/base/assert/is-row-major' ); import isRowMajorContiguous = require( '@stdlib/ndarray/base/assert/is-row-major-contiguous' ); +import isRowMajorString = require( '@stdlib/ndarray/base/assert/is-row-major-string' ); import isSafeDataTypeCast = require( '@stdlib/ndarray/base/assert/is-safe-data-type-cast' ); import isSameKindDataTypeCast = require( '@stdlib/ndarray/base/assert/is-same-kind-data-type-cast' ); import isSignedIntegerDataType = require( '@stdlib/ndarray/base/assert/is-signed-integer-data-type' ); @@ -262,6 +264,24 @@ interface Namespace { */ isColumnMajorContiguous: typeof isColumnMajorContiguous; + /** + * Tests whether an input value is the string representing column-major order. + * + * @param v - value to test + * @returns boolean result + * + * @example + * var bool = ns.isColumnMajorString( 'column-major' ); + * // returns true + * + * bool = ns.isColumnMajorString( 'row-major' ); + * // returns false + * + * bool = ns.isColumnMajorString( 'foo' ); + * // returns false + */ + isColumnMajorString: typeof isColumnMajorString; + /** * Tests whether an input value is a supported ndarray complex-valued floating-point data type. * @@ -747,6 +767,24 @@ interface Namespace { */ isRowMajorContiguous: typeof isRowMajorContiguous; + /** + * Tests whether an input value is the string representing row-major order. + * + * @param v - value to test + * @returns boolean result + * + * @example + * var bool = ns.isRowMajorString( 'row-major' ); + * // returns true + * + * bool = ns.isRowMajorString( 'column-major' ); + * // returns false + * + * bool = ns.isRowMajorString( 'foo' ); + * // returns false + */ + isRowMajorString: typeof isRowMajorString; + /** * Returns a boolean indicating if a provided ndarray data type can be safely cast to another ndarray data type. * diff --git a/lib/node_modules/@stdlib/ndarray/base/docs/types/index.d.ts b/lib/node_modules/@stdlib/ndarray/base/docs/types/index.d.ts index aa9f901ba0f7..c4f6ba471b97 100644 --- a/lib/node_modules/@stdlib/ndarray/base/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/ndarray/base/docs/types/index.d.ts @@ -76,6 +76,7 @@ import ndims = require( '@stdlib/ndarray/base/ndims' ); import nextCartesianIndex = require( '@stdlib/ndarray/base/next-cartesian-index' ); import nonsingletonDimensions = require( '@stdlib/ndarray/base/nonsingleton-dimensions' ); import normalizeIndex = require( '@stdlib/ndarray/base/normalize-index' ); +import normalizeIndices = require( '@stdlib/ndarray/base/normalize-indices' ); import nullary = require( '@stdlib/ndarray/base/nullary' ); import nullaryLoopOrder = require( '@stdlib/ndarray/base/nullary-loop-interchange-order' ); import nullaryBlockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' ); @@ -102,13 +103,16 @@ import sliceDimensionFrom = require( '@stdlib/ndarray/base/slice-dimension-from' import sliceDimensionTo = require( '@stdlib/ndarray/base/slice-dimension-to' ); import sliceFrom = require( '@stdlib/ndarray/base/slice-from' ); import sliceTo = require( '@stdlib/ndarray/base/slice-to' ); +import spreadDimensions = require( '@stdlib/ndarray/base/spread-dimensions' ); import stride = require( '@stdlib/ndarray/base/stride' ); import strides = require( '@stdlib/ndarray/base/strides' ); import strides2offset = require( '@stdlib/ndarray/base/strides2offset' ); import strides2order = require( '@stdlib/ndarray/base/strides2order' ); import sub2ind = require( '@stdlib/ndarray/base/sub2ind' ); import ndarray2array = require( '@stdlib/ndarray/base/to-array' ); +import toNormalizedIndices = require( '@stdlib/ndarray/base/to-normalized-indices' ); import toReversed = require( '@stdlib/ndarray/base/to-reversed' ); +import toUniqueNormalizedIndices = require( '@stdlib/ndarray/base/to-unique-normalized-indices' ); import transpose = require( '@stdlib/ndarray/base/transpose' ); import unary = require( '@stdlib/ndarray/base/unary' ); import unaryBy = require( '@stdlib/ndarray/base/unary-by' ); @@ -1865,6 +1869,27 @@ interface Namespace { */ normalizeIndex: typeof normalizeIndex; + /** + * Normalizes a list of indices to the interval `[0,max]`. + * + * ## Notes + * + * - If provided an out-of-bounds index, the function returns `null`. + * - The function mutates the input array, even when provided an out-of-bounds index. + * + * @param indices - indices + * @param max - maximum index + * @returns normalized indices or null + * + * @example + * var indices = ns.normalizeIndices( [ -2, 5 ], 10 ); + * // returns [ 9, 5 ] + * + * indices = ns.normalizeIndices( [ -2, 15 ], 10 ); + * // returns null + */ + normalizeIndices: typeof normalizeIndices; + /** * Applies a nullary callback and assigns results to elements in an output ndarray. * @@ -2662,6 +2687,48 @@ interface Namespace { */ sliceTo: typeof sliceTo; + /** + * Expands the shape of an array to a specified dimensionality by spreading its dimensions to specified dimension indices and inserting dimensions of size one for the remaining dimensions. + * + * ## Notes + * + * - Each provided dimension index must reside on the interval `[-ndims, ndims-1]`. If provided a negative dimension index, the position at which to place a respective dimension is computed as `ndims + index`. + * - Provided dimension indices must resolve to normalized dimension indices arranged in ascending order. + * + * @param ndims - number of dimensions in the output array + * @param x - input array + * @param dims - dimension indices + * @returns output array + * + * @example + * var array = require( '@stdlib/ndarray/array' ); + * + * var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); + * // returns + * + * var shx = x.shape; + * // returns [ 2, 2 ] + * + * var y = ns.spreadDimensions( 5, x, [ 1, 3 ] ); + * // returns + * + * var shy = y.shape; + * // returns [ 1, 2, 1, 2, 1 ] + * + * var v = y.get( 0, 0, 0, 0, 0 ); + * // returns 1 + * + * v = y.get( 0, 0, 0, 1, 0 ); + * // returns 2 + * + * v = y.get( 0, 1, 0, 0, 0 ); + * // returns 3 + * + * v = y.get( 0, 1, 0, 1, 0 ); + * // returns 4 + */ + spreadDimensions: typeof spreadDimensions; + /** * Returns the stride along a specified dimension for a provided ndarray. * @@ -2865,6 +2932,26 @@ interface Namespace { */ ndarray2array: typeof ndarray2array; + /** + * Normalizes a list of indices to the interval `[0,max]`. + * + * ## Notes + * + * - If provided an out-of-bounds index, the function normalizes the index to `-1`. + * + * @param indices - indices + * @param max - maximum index + * @returns normalized indices + * + * @example + * var indices = ns.toNormalizedIndices( [ -2, 5 ], 10 ); + * // returns [ 9, 5 ] + * + * indices = ns.toNormalizedIndices( [ -2, 15 ], 10 ); + * // returns [ 9, -1 ] + */ + toNormalizedIndices: typeof toNormalizedIndices; + /** * Returns a new ndarray where the order of elements of an input ndarray is reversed along each dimension. * @@ -2901,6 +2988,26 @@ interface Namespace { */ toReversed: typeof toReversed; + /** + * Returns a list of unique indices after normalizing to the interval `[0,max]`. + * + * ## Notes + * + * - If provided an out-of-bounds index, the function returns `null`. + * + * @param indices - indices + * @param max - maximum index + * @returns normalized indices (or null) + * + * @example + * var indices = ns.toUniqueNormalizedIndices( [ -2, 5 ], 10 ); + * // returns [ 9, 5 ] + * + * indices = ns.toUniqueNormalizedIndices( [ -2, 15 ], 10 ); + * // returns null + */ + toUniqueNormalizedIndices: typeof toUniqueNormalizedIndices; + /** * Transposes a matrix (or a stack of matrices). * diff --git a/lib/node_modules/@stdlib/stats/base/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/docs/types/index.d.ts index 435fb70f1abb..059aaa58cb54 100644 --- a/lib/node_modules/@stdlib/stats/base/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/docs/types/index.d.ts @@ -5455,7 +5455,7 @@ interface Namespace { * @param N - number of indexed elements * @param correction - degrees of freedom adjustment * @param x - input array - * @param stride - stride length + * @param strideX - stride length * @returns standard deviation * * @example @@ -5509,7 +5509,7 @@ interface Namespace { * @param N - number of indexed elements * @param correction - degrees of freedom adjustment * @param x - input array - * @param stride - stride length + * @param strideX - stride length * @returns standard deviation * * @example