Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -10,6 +10,9 @@
 
 ### Features
 
+-   [`3d21748`](https://github.com/stdlib-js/stdlib/commit/3d2174821f71a70dbb3052da07e0a3b3f6dfbaa0) - add function to return the index offset in units of elements
+-   [`dd45a8f`](https://github.com/stdlib-js/stdlib/commit/dd45a8fcec70ba4716ec67606a448721a723f54b) - add function to return a dimension stride in units of elements
+-   [`b00ba84`](https://github.com/stdlib-js/stdlib/commit/b00ba84689ed039d0896209f94716c187cd6cccb) - add function for returning the number of bytes per ndarray element
 -   [`1e5789c`](https://github.com/stdlib-js/stdlib/commit/1e5789c70b7400b0ff1cd71d06798c1e5b26f16b) - add `blockSize` to namespace
 -   [`a6117b1`](https://github.com/stdlib-js/stdlib/commit/a6117b1bd697083439d740567d41cbfa754f68ab) - add `quinaryBlockSize` to namespace
 -   [`c6dca39`](https://github.com/stdlib-js/stdlib/commit/c6dca39c634f8c016dc6fa4d0330a47bba977eaf) - add `quaternaryBlockSize` to namespace
@@ -654,6 +657,11 @@
 
 ### BREAKING CHANGES
 
+-   [`cf38d87`](https://github.com/stdlib-js/stdlib/commit/cf38d87a6820408d2ec054cbf0e20561e8352deb): rename `stdlib_ndarray_bytelength` to `stdlib_ndarray_byte_length`
+
+    -   To migrate, users using the C API should update their call signatures
+        accordingly.
+
 -   [`45ca891`](https://github.com/stdlib-js/stdlib/commit/45ca891a86f94011ad8b407ba8cf53a7cecbb7b5): rename `with` to `ndarrayWith` in `ndarray` namespace
 
     -   Users should migrate to the new function name when using it directly via the namespace object.
@@ -727,6 +735,12 @@ A total of 43 issues were closed in this release:
 
 <details>
 
+-   [`b6a0e1f`](https://github.com/stdlib-js/stdlib/commit/b6a0e1f3b0044a068a51acd7cd1352ab0f8e4a60) - **bench:** fix call signature _(by Athan Reines)_
+-   [`3d21748`](https://github.com/stdlib-js/stdlib/commit/3d2174821f71a70dbb3052da07e0a3b3f6dfbaa0) - **feat:** add function to return the index offset in units of elements _(by Athan Reines)_
+-   [`dd45a8f`](https://github.com/stdlib-js/stdlib/commit/dd45a8fcec70ba4716ec67606a448721a723f54b) - **feat:** add function to return a dimension stride in units of elements _(by Athan Reines)_
+-   [`b00ba84`](https://github.com/stdlib-js/stdlib/commit/b00ba84689ed039d0896209f94716c187cd6cccb) - **feat:** add function for returning the number of bytes per ndarray element _(by Athan Reines)_
+-   [`cf38d87`](https://github.com/stdlib-js/stdlib/commit/cf38d87a6820408d2ec054cbf0e20561e8352deb) - **refactor:** rename `stdlib_ndarray_bytelength` to `stdlib_ndarray_byte_length` _(by Athan Reines)_
+-   [`40c30fb`](https://github.com/stdlib-js/stdlib/commit/40c30fb11f3c1b99e073b5a2aa217bce452c3402) - **docs:** fix type _(by Athan Reines)_
 -   [`46c8d0e`](https://github.com/stdlib-js/stdlib/commit/46c8d0eb953a8bd39e4486a93d65aca6c45af934) - **docs:** fix examples _(by Athan Reines)_
 -   [`9d7f220`](https://github.com/stdlib-js/stdlib/commit/9d7f220eca1b55eb1c59b1f31efd91f66a450af2) - **refactor:** use generalized utility _(by Athan Reines)_
 -   [`7f54590`](https://github.com/stdlib-js/stdlib/commit/7f54590d0556e5c8b13d8bc2c527dbfc90e55201) - **refactor:** use generalized utility _(by Athan Reines)_

base/napi/addon-arguments/README.md

@@ -160,7 +160,7 @@ The function accepts the following arguments:
 -   **argv**: `[in] napi_value*` ndarray function arguments.
 -   **nargs**: `[in] int64_t` total number of expected arguments.
 -   **nin**: `[in] int64_t` number of input ndarray arguments.
--   **arrays**: `[out] struct ndarrays**` destination array for storing pointers to both input and output ndarrays.
+-   **arrays**: `[out] struct ndarray**` destination array for storing pointers to both input and output ndarrays.
 -   **err**: `[out] napi_value*` pointer for storing a JavaScript error.
 
 ```c

ctor/README.md

@@ -882,7 +882,7 @@ Notes:
 -   The user is responsible for freeing the allocated memory.
 -   To allocate a zero-dimensional ndarray, provide a `shape` argument equal to a null pointer, an `ndims` argument equal to `0`, and a `strides` argument consisting of a single element equal to `0`. The `order` argument can be either row-major or column-major and has no effect on data storage or access.
 
-#### stdlib_ndarray_bytelength( \*arr )
+#### stdlib_ndarray_byte_length( \*arr )
 
 Returns the size of an ndarray (in bytes).
 
@@ -904,7 +904,7 @@ if ( x == NULL ) {
 // ...
 
 // Retrieve the ndarray size:
-int64_t N = stdlib_ndarray_bytelength( x );
+int64_t N = stdlib_ndarray_byte_length( x );
 
 // ...
 
@@ -917,7 +917,45 @@ The function accepts the following arguments:
 -   **arr**: `[in] struct ndarray*` input ndarray.
 
 ```c
-int64_t stdlib_ndarray_bytelength( const struct ndarray *arr );
+int64_t stdlib_ndarray_byte_length( const struct ndarray *arr );
+```
+
+#### stdlib_ndarray_byte_length_per_element( \*arr )
+
+Returns the number of bytes per ndarray element.
+
+```c
+#include "stdlib/ndarray/ctor.h"
+#include <stdint.h>
+#include <stdlib.h>
+#include <stdio.h>
+
+// ...
+
+// Create an ndarray:
+struct ndarray *x = stdlib_ndarray_allocate( ... );
+if ( x == NULL ) {
+    fprintf( stderr, "Error allocating memory.\n" );
+    exit( 1 );
+}
+
+// ...
+
+// Retrieve the number of bytes per element:
+int64_t nb = stdlib_ndarray_byte_length_per_element( x );
+
+// ...
+
+// Free allocated memory:
+stdlib_ndarray_free( x );
+```
+
+The function accepts the following arguments:
+
+-   **arr**: `[in] struct ndarray*` input ndarray.
+
+```c
+int64_t stdlib_ndarray_byte_length_per_element( const struct ndarray *arr );
 ```
 
 #### stdlib_ndarray_data( \*arr )
@@ -1431,6 +1469,48 @@ The function accepts the following arguments:
 int64_t stdlib_ndarray_offset( const struct ndarray *arr );
 ```
 
+#### stdlib_ndarray_offset_elements( \*arr )
+
+Returns an ndarray index offset (in elements).
+
+```c
+#include "stdlib/ndarray/ctor.h"
+#include <stdint.h>
+#include <stdlib.h>
+#include <stdio.h>
+
+// ...
+
+// Create an ndarray:
+struct ndarray *x = stdlib_ndarray_allocate( ... );
+if ( x == NULL ) {
+    fprintf( stderr, "Error allocating memory.\n" );
+    exit( 1 );
+}
+
+// ...
+
+// Retrieve the index offset:
+int64_t offset = stdlib_ndarray_offset_elements( x );
+
+// ...
+
+// Free allocated memory:
+stdlib_ndarray_free( x );
+```
+
+The function accepts the following arguments:
+
+-   **arr**: `[in] struct ndarray*` input ndarray.
+
+```c
+int64_t stdlib_ndarray_offset_elements( const struct ndarray *arr );
+```
+
+Notes:
+
+-   The function assumes that the ndarray is **aligned** (i.e., the index offset in bytes is a multiple of the number of bytes per ndarray element).
+
 #### stdlib_ndarray_order( \*arr )
 
 Returns the order of an ndarray.
@@ -1554,6 +1634,49 @@ Notes:
 
 -   The function does perform bounds checking for the dimension index.
 
+#### stdlib_ndarray_stride_elements( \*arr, i )
+
+Returns an ndarray stride (in elements).
+
+```c
+#include "stdlib/ndarray/ctor.h"
+#include <stdint.h>
+#include <stdlib.h>
+#include <stdio.h>
+
+// ...
+
+// Create an ndarray:
+struct ndarray *x = stdlib_ndarray_allocate( ... );
+if ( x == NULL ) {
+    fprintf( stderr, "Error allocating memory.\n" );
+    exit( 1 );
+}
+
+// ...
+
+// Retrieve a stride:
+int64_t s = stdlib_ndarray_stride_elements( x, 0 );
+
+// ...
+
+// Free allocated memory:
+stdlib_ndarray_free( x );
+```
+
+The function accepts the following arguments:
+
+-   **arr**: `[in] struct ndarray*` input ndarray.
+-   **i**: `[in] int64_t` dimension index.
+
+```c
+int64_t stdlib_ndarray_stride_elements( const struct ndarray *arr, const int64_t i );
+```
+
+Notes:
+
+-   The function does perform bounds checking for the dimension index.
+
 #### stdlib_ndarray_strides( \*arr )
 
 Returns a pointer to an array containing ndarray strides (in bytes).
@@ -3415,7 +3538,7 @@ int main( void ) {
 
     printf( "dtype = %u\n", stdlib_ndarray_dtype( x1 ) );
     printf( "length = %"PRId64"\n", stdlib_ndarray_length( x1 ) );
-    printf( "byteLength = %"PRId64"\n", stdlib_ndarray_bytelength( x1 ) );
+    printf( "byteLength = %"PRId64"\n", stdlib_ndarray_byte_length( x1 ) );
     printf( "ltr = %u\n", stdlib_ndarray_dtype_char( stdlib_ndarray_dtype( x1 ) ) );
     printf( "\n" );
 
@@ -3428,7 +3551,7 @@ int main( void ) {
 
     printf( "dtype = %u\n", stdlib_ndarray_dtype( x2 ) );
     printf( "length = %"PRId64"\n", stdlib_ndarray_length( x2 ) );
-    printf( "byteLength = %"PRId64"\n", stdlib_ndarray_bytelength( x2 ) );
+    printf( "byteLength = %"PRId64"\n", stdlib_ndarray_byte_length( x2 ) );
     printf( "ltr = %u\n", stdlib_ndarray_dtype_char( stdlib_ndarray_dtype( x2 ) ) );
     printf( "\n" );