diff --git a/lib/node_modules/@stdlib/array/base/cuevery-by-right/README.md b/lib/node_modules/@stdlib/array/base/cuevery-by-right/README.md index 17dca3bf05b6..d0a0268f9ce3 100644 --- a/lib/node_modules/@stdlib/array/base/cuevery-by-right/README.md +++ b/lib/node_modules/@stdlib/array/base/cuevery-by-right/README.md @@ -66,9 +66,9 @@ var bool = ( out === y ); The invoked `predicate` function is provided three arguments: -- **value**: collection element, -- **index**: collection index, -- **collection**: input collection, +- **value**: collection element. +- **index**: collection index. +- **collection**: input collection. To set the function execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/array/float32/README.md b/lib/node_modules/@stdlib/array/float32/README.md index e48de663268f..3f4796534797 100644 --- a/lib/node_modules/@stdlib/array/float32/README.md +++ b/lib/node_modules/@stdlib/array/float32/README.md @@ -233,8 +233,8 @@ var arr = Float32Array.from( [ 1.0, 2.0 ], mapFcn ); A callback function is provided two arguments: -- `value`: source value -- `index`: source index +- `value`: source value. +- `index`: source index. To set the callback execution context, provide a `thisArg`. @@ -371,9 +371,9 @@ var bool = arr.every( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -490,9 +490,9 @@ var arr2 = arr1.filter( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -552,9 +552,9 @@ var v = arr.find( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -615,9 +615,9 @@ var idx = arr.findIndex( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -670,9 +670,9 @@ console.log( str ); The callback is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -893,9 +893,9 @@ var arr2 = arr1.map( fcn ); A callback is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -957,10 +957,10 @@ var v = arr.reduce( fcn, 0.0 ); A callback is provided four arguments: -- `acc`: accumulated result -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `acc`: accumulated result. +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. @@ -1000,10 +1000,10 @@ var v = arr.reduce( fcn, 0.0 ); A callback is provided four arguments: -- `acc`: accumulated result -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `acc`: accumulated result. +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. @@ -1176,9 +1176,9 @@ var bool = arr.some( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/array/float64/README.md b/lib/node_modules/@stdlib/array/float64/README.md index 9e2abee7bc66..ee04993e6922 100644 --- a/lib/node_modules/@stdlib/array/float64/README.md +++ b/lib/node_modules/@stdlib/array/float64/README.md @@ -229,8 +229,8 @@ var arr = Float64Array.from( [ 1.0, -1.0 ], mapFcn ); A callback function is provided two arguments: -- `value`: source value -- `index`: source index +- `value`: source value. +- `index`: source index. To set the callback execution context, provide a `thisArg`. @@ -363,9 +363,9 @@ var bool = arr.every( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -482,9 +482,9 @@ var arr2 = arr1.filter( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -544,9 +544,9 @@ var v = arr.find( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -607,9 +607,9 @@ var idx = arr.findIndex( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -662,9 +662,9 @@ console.log( str ); The callback is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -885,9 +885,9 @@ var arr2 = arr1.map( fcn ); A callback is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -949,10 +949,10 @@ var v = arr.reduce( fcn, 0.0 ); A callback is provided four arguments: -- `acc`: accumulated result -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `acc`: accumulated result. +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. @@ -992,10 +992,10 @@ var v = arr.reduce( fcn, 0.0 ); A callback is provided four arguments: -- `acc`: accumulated result -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `acc`: accumulated result. +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. @@ -1168,9 +1168,9 @@ var bool = arr.some( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/array/int16/README.md b/lib/node_modules/@stdlib/array/int16/README.md index 1a577098baee..3a165efea386 100644 --- a/lib/node_modules/@stdlib/array/int16/README.md +++ b/lib/node_modules/@stdlib/array/int16/README.md @@ -229,8 +229,8 @@ var arr = Int16Array.from( [ 1, 2 ], mapFcn ); A callback function is provided two arguments: -- `value`: source value -- `index`: source index +- `value`: source value. +- `index`: source index. To set the callback execution context, provide a `thisArg`. @@ -363,9 +363,9 @@ var bool = arr.every( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -482,9 +482,9 @@ var arr2 = arr1.filter( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -544,9 +544,9 @@ var v = arr.find( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -607,9 +607,9 @@ var idx = arr.findIndex( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -662,9 +662,9 @@ console.log( str ); The callback is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -879,9 +879,9 @@ var arr2 = arr1.map( fcn ); A callback is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -943,10 +943,10 @@ var v = arr.reduce( fcn, 0 ); A callback is provided four arguments: -- `acc`: accumulated result -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `acc`: accumulated result. +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. @@ -986,10 +986,10 @@ var v = arr.reduce( fcn, 0 ); A callback is provided four arguments: -- `acc`: accumulated result -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `acc`: accumulated result. +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. @@ -1162,9 +1162,9 @@ var bool = arr.some( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/array/int32/README.md b/lib/node_modules/@stdlib/array/int32/README.md index c9215ea7a37e..45def2674ec2 100644 --- a/lib/node_modules/@stdlib/array/int32/README.md +++ b/lib/node_modules/@stdlib/array/int32/README.md @@ -229,8 +229,8 @@ var arr = Int32Array.from( [ 1, 2 ], mapFcn ); A callback function is provided two arguments: -- `value`: source value -- `index`: source index +- `value`: source value. +- `index`: source index. To set the callback execution context, provide a `thisArg`. @@ -363,9 +363,9 @@ var bool = arr.every( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -482,9 +482,9 @@ var arr2 = arr1.filter( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -544,9 +544,9 @@ var v = arr.find( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -607,9 +607,9 @@ var idx = arr.findIndex( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -662,9 +662,9 @@ console.log( str ); The callback is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -879,9 +879,9 @@ var arr2 = arr1.map( fcn ); A callback is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -943,10 +943,10 @@ var v = arr.reduce( fcn, 0 ); A callback is provided four arguments: -- `acc`: accumulated result -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `acc`: accumulated result. +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. @@ -986,10 +986,10 @@ var v = arr.reduce( fcn, 0 ); A callback is provided four arguments: -- `acc`: accumulated result -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `acc`: accumulated result. +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. @@ -1162,9 +1162,9 @@ var bool = arr.some( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/array/int8/README.md b/lib/node_modules/@stdlib/array/int8/README.md index 545894ac08e9..50288ee35f70 100644 --- a/lib/node_modules/@stdlib/array/int8/README.md +++ b/lib/node_modules/@stdlib/array/int8/README.md @@ -229,8 +229,8 @@ var arr = Int8Array.from( [ 1, 2 ], mapFcn ); A callback function is provided two arguments: -- `value`: source value -- `index`: source index +- `value`: source value. +- `index`: source index. To set the callback execution context, provide a `thisArg`. @@ -363,9 +363,9 @@ var bool = arr.every( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -482,9 +482,9 @@ var arr2 = arr1.filter( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -544,9 +544,9 @@ var v = arr.find( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -607,9 +607,9 @@ var idx = arr.findIndex( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -662,9 +662,9 @@ console.log( str ); The callback is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -879,9 +879,9 @@ var arr2 = arr1.map( fcn ); A callback is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -943,10 +943,10 @@ var v = arr.reduce( fcn, 0 ); A callback is provided four arguments: -- `acc`: accumulated result -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `acc`: accumulated result. +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. @@ -986,10 +986,10 @@ var v = arr.reduce( fcn, 0 ); A callback is provided four arguments: -- `acc`: accumulated result -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `acc`: accumulated result. +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. @@ -1162,9 +1162,9 @@ var bool = arr.some( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/array/uint16/README.md b/lib/node_modules/@stdlib/array/uint16/README.md index f1962df57fd5..159606fe33ff 100644 --- a/lib/node_modules/@stdlib/array/uint16/README.md +++ b/lib/node_modules/@stdlib/array/uint16/README.md @@ -229,8 +229,8 @@ var arr = Uint16Array.from( [ 1, 2 ], mapFcn ); A callback function is provided two arguments: -- `value`: source value -- `index`: source index +- `value`: source value. +- `index`: source index. To set the callback execution context, provide a `thisArg`. @@ -363,9 +363,9 @@ var bool = arr.every( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -482,9 +482,9 @@ var arr2 = arr1.filter( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -544,9 +544,9 @@ var v = arr.find( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -607,9 +607,9 @@ var idx = arr.findIndex( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -662,9 +662,9 @@ console.log( str ); The callback is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -879,9 +879,9 @@ var arr2 = arr1.map( fcn ); A callback is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -943,10 +943,10 @@ var v = arr.reduce( fcn, 0 ); A callback is provided four arguments: -- `acc`: accumulated result -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `acc`: accumulated result. +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. @@ -986,10 +986,10 @@ var v = arr.reduce( fcn, 0 ); A callback is provided four arguments: -- `acc`: accumulated result -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `acc`: accumulated result. +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. @@ -1162,9 +1162,9 @@ var bool = arr.some( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/array/uint32/README.md b/lib/node_modules/@stdlib/array/uint32/README.md index c081d0e2ff33..da419b7ac2d8 100644 --- a/lib/node_modules/@stdlib/array/uint32/README.md +++ b/lib/node_modules/@stdlib/array/uint32/README.md @@ -229,8 +229,8 @@ var arr = Uint32Array.from( [ 1, 2 ], mapFcn ); A callback function is provided two arguments: -- `value`: source value -- `index`: source index +- `value`: source value. +- `index`: source index.. To set the callback execution context, provide a `thisArg`. @@ -363,9 +363,9 @@ var bool = arr.every( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -482,9 +482,9 @@ var arr2 = arr1.filter( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -544,9 +544,9 @@ var v = arr.find( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -607,9 +607,9 @@ var idx = arr.findIndex( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -662,9 +662,9 @@ console.log( str ); The callback is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -879,9 +879,9 @@ var arr2 = arr1.map( fcn ); A callback is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -943,10 +943,10 @@ var v = arr.reduce( fcn, 0 ); A callback is provided four arguments: -- `acc`: accumulated result -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `acc`: accumulated result. +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. @@ -986,10 +986,10 @@ var v = arr.reduce( fcn, 0 ); A callback is provided four arguments: -- `acc`: accumulated result -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `acc`: accumulated result. +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. @@ -1162,9 +1162,9 @@ var bool = arr.some( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/array/uint8/README.md b/lib/node_modules/@stdlib/array/uint8/README.md index 53b5170784f6..7adbddf55bce 100644 --- a/lib/node_modules/@stdlib/array/uint8/README.md +++ b/lib/node_modules/@stdlib/array/uint8/README.md @@ -229,8 +229,8 @@ var arr = Uint8Array.from( [ 1, 2 ], mapFcn ); A callback function is provided two arguments: -- `value`: source value -- `index`: source index +- `value`: source value. +- `index`: source index. To set the callback execution context, provide a `thisArg`. @@ -363,9 +363,9 @@ var bool = arr.every( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -482,9 +482,9 @@ var arr2 = arr1.filter( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -544,9 +544,9 @@ var v = arr.find( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -607,9 +607,9 @@ var idx = arr.findIndex( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -662,9 +662,9 @@ console.log( str ); The callback is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -879,9 +879,9 @@ var arr2 = arr1.map( fcn ); A callback is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -943,10 +943,10 @@ var v = arr.reduce( fcn, 0 ); A callback is provided four arguments: -- `acc`: accumulated result -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `acc`: accumulated result. +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. @@ -986,10 +986,10 @@ var v = arr.reduce( fcn, 0 ); A callback is provided four arguments: -- `acc`: accumulated result -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `acc`: accumulated result. +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. @@ -1162,9 +1162,9 @@ var bool = arr.some( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/array/uint8c/README.md b/lib/node_modules/@stdlib/array/uint8c/README.md index aa4caf80a488..de33ece9549b 100644 --- a/lib/node_modules/@stdlib/array/uint8c/README.md +++ b/lib/node_modules/@stdlib/array/uint8c/README.md @@ -229,8 +229,8 @@ var arr = Uint8ClampedArray.from( [ 1, 2 ], mapFcn ); A callback function is provided two arguments: -- `value`: source value -- `index`: source index +- `value`: source value. +- `index`: source index. To set the callback execution context, provide a `thisArg`. @@ -363,9 +363,9 @@ var bool = arr.every( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -482,9 +482,9 @@ var arr2 = arr1.filter( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -544,9 +544,9 @@ var v = arr.find( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -607,9 +607,9 @@ var idx = arr.findIndex( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -662,9 +662,9 @@ console.log( str ); The callback is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -879,9 +879,9 @@ var arr2 = arr1.map( fcn ); A callback is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -943,10 +943,10 @@ var v = arr.reduce( fcn, 0 ); A callback is provided four arguments: -- `acc`: accumulated result -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `acc`: accumulated result. +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. @@ -986,10 +986,10 @@ var v = arr.reduce( fcn, 0 ); A callback is provided four arguments: -- `acc`: accumulated result -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `acc`: accumulated result. +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. @@ -1162,9 +1162,9 @@ var bool = arr.some( predicate ); A `predicate` function is provided three arguments: -- `value`: array element -- `index`: array index -- `arr`: array on which the method is invoked +- `value`: array element. +- `index`: array index. +- `arr`: array on which the method is invoked. To set the callback execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/blas/base/drotm-wasm/README.md b/lib/node_modules/@stdlib/blas/base/drotm-wasm/README.md index bda4dcbfb039..e2991dc4a44b 100644 --- a/lib/node_modules/@stdlib/blas/base/drotm-wasm/README.md +++ b/lib/node_modules/@stdlib/blas/base/drotm-wasm/README.md @@ -53,7 +53,7 @@ The function has the following parameters: - **strideX**: index increment for `x`. - **y**: input [`Float64Array`][@stdlib/array/float64]. - **strideY**: index increment for `y`. -- **param**: parameters for the modified Givens transformation +- **param**: parameters for the modified Givens transformation. The `N` and stride parameters determine how values in the strided arrays are accessed at runtime. For example, to apply a modified Givens plane rotation to every other element, diff --git a/lib/node_modules/@stdlib/blas/base/drotm/README.md b/lib/node_modules/@stdlib/blas/base/drotm/README.md index 1c3cbd622814..40e183f70ff2 100644 --- a/lib/node_modules/@stdlib/blas/base/drotm/README.md +++ b/lib/node_modules/@stdlib/blas/base/drotm/README.md @@ -53,7 +53,7 @@ The function has the following parameters: - **strideX**: index increment for `x`. - **y**: second input [`Float64Array`][mdn-float64array]. - **strideY**: index increment for `y`. -- **param**: parameters for the modified Givens transformation +- **param**: parameters for the modified Givens transformation. The `N` and stride parameters determine how values in the strided arrays are accessed at runtime. For example, to apply a modified Givens plane rotation to every other element, diff --git a/lib/node_modules/@stdlib/blas/base/sgemm/README.md b/lib/node_modules/@stdlib/blas/base/sgemm/README.md index e3356fcbab40..2f77a3779901 100644 --- a/lib/node_modules/@stdlib/blas/base/sgemm/README.md +++ b/lib/node_modules/@stdlib/blas/base/sgemm/README.md @@ -58,7 +58,7 @@ The function has the following parameters: - **lda**: stride of the first dimension of `A` (leading dimension of `A`). - **B**: second input matrix stored in linear memory as a [`Float32Array`][mdn-float32array]. - **ldb**: stride of the first dimension of `B` (leading dimension of `B`). -- **β**: scalar constant +- **β**: scalar constant. - **C**: third input matrix stored in linear memory as a [`Float32Array`][mdn-float32array]. - **ldc**: stride of the first dimension of `C` (leading dimension of `C`). diff --git a/lib/node_modules/@stdlib/blas/base/srotm/README.md b/lib/node_modules/@stdlib/blas/base/srotm/README.md index d5d0fbdf379d..5e1861198e23 100644 --- a/lib/node_modules/@stdlib/blas/base/srotm/README.md +++ b/lib/node_modules/@stdlib/blas/base/srotm/README.md @@ -53,7 +53,7 @@ The function has the following parameters: - **strideX**: index increment for `x`. - **y**: second input [`Float32Array`][mdn-float32array]. - **strideY**: index increment for `y`. -- **param**: parameters for the modified Givens transformation +- **param**: parameters for the modified Givens transformation. The `N` and stride parameters determine how values in the strided arrays are accessed at runtime. For example, to apply a modified Givens plane rotation to every other element, diff --git a/lib/node_modules/@stdlib/datasets/cmudict/README.md b/lib/node_modules/@stdlib/datasets/cmudict/README.md index 41ec9cef0417..b38873b220a2 100644 --- a/lib/node_modules/@stdlib/datasets/cmudict/README.md +++ b/lib/node_modules/@stdlib/datasets/cmudict/README.md @@ -58,10 +58,10 @@ The function accepts the following `options`: - **data**: dataset name. The following names are recognized: - - **dict**: the main pronouncing dictionary - - **phones**: manners of articulation for each sound - - **symbols**: complete list of ARPABET symbols used by the dictionary - - **vp**: verbal pronunciations of punctuation marks + - **dict**: the main pronouncing dictionary. + - **phones**: manners of articulation for each sound. + - **symbols**: complete list of ARPABET symbols used by the dictionary. + - **vp**: verbal pronunciations of punctuation marks. To only return the main pronouncing dictionary, set the `data` option to `dict`. diff --git a/lib/node_modules/@stdlib/iter/any-by/README.md b/lib/node_modules/@stdlib/iter/any-by/README.md index 47a1fc87d709..e00aab2ea4eb 100644 --- a/lib/node_modules/@stdlib/iter/any-by/README.md +++ b/lib/node_modules/@stdlib/iter/any-by/README.md @@ -72,8 +72,8 @@ var bool = iterAnyBy( array2iterator( [] ), predicate ); A `predicate` function is provided two arguments: -- **value**: iterated value -- **index**: iteration index (zero-based) +- **value**: iterated value. +- **index**: iteration index (zero-based). To set the execution context of the `predicate` function, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/iter/cuany-by/README.md b/lib/node_modules/@stdlib/iter/cuany-by/README.md index ee919bd1b56a..c99dba502bd0 100644 --- a/lib/node_modules/@stdlib/iter/cuany-by/README.md +++ b/lib/node_modules/@stdlib/iter/cuany-by/README.md @@ -81,8 +81,8 @@ The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the A `predicate` function is provided two arguments: -- **value**: iterated value -- **index**: iteration index (zero-based) +- **value**: iterated value. +- **index**: iteration index (zero-based). To set the `predicate` function execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/iter/cuevery-by/README.md b/lib/node_modules/@stdlib/iter/cuevery-by/README.md index d297ecb59de5..7f023b9cebec 100644 --- a/lib/node_modules/@stdlib/iter/cuevery-by/README.md +++ b/lib/node_modules/@stdlib/iter/cuevery-by/README.md @@ -81,8 +81,8 @@ The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the A `predicate` function is provided two arguments: -- **value**: iterated value -- **index**: iteration index (zero-based) +- **value**: iterated value. +- **index**: iteration index (zero-based). To set the `predicate` function execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/iter/cunone-by/README.md b/lib/node_modules/@stdlib/iter/cunone-by/README.md index 0083e9c90e87..b5370be834cb 100644 --- a/lib/node_modules/@stdlib/iter/cunone-by/README.md +++ b/lib/node_modules/@stdlib/iter/cunone-by/README.md @@ -81,8 +81,8 @@ The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the A `predicate` function is provided two arguments: -- **value**: iterated value -- **index**: iteration index (zero-based) +- **value**: iterated value. +- **index**: iteration index (zero-based). To set the `predicate` function execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/iter/cusome-by/README.md b/lib/node_modules/@stdlib/iter/cusome-by/README.md index 323c5aa9d9aa..8be0151c17a9 100644 --- a/lib/node_modules/@stdlib/iter/cusome-by/README.md +++ b/lib/node_modules/@stdlib/iter/cusome-by/README.md @@ -81,8 +81,8 @@ The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the A `predicate` function is provided two arguments: -- **value**: iterated value -- **index**: iteration index (zero-based) +- **value**: iterated value. +- **index**: iteration index (zero-based). To set the `predicate` function execution context, provide a `thisArg`. @@ -131,7 +131,7 @@ var count = ctx.count;
- + ## Notes - A `predicate` function is invoked for each iterated value until the `nth` truthy `predicate` function return value. The returned iterator continues iterating until it reaches the end of the input iterator, even after the condition is met. diff --git a/lib/node_modules/@stdlib/iter/do-until-each/README.md b/lib/node_modules/@stdlib/iter/do-until-each/README.md index 935c1f845d35..6725b01dfc00 100644 --- a/lib/node_modules/@stdlib/iter/do-until-each/README.md +++ b/lib/node_modules/@stdlib/iter/do-until-each/README.md @@ -79,8 +79,8 @@ The returned iterator protocol-compliant object has the following properties: Both the `predicate` function and the function to invoke for each iterated value are provided two arguments: -- **value**: iterated value -- **index**: iteration index (zero-based) +- **value**: iterated value. +- **index**: iteration index (zero-based). ```javascript var array2iterator = require( '@stdlib/array/to-iterator' ); diff --git a/lib/node_modules/@stdlib/iter/do-while-each/README.md b/lib/node_modules/@stdlib/iter/do-while-each/README.md index 6c0a7d178c96..413067b12975 100644 --- a/lib/node_modules/@stdlib/iter/do-while-each/README.md +++ b/lib/node_modules/@stdlib/iter/do-while-each/README.md @@ -80,8 +80,8 @@ The returned iterator protocol-compliant object has the following properties: Both the `predicate` function and the function to invoke for each iterated value are provided two arguments: -- **value**: iterated value -- **index**: iteration index (zero-based) +- **value**: iterated value. +- **index**: iteration index (zero-based). ```javascript var iterDoWhileEach = require( '@stdlib/iter/do-while-each' ); diff --git a/lib/node_modules/@stdlib/iter/every-by/README.md b/lib/node_modules/@stdlib/iter/every-by/README.md index 435d629d5a3e..8cf9e58ad804 100644 --- a/lib/node_modules/@stdlib/iter/every-by/README.md +++ b/lib/node_modules/@stdlib/iter/every-by/README.md @@ -72,8 +72,8 @@ var bool = iterEveryBy( array2iterator( [] ), predicate ); A `predicate` function is provided two arguments: -- **value**: iterated value -- **index**: iteration index (zero-based) +- **value**: iterated value. +- **index**: iteration index (zero-based). To set the execution context of the `predicate` function, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/iter/flow/README.md b/lib/node_modules/@stdlib/iter/flow/README.md index 92cf1e5621d9..0210b858d957 100644 --- a/lib/node_modules/@stdlib/iter/flow/README.md +++ b/lib/node_modules/@stdlib/iter/flow/README.md @@ -63,8 +63,8 @@ function iterFcn( iterator[, ...args] ) {...} where -- **iterator**: an [iterator][mdn-iterator-protocol] -- **...args**: additional [iterator][mdn-iterator-protocol] function arguments +- **iterator**: an [iterator][mdn-iterator-protocol]. +- **...args**: additional [iterator][mdn-iterator-protocol] function arguments. When a fluent interface [iterator][mdn-iterator-protocol] method is invoked, the method invokes the corresponding [iterator][mdn-iterator-protocol] function with an [iterator][mdn-iterator-protocol] and provided method arguments. diff --git a/lib/node_modules/@stdlib/iter/for-each/README.md b/lib/node_modules/@stdlib/iter/for-each/README.md index 00b73b26648a..48dae207c694 100644 --- a/lib/node_modules/@stdlib/iter/for-each/README.md +++ b/lib/node_modules/@stdlib/iter/for-each/README.md @@ -75,8 +75,8 @@ The returned iterator protocol-compliant object has the following properties: The invoked function is provided two arguments: -- **value**: iterated value -- **index**: iteration index (zero-based) +- **value**: iterated value. +- **index**: iteration index (zero-based). ```javascript var array2iterator = require( '@stdlib/array/to-iterator' ); diff --git a/lib/node_modules/@stdlib/iter/intersection-by-hash/README.md b/lib/node_modules/@stdlib/iter/intersection-by-hash/README.md index 38941ef050e2..39811284e368 100644 --- a/lib/node_modules/@stdlib/iter/intersection-by-hash/README.md +++ b/lib/node_modules/@stdlib/iter/intersection-by-hash/README.md @@ -71,7 +71,7 @@ The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the A hash function is provided one argument: -- **v**: the current iterated value +- **v**: the current iterated value. To set the execution context of the hash function, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/iter/mapn/README.md b/lib/node_modules/@stdlib/iter/mapn/README.md index b9083c6cf15d..b17aa50c9cd3 100644 --- a/lib/node_modules/@stdlib/iter/mapn/README.md +++ b/lib/node_modules/@stdlib/iter/mapn/README.md @@ -74,8 +74,8 @@ The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the The invoked `function` is provided `N+1` arguments, where `N` is the number of provided [iterators][mdn-iterator-protocol] and the last argument is the iteration index: -- `...value`: iterated values -- `index`: iteration index (zero-based) +- `...value`: iterated values. +- `index`: iteration index (zero-based). ```javascript var array2iterator = require( '@stdlib/array/to-iterator' ); diff --git a/lib/node_modules/@stdlib/iter/none-by/README.md b/lib/node_modules/@stdlib/iter/none-by/README.md index 316c49837810..31f1819887e4 100644 --- a/lib/node_modules/@stdlib/iter/none-by/README.md +++ b/lib/node_modules/@stdlib/iter/none-by/README.md @@ -72,8 +72,8 @@ var bool = iterNoneBy( array2iterator( [] ), predicate ); A `predicate` function is provided two arguments: -- **value**: iterated value -- **index**: iteration index (zero-based) +- **value**: iterated value. +- **index**: iteration index (zero-based). To set the execution context of the `predicate` function, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/iter/pipeline-thunk/README.md b/lib/node_modules/@stdlib/iter/pipeline-thunk/README.md index a7ee56479906..0cb5a7ea1a93 100644 --- a/lib/node_modules/@stdlib/iter/pipeline-thunk/README.md +++ b/lib/node_modules/@stdlib/iter/pipeline-thunk/README.md @@ -67,12 +67,12 @@ function iterFcn( iterator[, ...args] ) {...} where -- **iterator**: an [iterator][mdn-iterator-protocol] -- **...args**: additional [iterator][mdn-iterator-protocol] function arguments +- **iterator**: an [iterator][mdn-iterator-protocol]. +- **...args**: additional [iterator][mdn-iterator-protocol] function arguments. The returned function expects a single argument -- **iterator**: an [iterator][mdn-iterator-protocol] +- **iterator**: an [iterator][mdn-iterator-protocol]. and invokes `iterFcn` with the provided [iterator][mdn-iterator-protocol] and any previously provided `args`. diff --git a/lib/node_modules/@stdlib/iter/pop/README.md b/lib/node_modules/@stdlib/iter/pop/README.md index e0b4895581cb..0af9c3a5bde3 100644 --- a/lib/node_modules/@stdlib/iter/pop/README.md +++ b/lib/node_modules/@stdlib/iter/pop/README.md @@ -96,7 +96,7 @@ var bool = it.next().done; The callback function is provided a single argument: -- **v**: the skipped value +- **v**: the skipped value. To set the callback execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/iter/reject/README.md b/lib/node_modules/@stdlib/iter/reject/README.md index 128efd3c5b5c..a1522e292531 100644 --- a/lib/node_modules/@stdlib/iter/reject/README.md +++ b/lib/node_modules/@stdlib/iter/reject/README.md @@ -71,8 +71,8 @@ The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the The `predicate` function is provided two arguments: -- `value`: iterated value -- `index`: iteration index (zero-based) +- `value`: iterated value. +- `index`: iteration index (zero-based). ```javascript var array2iterator = require( '@stdlib/array/to-iterator' ); diff --git a/lib/node_modules/@stdlib/iter/replicate-by/README.md b/lib/node_modules/@stdlib/iter/replicate-by/README.md index 7520f24774e0..75ddc2e84d7e 100644 --- a/lib/node_modules/@stdlib/iter/replicate-by/README.md +++ b/lib/node_modules/@stdlib/iter/replicate-by/README.md @@ -85,9 +85,9 @@ The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the The callback function is provided three arguments: -- **value**: iterated value -- **index**: source iteration index (zero-based) -- **n**: iteration index (zero-based) +- **value**: iterated value. +- **index**: source iteration index (zero-based). +- **n**: iteration index (zero-based). To set the callback execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/iter/shift/README.md b/lib/node_modules/@stdlib/iter/shift/README.md index b0b0dc4b8ddb..b48c77bc08a7 100644 --- a/lib/node_modules/@stdlib/iter/shift/README.md +++ b/lib/node_modules/@stdlib/iter/shift/README.md @@ -96,7 +96,7 @@ var bool = it.next().done; The callback function is provided a single argument: -- **v**: the skipped value +- **v**: the skipped value. To set the callback execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/iter/some-by/README.md b/lib/node_modules/@stdlib/iter/some-by/README.md index 27805a61cc9f..2f7c01665639 100644 --- a/lib/node_modules/@stdlib/iter/some-by/README.md +++ b/lib/node_modules/@stdlib/iter/some-by/README.md @@ -72,8 +72,8 @@ var bool = iterSomeBy( array2iterator( [] ), 1, predicate ); A `predicate` function is provided two arguments: -- **value**: iterated value -- **index**: iteration index (zero-based) +- **value**: iterated value. +- **index**: iteration index (zero-based). To set the execution context of the `predicate` function, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/iter/strided-by/README.md b/lib/node_modules/@stdlib/iter/strided-by/README.md index ff989d86573c..1b6990cf0f60 100644 --- a/lib/node_modules/@stdlib/iter/strided-by/README.md +++ b/lib/node_modules/@stdlib/iter/strided-by/README.md @@ -74,10 +74,10 @@ The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the The callback function is provided four arguments: -- **value**: iterated value -- **i**: source iteration index (zero-based) -- **n**: iteration index (zero-based) -- **curr**: current stride +- **value**: iterated value. +- **i**: source iteration index (zero-based). +- **n**: iteration index (zero-based). +- **curr**: current stride. To set the callback execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/iter/unique-by-hash/README.md b/lib/node_modules/@stdlib/iter/unique-by-hash/README.md index f454d558460e..1fd68d1c46c3 100644 --- a/lib/node_modules/@stdlib/iter/unique-by-hash/README.md +++ b/lib/node_modules/@stdlib/iter/unique-by-hash/README.md @@ -79,7 +79,7 @@ The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the A hash function is provided one argument: -- **v**: the current iterated value +- **v**: the current iterated value. To set the execution context of the hash function, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/iter/unique-by/README.md b/lib/node_modules/@stdlib/iter/unique-by/README.md index 5f3f273a6e74..27481e3f8218 100644 --- a/lib/node_modules/@stdlib/iter/unique-by/README.md +++ b/lib/node_modules/@stdlib/iter/unique-by/README.md @@ -79,8 +79,8 @@ The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the A `predicate` function is provided two arguments: -- **a**: a previously identified unique value -- **b**: the value whose uniqueness is being determined +- **a**: a previously identified unique value. +- **b**: the value whose uniqueness is being determined. To set the execution context of the `predicate` function, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/iter/until-each/README.md b/lib/node_modules/@stdlib/iter/until-each/README.md index 34359e1ef4c4..ac20fdd4d579 100644 --- a/lib/node_modules/@stdlib/iter/until-each/README.md +++ b/lib/node_modules/@stdlib/iter/until-each/README.md @@ -79,8 +79,8 @@ The returned iterator protocol-compliant object has the following properties: Both the `predicate` function and the function to invoke for each iterated value are provided two arguments: -- **value**: iterated value -- **index**: iteration index (zero-based) +- **value**: iterated value. +- **index**: iteration index (zero-based). ```javascript var array2iterator = require( '@stdlib/array/to-iterator' ); diff --git a/lib/node_modules/@stdlib/iter/while-each/README.md b/lib/node_modules/@stdlib/iter/while-each/README.md index 485998c40c77..a6112c55bdca 100644 --- a/lib/node_modules/@stdlib/iter/while-each/README.md +++ b/lib/node_modules/@stdlib/iter/while-each/README.md @@ -79,8 +79,8 @@ The returned iterator protocol-compliant object has the following properties: Both the `predicate` function and the function to invoke for each iterated value are provided two arguments: -- **value**: iterated value -- **index**: iteration index (zero-based) +- **value**: iterated value. +- **index**: iteration index (zero-based). ```javascript var array2iterator = require( '@stdlib/array/to-iterator' ); diff --git a/lib/node_modules/@stdlib/lapack/base/dlassq/README.md b/lib/node_modules/@stdlib/lapack/base/dlassq/README.md index 39de9f0e3ab3..61f9d535024d 100644 --- a/lib/node_modules/@stdlib/lapack/base/dlassq/README.md +++ b/lib/node_modules/@stdlib/lapack/base/dlassq/README.md @@ -107,7 +107,7 @@ dlassq.ndarray( 4, X, 1, 0, 1.0, 0.0, out, 1, 0 ); The function has the following additional parameters: - **ox**: starting index for `X`. -- **out**: output [`Float64Array`][mdn-float64array] +- **out**: output [`Float64Array`][mdn-float64array]. - **so**: stride length for `out`. - **oo**: starting index for `out`. diff --git a/lib/node_modules/@stdlib/math/base/special/atan2/README.md b/lib/node_modules/@stdlib/math/base/special/atan2/README.md index 8fbe8f342903..7d29251abe08 100755 --- a/lib/node_modules/@stdlib/math/base/special/atan2/README.md +++ b/lib/node_modules/@stdlib/math/base/special/atan2/README.md @@ -117,7 +117,7 @@ for ( i = 0; i < 100; i++ ) { Computes the angle in the plane (in radians) between the positive x-axis and the ray from `(0,0)` to the point `(x,y)`. ```c -double out = stdlib_base_atan2( 2.0, 2.0 ); +double out = stdlib_base_atan2( 2.0, 2.0 ); // returns ~0.785 out = stdlib_base_atan2( 6.0, 2.0 ); @@ -126,8 +126,8 @@ out = stdlib_base_atan2( 6.0, 2.0 ); The function accepts the following arguments: -- **y**: `[in] double` - `y` coordinate -- **x**: `[in] double` - `x` coordinate +- **y**: `[in] double` - `y` coordinate. +- **x**: `[in] double` - `x` coordinate. ```c double stdlib_base_atan2( const double y, const double x ); diff --git a/lib/node_modules/@stdlib/math/iter/tools/map/README.md b/lib/node_modules/@stdlib/math/iter/tools/map/README.md index da591e1928d1..20b9c3d033e8 100644 --- a/lib/node_modules/@stdlib/math/iter/tools/map/README.md +++ b/lib/node_modules/@stdlib/math/iter/tools/map/README.md @@ -70,7 +70,7 @@ The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the The invoked `function` is provided one argument: -- `value`: iterated value +- `value`: iterated value. ```javascript var array2iterator = require( '@stdlib/array/to-iterator' ); diff --git a/lib/node_modules/@stdlib/plot/components/svg/rug/README.md b/lib/node_modules/@stdlib/plot/components/svg/rug/README.md index 88adfdb93117..7f0ff357befd 100644 --- a/lib/node_modules/@stdlib/plot/components/svg/rug/README.md +++ b/lib/node_modules/@stdlib/plot/components/svg/rug/README.md @@ -146,8 +146,8 @@ var data = node.data; **Writable** property whose value is a predicate `function` which indicates whether a datum is defined and thus determines how missing values are encoded. When invoked, the function is provided two arguments: -- **d**: datum -- **i**: datum index +- **d**: datum. +- **i**: datum index. ```javascript function isDefined( d ) { @@ -181,8 +181,8 @@ var label = node.label; When retrieved, the returned value is always an accessor which accepts two parameters: -- **d**: datum -- **i**: datum index +- **d**: datum. +- **i**: datum index. @@ -201,8 +201,8 @@ var opacity = node.opacity; When retrieved, the returned value is always an accessor which accepts two parameters: -- **d**: datum -- **i**: datum index +- **d**: datum. +- **i**: datum index. diff --git a/lib/node_modules/@stdlib/plot/sparklines/base/ctor/README.md b/lib/node_modules/@stdlib/plot/sparklines/base/ctor/README.md index adcd9d3caef6..0572a3a7e2ec 100644 --- a/lib/node_modules/@stdlib/plot/sparklines/base/ctor/README.md +++ b/lib/node_modules/@stdlib/plot/sparklines/base/ctor/README.md @@ -142,8 +142,8 @@ var desc = sparkline.description; An accessor `function` which defines whether a datum is defined. This accessor is used to define how missing values are encoded. When invoked, the function is provided two arguments: -- **d**: datum -- **i**: datum index +- **d**: datum. +- **i**: datum index. ```javascript function isDefined( d ) { diff --git a/lib/node_modules/@stdlib/plot/sparklines/unicode/README.md b/lib/node_modules/@stdlib/plot/sparklines/unicode/README.md index f65b1ecff270..a4b80f0cd20f 100644 --- a/lib/node_modules/@stdlib/plot/sparklines/unicode/README.md +++ b/lib/node_modules/@stdlib/plot/sparklines/unicode/README.md @@ -170,8 +170,8 @@ var str = chart.render(); An accessor `function` which defines whether a datum is defined. This accessor is used to define how missing values are encoded. When invoked, the function is provided two arguments: -- **d**: datum -- **i**: datum index +- **d**: datum. +- **i**: datum index. ```javascript function isDefined( d ) { diff --git a/lib/node_modules/@stdlib/plot/sparklines/unicode/column/README.md b/lib/node_modules/@stdlib/plot/sparklines/unicode/column/README.md index fe23713e9ade..254ae0d28a49 100644 --- a/lib/node_modules/@stdlib/plot/sparklines/unicode/column/README.md +++ b/lib/node_modules/@stdlib/plot/sparklines/unicode/column/README.md @@ -169,8 +169,8 @@ var str = chart.render(); An accessor `function` which defines whether a datum is defined. This accessor is used to define how missing values are encoded. When invoked, the function is provided two arguments: -- **d**: datum -- **i**: datum index +- **d**: datum. +- **i**: datum index. ```javascript function isDefined( d ) { diff --git a/lib/node_modules/@stdlib/plot/sparklines/unicode/line/README.md b/lib/node_modules/@stdlib/plot/sparklines/unicode/line/README.md index bf476f0dd54f..438bea1c5e90 100644 --- a/lib/node_modules/@stdlib/plot/sparklines/unicode/line/README.md +++ b/lib/node_modules/@stdlib/plot/sparklines/unicode/line/README.md @@ -169,8 +169,8 @@ var str = chart.render(); An accessor `function` which defines whether a datum is defined. This accessor is used to define how missing values are encoded. When invoked, the function is provided two arguments: -- **d**: datum -- **i**: datum index +- **d**: datum. +- **i**: datum index. ```javascript function isDefined( d ) { diff --git a/lib/node_modules/@stdlib/plot/sparklines/unicode/tristate/README.md b/lib/node_modules/@stdlib/plot/sparklines/unicode/tristate/README.md index 3948886a9072..1e2b9c56f362 100644 --- a/lib/node_modules/@stdlib/plot/sparklines/unicode/tristate/README.md +++ b/lib/node_modules/@stdlib/plot/sparklines/unicode/tristate/README.md @@ -141,8 +141,8 @@ var desc = chart.description; An accessor `function` which defines whether a datum is defined. This accessor is used to define how missing values are encoded. When invoked, the function is provided two arguments: -- **d**: datum -- **i**: datum index +- **d**: datum. +- **i**: datum index. ```javascript function isDefined( d ) { diff --git a/lib/node_modules/@stdlib/plot/sparklines/unicode/up-down/README.md b/lib/node_modules/@stdlib/plot/sparklines/unicode/up-down/README.md index e64cc41bf3f7..73cf4fd22a93 100644 --- a/lib/node_modules/@stdlib/plot/sparklines/unicode/up-down/README.md +++ b/lib/node_modules/@stdlib/plot/sparklines/unicode/up-down/README.md @@ -141,8 +141,8 @@ var desc = chart.description; An accessor `function` which defines whether a datum is defined. This accessor is used to define how missing values are encoded. When invoked, the function is provided two arguments: -- **d**: datum -- **i**: datum index +- **d**: datum. +- **i**: datum index. ```javascript function isDefined( d ) { diff --git a/lib/node_modules/@stdlib/plot/sparklines/unicode/win-loss/README.md b/lib/node_modules/@stdlib/plot/sparklines/unicode/win-loss/README.md index d4e8792eaff0..569efc9ff25c 100644 --- a/lib/node_modules/@stdlib/plot/sparklines/unicode/win-loss/README.md +++ b/lib/node_modules/@stdlib/plot/sparklines/unicode/win-loss/README.md @@ -141,8 +141,8 @@ var desc = chart.description; An accessor `function` which defines whether a datum is defined. This accessor is used to define how missing values are encoded. When invoked, the function is provided two arguments: -- **d**: datum -- **i**: datum index +- **d**: datum. +- **i**: datum index. ```javascript function isDefined( d ) { diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/entropy/README.md b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/entropy/README.md index 74def01cf3a5..d9dd2457df50 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/entropy/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/entropy/README.md @@ -167,7 +167,7 @@ double out = stdlib_base_dists_bernoulli_entropy( 0.1 ); The function accepts the following arguments: -- **p**: `[in] double` success probability +- **p**: `[in] double` success probability. ```c double stdlib_base_dists_bernoulli_entropy( const double p ); diff --git a/lib/node_modules/@stdlib/utils/async/do-until/README.md b/lib/node_modules/@stdlib/utils/async/do-until/README.md index f2ed58ba3e2f..f60a1c9d3c1a 100644 --- a/lib/node_modules/@stdlib/utils/async/do-until/README.md +++ b/lib/node_modules/@stdlib/utils/async/do-until/README.md @@ -75,18 +75,18 @@ doUntilAsync( fcn, predicate, done ); The function to invoke is provided two arguments: -- `i`: iteration number (starting from zero) -- `next`: a callback which must be invoked before proceeding to the next iteration +- `i`: iteration number (starting from zero). +- `next`: a callback which must be invoked before proceeding to the next iteration. The `predicate` function is provided two arguments: -- `i`: iteration number (starting from one) -- `clbk`: a callback indicating whether to invoke `fcn` +- `i`: iteration number (starting from one). +- `clbk`: a callback indicating whether to invoke `fcn`. The `clbk` function accepts two arguments: -- `error`: error object -- `bool`: test result +- `error`: error object. +- `bool`: test result. If the test result is falsy, the function continues invoking `fcn`; otherwise, the function invokes the `done` callback. diff --git a/lib/node_modules/@stdlib/utils/async/do-while/README.md b/lib/node_modules/@stdlib/utils/async/do-while/README.md index afe2f42c6264..825a51e6fb7d 100644 --- a/lib/node_modules/@stdlib/utils/async/do-while/README.md +++ b/lib/node_modules/@stdlib/utils/async/do-while/README.md @@ -75,18 +75,18 @@ doWhileAsync( fcn, predicate, done ); The function to invoke is provided two arguments: -- `i`: iteration number (starting from zero) -- `next`: a callback which must be invoked before proceeding to the next iteration +- `i`: iteration number (starting from zero). +- `next`: a callback which must be invoked before proceeding to the next iteration. The `predicate` function is provided two arguments: -- `i`: iteration number (starting from one) -- `clbk`: a callback indicating whether to invoke `fcn` +- `i`: iteration number (starting from one). +- `clbk`: a callback indicating whether to invoke `fcn`. The `clbk` function accepts two arguments: -- `error`: error object -- `bool`: test result +- `error`: error object. +- `bool`: test result. If the test result is truthy, the function continues invoking `fcn`; otherwise, the function invokes the `done` callback. diff --git a/lib/node_modules/@stdlib/utils/async/if-else/README.md b/lib/node_modules/@stdlib/utils/async/if-else/README.md index 691883ac23c1..38e660477f53 100644 --- a/lib/node_modules/@stdlib/utils/async/if-else/README.md +++ b/lib/node_modules/@stdlib/utils/async/if-else/README.md @@ -66,17 +66,17 @@ ifelseAsync( predicate, 1.0, -1.0, done ); The `predicate` function is provided a single argument: -- `clbk`: callback to invoke upon `predicate` function completion +- `clbk`: callback to invoke upon `predicate` function completion. The callback accepts two arguments: -- `error`: error object -- `bool`: condition used to determine whether to return `x` or `y` +- `error`: error object. +- `bool`: condition used to determine whether to return `x` or `y`. The `done` callback is invoked upon function completion and is provided at most two arguments: -- `error`: error object -- `result`: either `x` or `y` +- `error`: error object. +- `result`: either `x` or `y`.
diff --git a/lib/node_modules/@stdlib/utils/async/if-then/README.md b/lib/node_modules/@stdlib/utils/async/if-then/README.md index e0a78a700e26..fa7a0202f9d0 100644 --- a/lib/node_modules/@stdlib/utils/async/if-then/README.md +++ b/lib/node_modules/@stdlib/utils/async/if-then/README.md @@ -80,16 +80,16 @@ ifthenAsync( predicate, x, y, done ); The `predicate` function is provided a single argument: -- `clbk`: callback to invoke upon `predicate` function completion +- `clbk`: callback to invoke upon `predicate` function completion. The callback accepts two arguments: -- `error`: error object -- `bool`: condition used to determine whether to invoke `x` or `y` +- `error`: error object. +- `bool`: condition used to determine whether to invoke `x` or `y`. Both `x` and `y` are provided a single argument: -- `clbk`: callback to invoke upon function completion +- `clbk`: callback to invoke upon function completion. The callback function accepts any number of arguments, with the first argument reserved for providing an error. If the error argument is falsy, the `done` callback is invoked with its first argument as `null` and all other provided arguments. If the error argument is truthy, the `done` callback is invoked with only an error argument. diff --git a/lib/node_modules/@stdlib/utils/async/map-function/README.md b/lib/node_modules/@stdlib/utils/async/map-function/README.md index b5674a6d1129..79c89f9a1a8d 100644 --- a/lib/node_modules/@stdlib/utils/async/map-function/README.md +++ b/lib/node_modules/@stdlib/utils/async/map-function/README.md @@ -74,13 +74,13 @@ mapFunAsync( fcn, 5, done ); For each iteration, the provided function is invoked with two arguments: -- `index`: invocation index (starting from zero) -- `next`: callback to be invoked upon function completion +- `index`: invocation index (starting from zero). +- `next`: callback to be invoked upon function completion. The `next` callback accepts two arguments: -- `error`: error argument -- `result`: function result +- `error`: error argument. +- `result`: function result. The function accepts the following `options`: diff --git a/lib/node_modules/@stdlib/utils/async/try-catch/README.md b/lib/node_modules/@stdlib/utils/async/try-catch/README.md index 33811b69543a..0dd0f6ffbfef 100644 --- a/lib/node_modules/@stdlib/utils/async/try-catch/README.md +++ b/lib/node_modules/@stdlib/utils/async/try-catch/README.md @@ -69,17 +69,17 @@ trycatchAsync( x, -1.0, done ); The function `x` is provided a single argument: -- `clbk`: callback to invoke upon function completion +- `clbk`: callback to invoke upon function completion. The callback accepts two arguments: -- `error`: error object -- `result`: function result +- `error`: error object. +- `result`: function result. The `done` callback is invoked upon function completion and is provided two arguments: -- `error`: error object -- `result`: either the result of `x` or the provided value `y` +- `error`: error object. +- `result`: either the result of `x` or the provided value `y`. If the function `x` does not return a truthy `error` argument, the `error` argument provided to the `done` callback is `null`. If `x` does return a truthy `error` argument, the `done` callback is invoked with both the `error` and the provided value `y`. diff --git a/lib/node_modules/@stdlib/utils/async/try-then/README.md b/lib/node_modules/@stdlib/utils/async/try-then/README.md index 5da2886ecc5e..1fab8a48f1a7 100644 --- a/lib/node_modules/@stdlib/utils/async/try-then/README.md +++ b/lib/node_modules/@stdlib/utils/async/try-then/README.md @@ -76,7 +76,7 @@ trythenAsync( x, y, done ); The function `x` is provided a single argument: -- `clbk`: callback to invoke upon function completion +- `clbk`: callback to invoke upon function completion. The callback function accepts any number of arguments, with the first argument reserved for providing an error. If the error argument is falsy, the `done` callback is invoked with its first argument as `null` and all other provided arguments. @@ -109,12 +109,12 @@ trythenAsync( x, y, done ); If the error argument is truthy, the function invokes `y`. The number of arguments provided to `y` depends on the function's `length`. If `y` is a unary function, `y` is provided a single argument: -- `clbk`: callback to invoke upon function completion +- `clbk`: callback to invoke upon function completion. Otherwise, `y` is provided two arguments: -- `error`: the error from `x` -- `clbk`: callback to invoke upon function completion +- `error`: the error from `x`. +- `clbk`: callback to invoke upon function completion. The callback function accepts any number of arguments, with the first argument reserved for providing an error. If the error argument is falsy, the `done` callback is invoked with its first argument equal to `null` and all other provided arguments. If the error argument is truthy, the `done` callback is invoked with only the error argument provided by `y`. diff --git a/lib/node_modules/@stdlib/utils/async/until/README.md b/lib/node_modules/@stdlib/utils/async/until/README.md index 3cbc2b2890fb..92dd43b87435 100644 --- a/lib/node_modules/@stdlib/utils/async/until/README.md +++ b/lib/node_modules/@stdlib/utils/async/until/README.md @@ -75,20 +75,20 @@ untilAsync( predicate, fcn, done ); The `predicate` function is provided two arguments: -- `i`: iteration number (starting from zero) -- `clbk`: a callback indicating whether to invoke `fcn` +- `i`: iteration number (starting from zero). +- `clbk`: a callback indicating whether to invoke `fcn`. The `clbk` function accepts two arguments: -- `error`: error object -- `bool`: test result +- `error`: error object. +- `bool`: test result. If the test result is falsy, the function invokes `fcn`; otherwise, the function invokes the `done` callback. The function to invoke is provided two arguments: -- `i`: iteration number (starting from zero) -- `next`: a callback which must be invoked before proceeding to the next iteration +- `i`: iteration number (starting from zero). +- `next`: a callback which must be invoked before proceeding to the next iteration. The first argument of both `clbk` and `next` is an `error` argument. If either function is called with a truthy `error` argument, the function suspends execution and immediately calls the `done` callback for subsequent `error` handling. diff --git a/lib/node_modules/@stdlib/utils/async/while/README.md b/lib/node_modules/@stdlib/utils/async/while/README.md index 1546fa2a4a24..430daeca35f7 100644 --- a/lib/node_modules/@stdlib/utils/async/while/README.md +++ b/lib/node_modules/@stdlib/utils/async/while/README.md @@ -75,20 +75,20 @@ whileAsync( predicate, fcn, done ); The `predicate` function is provided two arguments: -- `i`: iteration number (starting from zero) -- `clbk`: a callback indicating whether to invoke `fcn` +- `i`: iteration number (starting from zero). +- `clbk`: a callback indicating whether to invoke `fcn`. The `clbk` function accepts two arguments: -- `error`: error object -- `bool`: test result +- `error`: error object. +- `bool`: test result. If the test result is truthy, the function invokes `fcn`; otherwise, the function invokes the `done` callback. The function to invoke is provided two arguments: -- `i`: iteration number (starting from zero) -- `next`: a callback which must be invoked before proceeding to the next iteration +- `i`: iteration number (starting from zero). +- `next`: a callback which must be invoked before proceeding to the next iteration. The first argument of both `clbk` and `next` is an `error` argument. If either function is called with a truthy `error` argument, the function suspends execution and immediately calls the `done` callback for subsequent `error` handling. diff --git a/lib/node_modules/@stdlib/utils/find/README.md b/lib/node_modules/@stdlib/utils/find/README.md index 6fb2193e8f86..34e2e4cedf36 100644 --- a/lib/node_modules/@stdlib/utils/find/README.md +++ b/lib/node_modules/@stdlib/utils/find/README.md @@ -46,9 +46,9 @@ Finds elements in an array-like object that satisfy a test condition. The functi The `callback` is provided three arguments: -- **element**: the current element -- **index**: the current element's index -- **array**: the input `array`, `typed array` or `string` +- **element**: the current element. +- **index**: the current element's index. +- **array**: the input `array`, `typed array` or `string`. By default, `k` is the length of `arr` and `returns` is set to `indices`. diff --git a/lib/node_modules/@stdlib/utils/named-typed-tuple/README.md b/lib/node_modules/@stdlib/utils/named-typed-tuple/README.md index a9f5da79213e..def89e74f434 100644 --- a/lib/node_modules/@stdlib/utils/named-typed-tuple/README.md +++ b/lib/node_modules/@stdlib/utils/named-typed-tuple/README.md @@ -357,9 +357,9 @@ y = tuple[ 1 ]; A callback function is provided three arguments: -- `value`: source value -- `index`: source index -- `field`: tuple field +- `value`: source value. +- `index`: source index. +- `field`: tuple field. To set the callback execution context, provide a `thisArg`. @@ -441,8 +441,8 @@ y = tuple[ 1 ]; A callback function is provided two arguments: -- `value`: source object tuple field value -- `field`: source object tuple field name +- `value`: source object tuple field value. +- `field`: source object tuple field name. To set the callback execution context, provide a `thisArg`. @@ -764,10 +764,10 @@ var bool = tuple.every( predicate ); A `predicate` function is provided four arguments: -- `value`: tuple element -- `index`: tuple index -- `field`: tuple field name -- `tuple`: tuple on which the method is invoked +- `value`: tuple element. +- `index`: tuple index. +- `field`: tuple field name. +- `tuple`: tuple on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -928,10 +928,10 @@ var p2 = p1.filter( predicate ); A `predicate` function is provided four arguments: -- `value`: tuple element -- `index`: tuple index -- `field`: tuple field name -- `tuple`: tuple on which the method is invoked +- `value`: tuple element. +- `index`: tuple index. +- `field`: tuple field name. +- `tuple`: tuple on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -991,10 +991,10 @@ var v = tuple.find( predicate ); A `predicate` function is provided four arguments: -- `value`: tuple element -- `index`: tuple index -- `field`: tuple field name -- `tuple`: tuple on which the method is invoked +- `value`: tuple element. +- `index`: tuple index. +- `field`: tuple field name. +- `tuple`: tuple on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -1055,10 +1055,10 @@ var field = tuple.findField( predicate ); A `predicate` function is provided four arguments: -- `value`: tuple element -- `index`: tuple index -- `field`: tuple field name -- `tuple`: tuple on which the method is invoked +- `value`: tuple element. +- `index`: tuple index. +- `field`: tuple field name. +- `tuple`: tuple on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -1119,10 +1119,10 @@ var idx = tuple.findIndex( predicate ); A `predicate` function is provided four arguments: -- `value`: tuple element -- `index`: tuple index -- `field`: tuple field name -- `tuple`: tuple on which the method is invoked +- `value`: tuple element. +- `index`: tuple index. +- `field`: tuple field name. +- `tuple`: tuple on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -1175,10 +1175,10 @@ console.log( str ); The callback is provided four arguments: -- `value`: tuple element -- `index`: tuple index -- `field`: tuple field name -- `tuple`: tuple on which the method is invoked +- `value`: tuple element. +- `index`: tuple index. +- `field`: tuple field name. +- `tuple`: tuple on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -1496,10 +1496,10 @@ var z = p2.z; A callback is provided four arguments: -- `value`: tuple element -- `index`: tuple index -- `field`: tuple field name -- `tuple`: tuple on which the method is invoked +- `value`: tuple element. +- `index`: tuple index. +- `field`: tuple field name. +- `tuple`: tuple on which the method is invoked. To set the callback execution context, provide a `thisArg`. @@ -1561,11 +1561,11 @@ var v = tuple.reduce( fcn, 0.0 ); A callback is provided five arguments: -- `acc`: accumulated result -- `value`: tuple element -- `index`: tuple index -- `field`: tuple field name -- `tuple`: tuple on which the method is invoked +- `acc`: accumulated result. +- `value`: tuple element. +- `index`: tuple index. +- `field`: tuple field name. +- `tuple`: tuple on which the method is invoked. @@ -1605,11 +1605,11 @@ var v = tuple.reduceRight( fcn, 0.0 ); A callback is provided five arguments: -- `acc`: accumulated result -- `value`: tuple element -- `index`: tuple index -- `field`: tuple field name -- `tuple`: tuple on which the method is invoked +- `acc`: accumulated result. +- `value`: tuple element. +- `index`: tuple index. +- `field`: tuple field name. +- `tuple`: tuple on which the method is invoked. @@ -1819,10 +1819,10 @@ var bool = tuple.some( predicate ); A `predicate` function is provided four arguments: -- `value`: tuple element -- `index`: tuple index -- `field`: tuple field name -- `tuple`: tuple on which the method is invoked +- `value`: tuple element. +- `index`: tuple index. +- `field`: tuple field name. +- `tuple`: tuple on which the method is invoked. To set the callback execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/utils/tabulate-by/README.md b/lib/node_modules/@stdlib/utils/tabulate-by/README.md index d1a323f586df..c2c631708a8b 100644 --- a/lib/node_modules/@stdlib/utils/tabulate-by/README.md +++ b/lib/node_modules/@stdlib/utils/tabulate-by/README.md @@ -56,8 +56,8 @@ var out = tabulateBy( arr, indicator ); An `indicator` function is provided two arguments: -- `value`: collection element -- `index`: collection index +- `value`: collection element. +- `index`: collection index. ```javascript function indicator( v, i ) { @@ -98,9 +98,9 @@ console.log( context.count ); The returned frequency table is an `array` of `arrays`. Each sub-array corresponds to a unique value in the input `collection` and is structured as follows: -- `0`: unique value -- `1`: value count -- `2`: frequency percentage +- `0`: unique value. +- `1`: value count. +- `2`: frequency percentage. diff --git a/lib/node_modules/@stdlib/utils/tabulate/README.md b/lib/node_modules/@stdlib/utils/tabulate/README.md index a0575dbbe87a..d80694ded1cb 100644 --- a/lib/node_modules/@stdlib/utils/tabulate/README.md +++ b/lib/node_modules/@stdlib/utils/tabulate/README.md @@ -53,9 +53,9 @@ var out = tabulate( arr ); The returned frequency table is an `array` of `arrays`. Each sub-array corresponds to a unique value in the input `collection` and is structured as follows: -- `0`: unique value -- `1`: value count -- `2`: frequency percentage +- `0`: unique value. +- `1`: value count. +- `2`: frequency percentage. diff --git a/lib/node_modules/@stdlib/utils/until-each-right/README.md b/lib/node_modules/@stdlib/utils/until-each-right/README.md index 1e476a11e229..541082f24efa 100644 --- a/lib/node_modules/@stdlib/utils/until-each-right/README.md +++ b/lib/node_modules/@stdlib/utils/until-each-right/README.md @@ -65,9 +65,9 @@ untilEachRight( arr, predicate, log ); Both the `predicate` function and the `function` to apply are provided three arguments: -- `value`: collection element -- `index`: collection index -- `collection`: input collection +- `value`: collection element. +- `index`: collection index. +- `collection`: input collection. Basic support for dynamic collections is provided. Note, however, that index incrementation is **not** guaranteed to be monotonically **decreasing**. diff --git a/lib/node_modules/@stdlib/utils/while-each-right/README.md b/lib/node_modules/@stdlib/utils/while-each-right/README.md index a76f920b4be3..37a30a499f83 100644 --- a/lib/node_modules/@stdlib/utils/while-each-right/README.md +++ b/lib/node_modules/@stdlib/utils/while-each-right/README.md @@ -65,9 +65,9 @@ whileEachRight( arr, predicate, log ); Both the `predicate` function and the `function` to apply are provided three arguments: -- `value`: collection element -- `index`: collection index -- `collection`: input collection +- `value`: collection element. +- `index`: collection index. +- `collection`: input collection. Basic support for dynamic collections is provided. Note, however, that index incrementation is **not** guaranteed to be monotonically **decreasing**.