From 3538849f44d2f9d29792793b0b169b3ce989ac29 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 21 Nov 2024 03:11:01 +0000 Subject: [PATCH] Auto-generated commit --- CHANGELOG.md | 3 ++- README.md | 21 +++++++++++++++++++++ base/README.md | 3 +++ base/assert/README.md | 9 +++++++++ 4 files changed, 35 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7bd5ebfa..5f31828b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,7 @@
-## Unreleased (2024-11-20) +## Unreleased (2024-11-21)
@@ -195,6 +195,7 @@ A total of 3 people contributed to this release. Thank you to the following cont
+- [`b6a2b0b`](https://github.com/stdlib-js/stdlib/commit/b6a2b0b27dc8cc1e9fc02d9679a3ce468cf49b9d) - **docs:** update namespace table of contents [(#3192)](https://github.com/stdlib-js/stdlib/pull/3192) _(by stdlib-bot, Philipp Burckhardt)_ - [`8b1548f`](https://github.com/stdlib-js/stdlib/commit/8b1548fb45c1ff131f5edac20cb984344a2d28ec) - **feat:** update namespace TypeScript declarations [(#3190)](https://github.com/stdlib-js/stdlib/pull/3190) _(by stdlib-bot, Philipp Burckhardt)_ - [`b34732c`](https://github.com/stdlib-js/stdlib/commit/b34732cf655db60fbc798e12952f88c3edb07eaf) - **feat:** add `at` method to `array/fixed-endian-factory` [(#3184)](https://github.com/stdlib-js/stdlib/pull/3184) _(by Aayush Khanna, Athan Reines)_ - [`956a462`](https://github.com/stdlib-js/stdlib/commit/956a4624c788689b1bca285856b987ea3aa32eb6) - **feat:** add `forEach` method _(by Athan Reines)_ diff --git a/README.md b/README.md index 946e2703..81377c9e 100644 --- a/README.md +++ b/README.md @@ -191,6 +191,7 @@ Lastly, the namespace contains various other functions for dealing with arrays, - [`base`][@stdlib/array/base]: base (i.e., lower-level) array utilities. - [`BooleanArray()`][@stdlib/array/bool]: boolean array. +- [`byteOrders()`][@stdlib/array/byte-orders]: list of byte orders. - [`cartesianPower( x, n )`][@stdlib/array/cartesian-power]: return the Cartesian power. - [`cartesianProduct( x1, x2 )`][@stdlib/array/cartesian-product]: return the Cartesian product. - [`cartesianSquare( x )`][@stdlib/array/cartesian-square]: return the Cartesian square. @@ -205,10 +206,16 @@ Lastly, the namespace contains various other functions for dealing with arrays, - [`empty( length[, dtype] )`][@stdlib/array/empty]: create an uninitialized array having a specified length. - [`filledBy()`][@stdlib/array/filled-by]: create a filled array according to a provided callback function. - [`filled()`][@stdlib/array/filled]: create a filled array. +- [`fixedEndianFactory( dtype )`][@stdlib/array/fixed-endian-factory]: return a typed array constructor for creating typed arrays having a specified byte order. +- [`Float32ArrayFE()`][@stdlib/array/fixed-endian-float32]: typed array constructor which returns a typed array representing an array of single-precision floating-point numbers in a specified byte order. +- [`Float64ArrayFE()`][@stdlib/array/fixed-endian-float64]: typed array constructor which returns a typed array representing an array of double-precision floating-point numbers in a specified byte order. - [`iterator2array( iterator[, out][, mapFcn[, thisArg]] )`][@stdlib/array/from-iterator]: create (or fill) an array from an iterator. - [`scalar2array( value[, dtype] )`][@stdlib/array/from-scalar]: create a single-element array containing a provided scalar value. - [`fullLike( x, value[, dtype] )`][@stdlib/array/full-like]: create a filled array having the same length and data type as a provided array. - [`full( length, value[, dtype] )`][@stdlib/array/full]: create a filled array having a specified length. +- [`littleEndianFactory( dtype )`][@stdlib/array/little-endian-factory]: return a typed array constructor for creating typed arrays stored in little-endian byte order. +- [`Float32ArrayLE()`][@stdlib/array/little-endian-float32]: typed array constructor which returns a typed array representing an array of single-precision floating-point numbers in little-endian byte order. +- [`Float64ArrayLE()`][@stdlib/array/little-endian-float64]: typed array constructor which returns a typed array representing an array of double-precision floating-point numbers in little-endian byte order. - [`minDataType( value )`][@stdlib/array/min-dtype]: determine the minimum array data type of the closest "kind" necessary for storing a provided scalar value. - [`mostlySafeCasts( [dtype] )`][@stdlib/array/mostly-safe-casts]: return a list of array data types to which a provided array data type can be safely cast and, for floating-point data types, can be downcast. - [`mskfilter( x, mask )`][@stdlib/array/mskfilter]: apply a mask to a provided input array. @@ -361,6 +368,8 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [@stdlib/array/bool]: https://github.com/stdlib-js/array/tree/main/bool +[@stdlib/array/byte-orders]: https://github.com/stdlib-js/array/tree/main/byte-orders + [@stdlib/array/cartesian-power]: https://github.com/stdlib-js/array/tree/main/cartesian-power [@stdlib/array/cartesian-product]: https://github.com/stdlib-js/array/tree/main/cartesian-product @@ -389,6 +398,12 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [@stdlib/array/filled]: https://github.com/stdlib-js/array/tree/main/filled +[@stdlib/array/fixed-endian-factory]: https://github.com/stdlib-js/array/tree/main/fixed-endian-factory + +[@stdlib/array/fixed-endian-float32]: https://github.com/stdlib-js/array/tree/main/fixed-endian-float32 + +[@stdlib/array/fixed-endian-float64]: https://github.com/stdlib-js/array/tree/main/fixed-endian-float64 + [@stdlib/array/from-iterator]: https://github.com/stdlib-js/array/tree/main/from-iterator [@stdlib/array/from-scalar]: https://github.com/stdlib-js/array/tree/main/from-scalar @@ -397,6 +412,12 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [@stdlib/array/full]: https://github.com/stdlib-js/array/tree/main/full +[@stdlib/array/little-endian-factory]: https://github.com/stdlib-js/array/tree/main/little-endian-factory + +[@stdlib/array/little-endian-float32]: https://github.com/stdlib-js/array/tree/main/little-endian-float32 + +[@stdlib/array/little-endian-float64]: https://github.com/stdlib-js/array/tree/main/little-endian-float64 + [@stdlib/array/min-dtype]: https://github.com/stdlib-js/array/tree/main/min-dtype [@stdlib/array/mostly-safe-casts]: https://github.com/stdlib-js/array/tree/main/mostly-safe-casts diff --git a/base/README.md b/base/README.md index 97acf0d1..1182fd06 100644 --- a/base/README.md +++ b/base/README.md @@ -165,6 +165,7 @@ The namespace exports the following: - [`noneByRight( x, predicate[, thisArg] )`][@stdlib/array/base/none-by-right]: test whether all elements in an array fail a test implemented by a predicate function, iterating from right to left. - [`noneBy( x, predicate[, thisArg] )`][@stdlib/array/base/none-by]: test whether all elements in an array fail a test implemented by a predicate function. - [`none( x )`][@stdlib/array/base/none]: test whether all elements in an array are falsy. +- [`nulls( len )`][@stdlib/array/base/nulls]: create a "generic" array filled with null values. - [`oneTo( n )`][@stdlib/array/base/one-to]: generate a linearly spaced numeric array whose elements increment by 1 starting from one. - [`ones( len )`][@stdlib/array/base/ones]: create a "generic" array filled with ones. - [`ones2d( shape )`][@stdlib/array/base/ones2d]: create a two-dimensional nested array filled with ones. @@ -519,6 +520,8 @@ var squared = ns.map2d( arr2d, [ 2, 3 ], randu ); [@stdlib/array/base/none]: https://github.com/stdlib-js/array/tree/main/base/none +[@stdlib/array/base/nulls]: https://github.com/stdlib-js/array/tree/main/base/nulls + [@stdlib/array/base/one-to]: https://github.com/stdlib-js/array/tree/main/base/one-to [@stdlib/array/base/ones]: https://github.com/stdlib-js/array/tree/main/base/ones diff --git a/base/assert/README.md b/base/assert/README.md index cabebc51..605e7901 100644 --- a/base/assert/README.md +++ b/base/assert/README.md @@ -46,10 +46,13 @@ The namespace exports the following:
- [`contains( x, value )`][@stdlib/array/base/assert/contains]: test if an array contains a provided search value. +- [`hasEqualValuesIndexed( x, y )`][@stdlib/array/base/assert/has-equal-values-indexed]: test if two indexed arrays have equal values. +- [`hasEqualValues( x, y )`][@stdlib/array/base/assert/has-equal-values]: test if two arrays have equal values. - [`hasSameValues( x, y )`][@stdlib/array/base/assert/has-same-values]: test if two arrays have the same values. - [`isAccessorArray( value )`][@stdlib/array/base/assert/is-accessor-array]: test if an array-like object supports the accessor (get/set) protocol. - [`isBooleanDataType( value )`][@stdlib/array/base/assert/is-boolean-data-type]: test if an input value is a supported array boolean data type. - [`isBooleanArray( value )`][@stdlib/array/base/assert/is-booleanarray]: test if a value is a `BooleanArray`. +- [`isByteOrder( value )`][@stdlib/array/base/assert/is-byte-order]: test if an input value is a supported array byte order. - [`isComplexFloatingPointDataType( value )`][@stdlib/array/base/assert/is-complex-floating-point-data-type]: test if an input value is a supported array complex-valued floating-point data type. - [`isComplexTypedArray( value )`][@stdlib/array/base/assert/is-complex-typed-array]: test if a value is a complex typed array. - [`isComplex128Array( value )`][@stdlib/array/base/assert/is-complex128array]: test if a value is a `Complex128Array`. @@ -173,6 +176,10 @@ console.log( 'arr4 is complex typed array: ' + ns.isComplexTypedArray( arr4 ) ); [@stdlib/array/base/assert/contains]: https://github.com/stdlib-js/array/tree/main/base/assert/contains +[@stdlib/array/base/assert/has-equal-values-indexed]: https://github.com/stdlib-js/array/tree/main/base/assert/has-equal-values-indexed + +[@stdlib/array/base/assert/has-equal-values]: https://github.com/stdlib-js/array/tree/main/base/assert/has-equal-values + [@stdlib/array/base/assert/has-same-values]: https://github.com/stdlib-js/array/tree/main/base/assert/has-same-values [@stdlib/array/base/assert/is-accessor-array]: https://github.com/stdlib-js/array/tree/main/base/assert/is-accessor-array @@ -181,6 +188,8 @@ console.log( 'arr4 is complex typed array: ' + ns.isComplexTypedArray( arr4 ) ); [@stdlib/array/base/assert/is-booleanarray]: https://github.com/stdlib-js/array/tree/main/base/assert/is-booleanarray +[@stdlib/array/base/assert/is-byte-order]: https://github.com/stdlib-js/array/tree/main/base/assert/is-byte-order + [@stdlib/array/base/assert/is-complex-floating-point-data-type]: https://github.com/stdlib-js/array/tree/main/base/assert/is-complex-floating-point-data-type [@stdlib/array/base/assert/is-complex-typed-array]: https://github.com/stdlib-js/array/tree/main/base/assert/is-complex-typed-array