Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,12 +4,13 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2024-12-24)
+## Unreleased (2025-01-03)
 
 <section class="bug-fixes">
 
 ### Bug Fixes
 
+-   [`e1296c1`](https://github.com/stdlib-js/stdlib/commit/e1296c1c5634fbcf5e007695391c944fef27e6aa) - update include paths and reorder includes
 -   [`09483ae`](https://github.com/stdlib-js/stdlib/commit/09483ae5cf6ed8edfce7d64d36a31339bc3e6e06) - update documentation to reflect correct seed range
 
 </section>
@@ -34,6 +35,7 @@ This release closes the following issue:
 
 <details>
 
+-   [`e1296c1`](https://github.com/stdlib-js/stdlib/commit/e1296c1c5634fbcf5e007695391c944fef27e6aa) - **fix:** update include paths and reorder includes _(by Athan Reines)_
 -   [`90e96d0`](https://github.com/stdlib-js/stdlib/commit/90e96d01b7a32ec3b71caf3e5f57528338199a8f) - **chore:** minor clean-up _(by Philipp Burckhardt)_
 -   [`2777e4b`](https://github.com/stdlib-js/stdlib/commit/2777e4be161869d09406e3b17947d24c64b47af2) - **bench:** resolve lint errors in benchmarks _(by Athan Reines)_
 -   [`d04dcbd`](https://github.com/stdlib-js/stdlib/commit/d04dcbd6dc3b0bf4a89bd3947d317fa5ff15bb38) - **docs:** remove private annotations in C comments _(by Philipp Burckhardt)_

CONTRIBUTORS

@@ -27,6 +27,7 @@ Daniel Killenberger <daniel.killenberger@gmail.com>
 Daniel Yu <40680511+Daniel777y@users.noreply.github.com>
 Debashis Maharana <debashismaharana7854@gmail.com>
 Desh Deepak Kant <118960904+DeshDeepakKant@users.noreply.github.com>
+Dhruv/ <154677013+DhruvArvindSingh@users.noreply.github.com>
 Divyansh Seth <59174836+sethdivyansh@users.noreply.github.com>
 Dominic Lim <46486515+domlimm@users.noreply.github.com>
 Dominik Moritz <domoritz@gmail.com>

README.md

@@ -375,7 +375,7 @@ For more information on the project, filing bug reports and feature requests, an
 
 ## Copyright
 
-Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
+Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].
 
 </section>
 

benchmark/c/benchmark.c

@@ -16,14 +16,14 @@
 * limitations under the License.
 */
 
+#include "stdlib/random/base/mt19937.h"
+#include "stdlib/random/base/shared.h"
 #include <stdlib.h>
 #include <stdio.h>
 #include <stdint.h>
 #include <math.h>
 #include <time.h>
 #include <sys/time.h>
-#include "stdlib/random/base.h"
-#include "stdlib/random/base/mt19937.h"
 
 #define NAME "base/mt19937"
 #define ITERATIONS 1000000

examples/c/example.c

@@ -17,7 +17,7 @@
 */
 
 #include "stdlib/random/base/mt19937.h"
-#include "stdlib/random/base.h"
+#include "stdlib/random/base/shared.h"
 #include <stdlib.h>
 #include <stdio.h>
 #include <inttypes.h>

include/stdlib/random/base/mt19937.h

@@ -19,9 +19,8 @@
 #ifndef STDLIB_RANDOM_BASE_MT19937_H
 #define STDLIB_RANDOM_BASE_MT19937_H
 
-// Note: keep project includes in alphabetical order...
+#include "stdlib/random/base/shared.h"
 #include <stdint.h>
-#include "stdlib/random/base.h"
 
 /*
 * If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler.

src/main.c

@@ -55,12 +55,11 @@
 * [mt19937]: http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/MT2002/CODES/mt19937ar.c
 */
 
-// Note: keep project includes in alphabetical order...
+#include "stdlib/random/base/mt19937.h"
+#include "stdlib/random/base/shared.h"
 #include <stdlib.h>
 #include <stdint.h>
 #include <string.h>
-#include "stdlib/random/base.h"
-#include "stdlib/random/base/mt19937.h"
 
 // Forward declarations:
 static inline int8_t next( struct BasePRNGObject *obj, uint64_t *out );
@@ -392,11 +391,11 @@ static inline void twist( uint32_t *state, const int32_t N ) {
 * @return      pointer to a dynamically allocated PRNG or, if unable to allocate memory, a null pointer
 *
 * @example
+* #include "stdlib/random/base/mt19937.h"
+* #include "stdlib/random/base/shared.h"
 * #include <stdlib.h>
 * #include <stdio.h>
 * #include <stdint.h>
-* #include "stdlib/random/base.h"
-* #include "stdlib/random/base/mt19937.h"
 *
 * // Define a PRNG seed:
 * uint32_t seed[] = { 12345 };
@@ -472,11 +471,11 @@ struct BasePRNGObject * stdlib_base_random_mt19937_allocate( const uint32_t *see
 * @param obj  PRNG object
 *
 * @example
+* #include "stdlib/random/base/mt19937.h"
+* #include "stdlib/random/base/shared.h"
 * #include <stdlib.h>
 * #include <stdio.h>
 * #include <stdint.h>
-* #include "stdlib/random/base.h"
-* #include "stdlib/random/base/mt19937.h"
 *
 * // Define a PRNG seed:
 * uint32_t seed[] = { 12345 };
@@ -527,11 +526,11 @@ void stdlib_base_random_mt19937_free( struct BasePRNGObject *obj ) {
 * @return      status code
 *
 * @example
+* #include "stdlib/random/base/mt19937.h"
+* #include "stdlib/random/base/shared.h"
 * #include <stdlib.h>
 * #include <stdio.h>
 * #include <stdint.h>
-* #include "stdlib/random/base.h"
-* #include "stdlib/random/base/mt19937.h"
 *
 * // Define a PRNG seed:
 * uint32_t seed1[] = { 12345 };
@@ -596,11 +595,11 @@ int8_t stdlib_base_random_mt19937_seed_length( const struct BasePRNGObject *obj,
 * @return      status code
 *
 * @example
+* #include "stdlib/random/base/mt19937.h"
+* #include "stdlib/random/base/shared.h"
 * #include <stdlib.h>
 * #include <stdio.h>
 * #include <stdint.h>
-* #include "stdlib/random/base.h"
-* #include "stdlib/random/base/mt19937.h"
 *
 * // Define a PRNG seed:
 * uint32_t seed1[] = { 12345 };
@@ -664,11 +663,11 @@ int8_t stdlib_base_random_mt19937_seed( const struct BasePRNGObject *obj, uint32
 * @return     pointer to a copy of the PRNG's internal state or, if unable to allocate memory, a null pointer
 *
 * @example
+* #include "stdlib/random/base/mt19937.h"
+* #include "stdlib/random/base/shared.h"
 * #include <stdlib.h>
 * #include <stdio.h>
 * #include <stdint.h>
-* #include "stdlib/random/base.h"
-* #include "stdlib/random/base/mt19937.h"
 *
 * // Define a PRNG seed:
 * uint32_t seed[] = { 12345 };
@@ -695,8 +694,8 @@ int8_t stdlib_base_random_mt19937_seed( const struct BasePRNGObject *obj, uint32
 * free( state );
 */
 void * stdlib_base_random_mt19937_state( const struct BasePRNGObject *obj ) {
+	const stdlib_base_random_mt19937_state_t *so;
 	stdlib_base_random_mt19937_state_t *state;
-	stdlib_base_random_mt19937_state_t *so;
 	uint64_t nbytes;
 	uint32_t *seed;
 	if ( obj == NULL || obj->prng != &mt19937_prng ) {
@@ -735,11 +734,11 @@ void * stdlib_base_random_mt19937_state( const struct BasePRNGObject *obj ) {
 * @return       status code
 *
 * @example
+* #include "stdlib/random/base/mt19937.h"
+* #include "stdlib/random/base/shared.h"
 * #include <stdlib.h>
 * #include <stdio.h>
 * #include <stdint.h>
-* #include "stdlib/random/base.h"
-* #include "stdlib/random/base/mt19937.h"
 *
 * // Define a PRNG seed:
 * uint32_t seed[] = { 12345 };