Auto-generated commit

Author: stdlib-bot

.github/.keepalive

@@ -1 +1 @@
-2025-03-17T00:53:30.187Z
+2025-04-14T00:31:16.651Z

CHANGELOG.md

@@ -4,14 +4,26 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-03-17)
+## Unreleased (2025-04-14)
+
+<section class="bug-fixes">
+
+### Bug Fixes
+
+-   [`f22a9ab`](https://github.com/stdlib-js/stdlib/commit/f22a9ab1c1c50aacc3529b77401469c915f79aaf) - ensure support for allocating zero-dimensional ndarrays
+
+</section>
+
+<!-- /.bug-fixes -->
 
 <section class="commits">
 
 ### Commits
 
 <details>
 
+-   [`7536870`](https://github.com/stdlib-js/stdlib/commit/75368709f4bdeb91221d08492b5a0bc9c94f5b71) - **docs:** fix example and update docs _(by Athan Reines)_
+-   [`f22a9ab`](https://github.com/stdlib-js/stdlib/commit/f22a9ab1c1c50aacc3529b77401469c915f79aaf) - **fix:** ensure support for allocating zero-dimensional ndarrays _(by Athan Reines)_
 -   [`453c7f9`](https://github.com/stdlib-js/stdlib/commit/453c7f9f7c8ac5b8817b1d81f98af42570f1d0a5) - **refactor:** allow array-like objects containing submodes _(by Athan Reines)_
 
 </details>

CONTRIBUTORS

@@ -3,8 +3,10 @@
 # Contributors listed in alphabetical order.
 
 Aadish Jain <[email protected]>
+Aarya Balwadkar <[email protected]>
 Aayush Khanna <[email protected]>
 Abdelrahman Samir <[email protected]>
+Abdul Kaium <[email protected]>
 Abhay Punia <[email protected]>
 Abhijit Raut <[email protected]>
 Abhishek Jain <[email protected]>
@@ -16,6 +18,7 @@ Ahmed Khaled <[email protected]>
 Aksshay Balasubramanian <[email protected]>
 Aleksandr <[email protected]>
 Ali Salesi <[email protected]>
+AlyAbdelmoneim <[email protected]>
 Aman Bhansali <[email protected]>
 AmanBhadkariya <[email protected]>
 Amit Jimiwal <[email protected]>
@@ -24,6 +27,7 @@ Anshu Kumar <[email protected]>
 Anudeep Sanapala <[email protected]>
 Athan Reines <[email protected]>
 Ayaka <[email protected]>
+Bhavishy Agrawal <[email protected]>
 Brendan Graetz <[email protected]>
 Bruno Fenzl <[email protected]>
 Bryan Elee <[email protected]>
@@ -39,6 +43,7 @@ Dev Goel <[email protected]>
 Dhanyabad behera <[email protected]>
 Dhruv Arvind Singh <[email protected]>
 Dhruvil Mehta <[email protected]>
+Dipjyoti Das <[email protected]>
 Divyansh Seth <[email protected]>
 Dominic Lim <[email protected]>
 Dominik Moritz <[email protected]>
@@ -61,6 +66,7 @@ Jaimin Godhani <[email protected]>
 Jaison D Souza <[email protected]>
 Jalaj Kumar <[email protected]>
 James Gelok <[email protected]>
+Jay Soni <[email protected]>
 Jaysukh Makvana <[email protected]>
 Jenish Thapa <[email protected]>
 Jithin KS <[email protected]>
@@ -70,14 +76,18 @@ Jordan Gallivan <[email protected]>
 Joris Labie <[email protected]>
 Justin Dennison <[email protected]>
 Justyn Shelby <[email protected]>
-Karan Anand <[email protected]>
+Karan Anand <[email protected]>
+Karan Yadav <[email protected]>
 Karthik Prakash <[email protected]>
 Kaushikgtm <[email protected]>
+Kavyansh-Bagdi <[email protected]>
 Kohantika Nath <[email protected]>
 Krishnam Agarwal <[email protected]>
 Krishnendu Das <[email protected]>
 Kshitij-Dale <[email protected]>
 Lovelin Dhoni J B <[email protected]>
+MANI <[email protected]>
+Mahfuza Humayra Mohona <[email protected]>
 Manik Sharma <[email protected]>
 Manvith M <[email protected]>
 Marcus Fantham <[email protected]>
@@ -88,9 +98,12 @@ Mohammad Bin Aftab <[email protected]>
 Mohammad Kaif <[email protected]>
 Momtchil Momtchev <[email protected]>
 Muhammad Haris <[email protected]>
+Muhammad Taaha Tariq <[email protected]>
+Muhmmad Saad <[email protected]>
 Naresh Jagadeesan <[email protected]>
 Naveen Kumar <[email protected]>
 Neeraj Pathak <[email protected]>
+NirvedMishra <[email protected]>
 Nishant Shinde <[email protected]>
 Nishchay Rajput <[email protected]>
 Nithin Katta <[email protected]>
@@ -99,15 +112,20 @@ Ognjen Jevremović <[email protected]>
 Oneday12323 <[email protected]>
 Ori Miles <[email protected]>
 Philipp Burckhardt <[email protected]>
+Prajjwal Bajpai <[email protected]>
 Prajwal Kulkarni <[email protected]>
 Pranav Goswami <[email protected]>
 Pranjal Jha <[email protected]>
 Prashant Kumar Yadav <[email protected]>
+PrathamBhamare <[email protected]>
 Pratik Singh <[email protected]>
 Pratyush Kumar Chouhan <[email protected]>
+Pravesh Kunwar <[email protected]>
 Priyansh Prajapati <[email protected]>
 Priyanshu Agarwal <[email protected]>
+Pulkit Gupta <[email protected]>
 Pushpendra Chandravanshi <[email protected]>
+Rahul Kumar <[email protected]>
 Raunak Kumar Gupta <[email protected]>
 Rejoan Sardar <[email protected]>
 Ricky Reusser <[email protected]>
@@ -116,12 +134,17 @@ Rishav <[email protected]>
 Rishav Tarway <[email protected]>
 Robert Gislason <[email protected]>
 Roman Stetsyk <[email protected]>
+Rupa <[email protected]>
 Rutam Kathale <[email protected]>
 Ruthwik Chikoti <[email protected]>
 Ryan Seal <[email protected]>
 Rylan Yang <[email protected]>
+SAHIL KUMAR <[email protected]>
 SHIVAM YADAV <[email protected]>
+Sahil Goyal <[email protected]>
+Sai Avinash <[email protected]>
 Sai Srikar Dumpeti <[email protected]>
+Sanchay Ketan Sinha <[email protected]>
 Sarthak Paandey <[email protected]>
 Saurabh Singh <[email protected]>
 Seyyed Parsa Neshaei <[email protected]>
@@ -157,6 +180,7 @@ Yuvi Mittal <[email protected]>
 ditsu <[email protected]>
 ekambains <[email protected]>
 fadiothman22 <[email protected]>
+lohithganni <[email protected]>
 olenkabilonizhka <[email protected]>
 pranav-1720 <[email protected]>
 rahulrangers <[email protected]>

README.md

@@ -913,6 +913,7 @@ struct ndarray * stdlib_ndarray_allocate( int16_t dtype, uint8_t *data, int64_t
 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 )
 
@@ -1032,6 +1033,7 @@ int64_t stdlib_ndarray_dimension( const struct ndarray *arr, const int64_t i );
 Notes:
 
 -   The function does perform bounds checking for the dimension index.
+-   If an input ndarray is zero-dimensional, the function always returns `-1`.
 
 #### stdlib_ndarray_disable_flags( \*arr, flags )
 
@@ -1538,6 +1540,10 @@ The function accepts the following arguments:
 int64_t * stdlib_ndarray_shape( const struct ndarray *arr );
 ```
 
+Notes:
+
+-   If an input ndarray is zero-dimensional, the function returns a null pointer.
+
 #### stdlib_ndarray_stride( \*arr, i )
 
 Returns an ndarray stride (in bytes).
@@ -1579,7 +1585,7 @@ int64_t stdlib_ndarray_stride( const struct ndarray *arr, const int64_t i );
 
 Notes:
 
--   the function does perform bounds checking for the dimension index.
+-   The function does perform bounds checking for the dimension index.
 
 #### stdlib_ndarray_strides( \*arr )
 

src/main.c

@@ -37,6 +37,29 @@
 *
 * -   The user is responsible for freeing the allocated memory.
 *
+* -   To create a zero-dimensional array,
+*
+*     -   provide an `ndims` argument equal to `0`.
+*     -   a `shape` argument equal to a null pointer.
+*     -   a `strides` argument containing 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.
+*
+*     ```javascript
+*     #include "stdlib/ndarray/ctor.h"
+*     #include "stdlib/ndarray/dtypes.h"
+*     #include "stdlib/ndarray/index_modes.h"
+*     #include "stdlib/ndarray/orders.h"
+*     #include <stdint.h>
+*
+*     uint8_t buffer[] = { 0, 0, 0, 0, 0, 0, 0, 0 };
+*     int64_t *shape = NULL;
+*     int64_t strides = { 0 };
+*     int64_t offset = 0;
+*
+*     struct ndarray *x = stdlib_ndarray_allocate( STDLIB_NDARRAY_FLOAT64, buffer, 0, shape, strides, offset, STDLIB_NDARRAY_ROW_MAJOR, STDLIB_NDARRAY_INDEX_ERROR, 1, { STDLIB_NDARRAY_INDEX_ERROR } );
+*     ```
+*
 * @param dtype      data type
 * @param data       pointer to the underlying byte array
 * @param ndims      number of dimensions
@@ -115,7 +138,11 @@ struct ndarray * stdlib_ndarray_allocate( int16_t dtype, uint8_t *data, int64_t
 	arr->strides = strides;
 	arr->submodes = submodes;
 
-	len = stdlib_ndarray_numel( ndims, shape );
+	if ( shape == NULL ) {
+		len = 1;
+	} else {
+		len = stdlib_ndarray_numel( ndims, shape );
+	}
 	arr->length = len;
 
 	arr->BYTES_PER_ELEMENT = stdlib_ndarray_bytes_per_element( dtype );
@@ -146,17 +173,21 @@ uint8_t * stdlib_ndarray_data( const struct ndarray *arr ) {
 }
 
 /**
-* Returns an ndarray dimension.
+* Returns an ndarray dimension size.
 *
 * ## Notes
 *
 * -   The function does not perform any sanity checks.
+* -   If an input ndarray is zero-dimensional, the function always returns `-1`.
 *
 * @param arr  input ndarray
 * @param i    dimension index
-* @return     dimension
+* @return     dimension size
 */
 int64_t stdlib_ndarray_dimension( const struct ndarray *arr, const int64_t i ) {
+	if ( arr->shape == NULL ) {
+		return -1;
+	}
 	return arr->shape[ i ];
 }
 
@@ -229,8 +260,11 @@ int64_t stdlib_ndarray_flags( const struct ndarray *arr ) {
 
 	// Determine if the array can be stored contiguously...
 	if ( len == 0 || stdlib_ndarray_iteration_order( ndims, strides ) == 0 ) {
-		// If an array does not contain any elements, then no data to store, and, if the array is unordered, adjacent array elements are not guaranteed to be stored next to each other.
+		// If an array does not contain any elements, then no data to store, and, if the array is unordered, adjacent array elements are not guaranteed to be stored next to each other:
 		contiguous = 0;
+	} else if ( ndims == 0 ) {
+		// If an array is zero-dimensional, data consists of a single element which means it is trivially compatible with a single memory segment:
+		contiguous = 1;
 	} else {
 		// Ensure that the array is compatible with a single memory segment:
 		stdlib_ndarray_minmax_view_buffer_index( ndims, arr->shape, strides, arr->offset, tmp );
@@ -343,6 +377,10 @@ int8_t stdlib_ndarray_order( const struct ndarray *arr ) {
 /**
 * Returns a pointer to an array containing an ndarray shape (dimensions).
 *
+* ## Notes
+*
+* -   If an input ndarray is zero-dimensional, the function returns a null pointer.
+*
 * @param arr  input ndarray
 * @return     array shape (dimensions)
 */