Auto-generated commit

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2024-11-20)
+## Unreleased (2024-11-21)
 
 <section class="packages">
 
@@ -195,6 +195,7 @@ A total of 3 people contributed to this release. Thank you to the following cont
 
 <details>
 
+-   [`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)_

README.md

@@ -191,6 +191,7 @@ Lastly, the namespace contains various other functions for dealing with arrays,
 
 -   <span class="signature">[`base`][@stdlib/array/base]</span><span class="delimiter">: </span><span class="description">base (i.e., lower-level) array utilities.</span>
 -   <span class="signature">[`BooleanArray()`][@stdlib/array/bool]</span><span class="delimiter">: </span><span class="description">boolean array.</span>
+-   <span class="signature">[`byteOrders()`][@stdlib/array/byte-orders]</span><span class="delimiter">: </span><span class="description">list of byte orders.</span>
 -   <span class="signature">[`cartesianPower( x, n )`][@stdlib/array/cartesian-power]</span><span class="delimiter">: </span><span class="description">return the Cartesian power.</span>
 -   <span class="signature">[`cartesianProduct( x1, x2 )`][@stdlib/array/cartesian-product]</span><span class="delimiter">: </span><span class="description">return the Cartesian product.</span>
 -   <span class="signature">[`cartesianSquare( x )`][@stdlib/array/cartesian-square]</span><span class="delimiter">: </span><span class="description">return the Cartesian square.</span>
@@ -205,10 +206,16 @@ Lastly, the namespace contains various other functions for dealing with arrays,
 -   <span class="signature">[`empty( length[, dtype] )`][@stdlib/array/empty]</span><span class="delimiter">: </span><span class="description">create an uninitialized array having a specified length.</span>
 -   <span class="signature">[`filledBy()`][@stdlib/array/filled-by]</span><span class="delimiter">: </span><span class="description">create a filled array according to a provided callback function.</span>
 -   <span class="signature">[`filled()`][@stdlib/array/filled]</span><span class="delimiter">: </span><span class="description">create a filled array.</span>
+-   <span class="signature">[`fixedEndianFactory( dtype )`][@stdlib/array/fixed-endian-factory]</span><span class="delimiter">: </span><span class="description">return a typed array constructor for creating typed arrays having a specified byte order.</span>
+-   <span class="signature">[`Float32ArrayFE()`][@stdlib/array/fixed-endian-float32]</span><span class="delimiter">: </span><span class="description">typed array constructor which returns a typed array representing an array of single-precision floating-point numbers in a specified byte order.</span>
+-   <span class="signature">[`Float64ArrayFE()`][@stdlib/array/fixed-endian-float64]</span><span class="delimiter">: </span><span class="description">typed array constructor which returns a typed array representing an array of double-precision floating-point numbers in a specified byte order.</span>
 -   <span class="signature">[`iterator2array( iterator[, out][, mapFcn[, thisArg]] )`][@stdlib/array/from-iterator]</span><span class="delimiter">: </span><span class="description">create (or fill) an array from an iterator.</span>
 -   <span class="signature">[`scalar2array( value[, dtype] )`][@stdlib/array/from-scalar]</span><span class="delimiter">: </span><span class="description">create a single-element array containing a provided scalar value.</span>
 -   <span class="signature">[`fullLike( x, value[, dtype] )`][@stdlib/array/full-like]</span><span class="delimiter">: </span><span class="description">create a filled array having the same length and data type as a provided array.</span>
 -   <span class="signature">[`full( length, value[, dtype] )`][@stdlib/array/full]</span><span class="delimiter">: </span><span class="description">create a filled array having a specified length.</span>
+-   <span class="signature">[`littleEndianFactory( dtype )`][@stdlib/array/little-endian-factory]</span><span class="delimiter">: </span><span class="description">return a typed array constructor for creating typed arrays stored in little-endian byte order.</span>
+-   <span class="signature">[`Float32ArrayLE()`][@stdlib/array/little-endian-float32]</span><span class="delimiter">: </span><span class="description">typed array constructor which returns a typed array representing an array of single-precision floating-point numbers in little-endian byte order.</span>
+-   <span class="signature">[`Float64ArrayLE()`][@stdlib/array/little-endian-float64]</span><span class="delimiter">: </span><span class="description">typed array constructor which returns a typed array representing an array of double-precision floating-point numbers in little-endian byte order.</span>
 -   <span class="signature">[`minDataType( value )`][@stdlib/array/min-dtype]</span><span class="delimiter">: </span><span class="description">determine the minimum array data type of the closest "kind" necessary for storing a provided scalar value.</span>
 -   <span class="signature">[`mostlySafeCasts( [dtype] )`][@stdlib/array/mostly-safe-casts]</span><span class="delimiter">: </span><span class="description">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.</span>
 -   <span class="signature">[`mskfilter( x, mask )`][@stdlib/array/mskfilter]</span><span class="delimiter">: </span><span class="description">apply a mask to a provided input array.</span>
@@ -361,6 +368,8 @@ Copyright &copy; 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 &copy; 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 &copy; 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

base/README.md

@@ -165,6 +165,7 @@ The namespace exports the following:
 -   <span class="signature">[`noneByRight( x, predicate[, thisArg] )`][@stdlib/array/base/none-by-right]</span><span class="delimiter">: </span><span class="description">test whether all elements in an array fail a test implemented by a predicate function, iterating from right to left.</span>
 -   <span class="signature">[`noneBy( x, predicate[, thisArg] )`][@stdlib/array/base/none-by]</span><span class="delimiter">: </span><span class="description">test whether all elements in an array fail a test implemented by a predicate function.</span>
 -   <span class="signature">[`none( x )`][@stdlib/array/base/none]</span><span class="delimiter">: </span><span class="description">test whether all elements in an array are falsy.</span>
+-   <span class="signature">[`nulls( len )`][@stdlib/array/base/nulls]</span><span class="delimiter">: </span><span class="description">create a "generic" array filled with null values.</span>
 -   <span class="signature">[`oneTo( n )`][@stdlib/array/base/one-to]</span><span class="delimiter">: </span><span class="description">generate a linearly spaced numeric array whose elements increment by 1 starting from one.</span>
 -   <span class="signature">[`ones( len )`][@stdlib/array/base/ones]</span><span class="delimiter">: </span><span class="description">create a "generic" array filled with ones.</span>
 -   <span class="signature">[`ones2d( shape )`][@stdlib/array/base/ones2d]</span><span class="delimiter">: </span><span class="description">create a two-dimensional nested array filled with ones.</span>
@@ -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

base/assert/README.md

@@ -46,10 +46,13 @@ The namespace exports the following:
 <div class="namespace-toc">
 
 -   <span class="signature">[`contains( x, value )`][@stdlib/array/base/assert/contains]</span><span class="delimiter">: </span><span class="description">test if an array contains a provided search value.</span>
+-   <span class="signature">[`hasEqualValuesIndexed( x, y )`][@stdlib/array/base/assert/has-equal-values-indexed]</span><span class="delimiter">: </span><span class="description">test if two indexed arrays have equal values.</span>
+-   <span class="signature">[`hasEqualValues( x, y )`][@stdlib/array/base/assert/has-equal-values]</span><span class="delimiter">: </span><span class="description">test if two arrays have equal values.</span>
 -   <span class="signature">[`hasSameValues( x, y )`][@stdlib/array/base/assert/has-same-values]</span><span class="delimiter">: </span><span class="description">test if two arrays have the same values.</span>
 -   <span class="signature">[`isAccessorArray( value )`][@stdlib/array/base/assert/is-accessor-array]</span><span class="delimiter">: </span><span class="description">test if an array-like object supports the accessor (get/set) protocol.</span>
 -   <span class="signature">[`isBooleanDataType( value )`][@stdlib/array/base/assert/is-boolean-data-type]</span><span class="delimiter">: </span><span class="description">test if an input value is a supported array boolean data type.</span>
 -   <span class="signature">[`isBooleanArray( value )`][@stdlib/array/base/assert/is-booleanarray]</span><span class="delimiter">: </span><span class="description">test if a value is a `BooleanArray`.</span>
+-   <span class="signature">[`isByteOrder( value )`][@stdlib/array/base/assert/is-byte-order]</span><span class="delimiter">: </span><span class="description">test if an input value is a supported array byte order.</span>
 -   <span class="signature">[`isComplexFloatingPointDataType( value )`][@stdlib/array/base/assert/is-complex-floating-point-data-type]</span><span class="delimiter">: </span><span class="description">test if an input value is a supported array complex-valued floating-point data type.</span>
 -   <span class="signature">[`isComplexTypedArray( value )`][@stdlib/array/base/assert/is-complex-typed-array]</span><span class="delimiter">: </span><span class="description">test if a value is a complex typed array.</span>
 -   <span class="signature">[`isComplex128Array( value )`][@stdlib/array/base/assert/is-complex128array]</span><span class="delimiter">: </span><span class="description">test if a value is a `Complex128Array`.</span>
@@ -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