Document C APIs

Author: kgryte

lib/node_modules/@stdlib/ndarray/ctor/README.md

@@ -2285,6 +2285,216 @@ The function accepts the following arguments:
 -   **arr**: `[in] struct ndarray*` input ndarray.
 -   **idx**: `[in] int64_t` linear view index.
 
+* * *
+
+#### stdlib_ndarray_iset( \*arr, idx, \*v )
+
+Sets an ndarray data element located at a specified linear index.
+
+```c
+int8_t stdlib_ndarray_iset( const struct ndarray *arr, const int64_t idx, const void *v );
+```
+
+The function accepts the following arguments:
+
+-   **arr**: `[in] struct ndarray*` input ndarray.
+-   **idx**: `[in] int64_t` linear view index.
+-   **v**: `[in] void *` value to set.
+
+Notes:
+
+-   The function returns `-1` if unable to set an element and `0` otherwise.
+-   The function requires a pointer to a data value `v` in order to provide a generic API supporting ndarrays having different data types.
+-   The function has no way of determining whether `v` actually points to a memory address compatible with the underlying input ndarray data type. Accordingly, accessing **unowned** memory is possible, and this function **assumes** you know what you are doing.
+
+#### stdlib_ndarray_iset_float64( \*arr, idx, v )
+
+Sets a double-precision floating-point ndarray data element located at a specified linear index.
+
+```c
+int8_t stdlib_ndarray_iset_float64( const struct ndarray *arr, const int64_t idx, const double v );
+```
+
+The function accepts the following arguments:
+
+-   **arr**: `[in] struct ndarray*` input ndarray.
+-   **idx**: `[in] int64_t` linear view index.
+-   **v**: `[in] double` value to set.
+
+Notes:
+
+-   The function does **not** verify that the type of `v` matches the underlying input ndarray data type, and, thus, overwriting **unowned** memory is possible. The function **assumes** that you know what you are doing.
+-   The function returns `-1` if unable to set an element and `0` otherwise.
+
+#### stdlib_ndarray_iset_float32( \*arr, idx, v )
+
+Sets a single-precision floating-point ndarray data element located at a specified linear index.
+
+```c
+int8_t stdlib_ndarray_iset_float32( const struct ndarray *arr, const int64_t idx, const float v );
+```
+
+The function accepts the following arguments:
+
+-   **arr**: `[in] struct ndarray*` input ndarray.
+-   **idx**: `[in] int64_t` linear view index.
+-   **v**: `[in] float` value to set.
+
+Notes:
+
+-   The function does **not** verify that the type of `v` matches the underlying input ndarray data type, and, thus, overwriting **unowned** memory is possible. The function **assumes** that you know what you are doing.
+-   The function returns `-1` if unable to set an element and `0` otherwise.
+
+#### stdlib_ndarray_iset_uint64( \*arr, idx, v )
+
+Sets an unsigned 64-bit integer ndarray data element located at a specified linear index.
+
+```c
+int8_t stdlib_ndarray_iset_uint64( const struct ndarray *arr, const int64_t idx, const uint64_t v );
+```
+
+The function accepts the following arguments:
+
+-   **arr**: `[in] struct ndarray*` input ndarray.
+-   **idx**: `[in] int64_t` linear view index.
+-   **v**: `[in] uint64_t` value to set.
+
+Notes:
+
+-   The function does **not** verify that the type of `v` matches the underlying input ndarray data type, and, thus, overwriting **unowned** memory is possible. The function **assumes** that you know what you are doing.
+-   The function returns `-1` if unable to set an element and `0` otherwise.
+
+#### stdlib_ndarray_iset_int64( \*arr, idx, v )
+
+Sets a signed 64-bit integer ndarray data element located at a specified linear index.
+
+```c
+int8_t stdlib_ndarray_iset_int64( const struct ndarray *arr, const int64_t idx, const int64_t v );
+```
+
+The function accepts the following arguments:
+
+-   **arr**: `[in] struct ndarray*` input ndarray.
+-   **idx**: `[in] int64_t` linear view index.
+-   **v**: `[in] int64_t` value to set.
+
+Notes:
+
+-   The function does **not** verify that the type of `v` matches the underlying input ndarray data type, and, thus, overwriting **unowned** memory is possible. The function **assumes** that you know what you are doing.
+-   The function returns `-1` if unable to set an element and `0` otherwise.
+
+#### stdlib_ndarray_iset_uint32( \*arr, idx, v )
+
+Sets an unsigned 32-bit integer ndarray data element located at a specified linear index.
+
+```c
+int8_t stdlib_ndarray_iset_uint32( const struct ndarray *arr, const int64_t idx, const uint32_t v );
+```
+
+The function accepts the following arguments:
+
+-   **arr**: `[in] struct ndarray*` input ndarray.
+-   **idx**: `[in] int64_t` linear view index.
+-   **v**: `[in] uint32_t` value to set.
+
+Notes:
+
+-   The function does **not** verify that the type of `v` matches the underlying input ndarray data type, and, thus, overwriting **unowned** memory is possible. The function **assumes** that you know what you are doing.
+-   The function returns `-1` if unable to set an element and `0` otherwise.
+
+#### stdlib_ndarray_iset_int32( \*arr, idx, v )
+
+Sets a signed 32-bit integer ndarray data element located at a specified linear index.
+
+```c
+int8_t stdlib_ndarray_iset_int32( const struct ndarray *arr, const int64_t idx, const int32_t v );
+```
+
+The function accepts the following arguments:
+
+-   **arr**: `[in] struct ndarray*` input ndarray.
+-   **idx**: `[in] int64_t` linear view index.
+-   **v**: `[in] int32_t` value to set.
+
+Notes:
+
+-   The function does **not** verify that the type of `v` matches the underlying input ndarray data type, and, thus, overwriting **unowned** memory is possible. The function **assumes** that you know what you are doing.
+-   The function returns `-1` if unable to set an element and `0` otherwise.
+
+#### stdlib_ndarray_iset_uint16( \*arr, idx, v )
+
+Sets an unsigned 16-bit integer ndarray data element located at a specified linear index.
+
+```c
+int8_t stdlib_ndarray_iset_uint16( const struct ndarray *arr, const int64_t idx, const uint16_t v );
+```
+
+The function accepts the following arguments:
+
+-   **arr**: `[in] struct ndarray*` input ndarray.
+-   **idx**: `[in] int64_t` linear view index.
+-   **v**: `[in] uint16_t` value to set.
+
+Notes:
+
+-   The function does **not** verify that the type of `v` matches the underlying input ndarray data type, and, thus, overwriting **unowned** memory is possible. The function **assumes** that you know what you are doing.
+-   The function returns `-1` if unable to set an element and `0` otherwise.
+
+#### stdlib_ndarray_iset_int16( \*arr, idx, v )
+
+Sets a signed 16-bit integer ndarray data element located at a specified linear index.
+
+```c
+int8_t stdlib_ndarray_iset_int16( const struct ndarray *arr, const int64_t idx, const int16_t v );
+```
+
+The function accepts the following arguments:
+
+-   **arr**: `[in] struct ndarray*` input ndarray.
+-   **idx**: `[in] int64_t` linear view index.
+-   **v**: `[in] int16_t` value to set.
+
+Notes:
+
+-   The function does **not** verify that the type of `v` matches the underlying input ndarray data type, and, thus, overwriting **unowned** memory is possible. The function **assumes** that you know what you are doing.
+-   The function returns `-1` if unable to set an element and `0` otherwise.
+
+#### stdlib_ndarray_iset_uint8( \*arr, idx, v )
+
+Sets an unsigned 8-bit integer ndarray data element located at a specified linear index.
+
+```c
+int8_t stdlib_ndarray_iset_uint8( const struct ndarray *arr, const int64_t idx, const uint8_t v );
+```
+
+The function accepts the following arguments:
+
+-   **arr**: `[in] struct ndarray*` input ndarray.
+-   **idx**: `[in] int64_t` linear view index.
+-   **v**: `[in] uint8_t` value to set.
+
+Notes:
+
+-   The function returns `-1` if unable to set an element and `0` otherwise.
+
+#### stdlib_ndarray_iset_int8( \*arr, idx, v )
+
+Sets a signed 8-bit integer ndarray data element located at a specified linear index.
+
+```c
+int8_t stdlib_ndarray_iset_int8( const struct ndarray *arr, const int64_t idx, const int8_t v );
+```
+
+The function accepts the following arguments:
+
+-   **arr**: `[in] struct ndarray*` input ndarray.
+-   **idx**: `[in] int64_t` linear view index.
+-   **v**: `[in] int8_t` value to set.
+
+Notes:
+
+-   The function returns `-1` if unable to set an element and `0` otherwise.
+
 </section>
 
 <!-- /.usage -->