Auto-generated commit

.editorconfig

@@ -121,7 +121,7 @@ indent_style = tab
 [*.{md,md.txt}]
 indent_style = space
 indent_size = 4
-trim_trailing_whitespace = false
+trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim.
 
 # Set properties for `usage.txt` files:
 [usage.txt]

CHANGELOG.md

@@ -2,6 +2,63 @@
 
 > Package changelog.
 
+<section class="release" id="unreleased">
+
+## Unreleased (2024-12-20)
+
+<section class="features">
+
+### Features
+
+-   [`daf43b2`](https://github.com/stdlib-js/stdlib/commit/daf43b2052a0ad89fa4c72caee6d7caedcc4cc38) - add C implementation for `stats/base/dists/triangular/mode` [(#4008)](https://github.com/stdlib-js/stdlib/pull/4008)
+
+</section>
+
+<!-- /.features -->
+
+<section class="issues">
+
+### Closed Issues
+
+This release closes the following issue:
+
+[#3819](https://github.com/stdlib-js/stdlib/issues/3819)
+
+</section>
+
+<!-- /.issues -->
+
+<section class="commits">
+
+### Commits
+
+<details>
+
+-   [`daf43b2`](https://github.com/stdlib-js/stdlib/commit/daf43b2052a0ad89fa4c72caee6d7caedcc4cc38) - **feat:** add C implementation for `stats/base/dists/triangular/mode` [(#4008)](https://github.com/stdlib-js/stdlib/pull/4008) _(by JoyBoy, Philipp Burckhardt)_
+
+</details>
+
+</section>
+
+<!-- /.commits -->
+
+<section class="contributors">
+
+### Contributors
+
+A total of 2 people contributed to this release. Thank you to the following contributors:
+
+-   JoyBoy
+-   Philipp Burckhardt
+
+</section>
+
+<!-- /.contributors -->
+
+</section>
+
+<!-- /.release -->
+
 <section class="release" id="v0.2.2">
 
 ## 0.2.2 (2024-07-27)

CONTRIBUTORS

@@ -2,12 +2,14 @@
 #
 # Contributors listed in alphabetical order.
 
+Aadish Jain <[email protected]>
 Aayush Khanna <[email protected]>
 Abhijit Raut <[email protected]>
 Adarsh Palaskar <[email protected]>
 Aditya Sapra <[email protected]>
 Ahmed Atwa <[email protected]>
 Ahmed Kashkoush <[email protected]>
+Ahmed Khaled <[email protected]>
 Aleksandr <[email protected]>
 Ali Salesi <[email protected]>
 Aman Bhansali <[email protected]>
@@ -24,6 +26,7 @@ Dan Rose <[email protected]>
 Daniel Killenberger <[email protected]>
 Daniel Yu <[email protected]>
 Debashis Maharana <[email protected]>
+Divyansh Seth <[email protected]>
 Dominic Lim <[email protected]>
 Dominik Moritz <[email protected]>
 Dorrin Sotoudeh <[email protected]>
@@ -46,11 +49,10 @@ Jordan Gallivan <[email protected]>
 Joris Labie <[email protected]>
 Justin Dennison <[email protected]>
 Karthik Prakash <[email protected]>
-Khaldon <[email protected]>
 Kohantika Nath <[email protected]>
 Krishnendu Das <[email protected]>
 Kshitij-Dale <[email protected]>
-Lovelin <[email protected]>
+Lovelin Dhoni J B <[email protected]>
 Manik Sharma <[email protected]>
 Manvith M <[email protected]>
 Marcus Fantham <[email protected]>
@@ -61,6 +63,7 @@ Mohammad Kaif <[email protected]>
 Momtchil Momtchev <[email protected]>
 Muhammad Haris <[email protected]>
 Naresh Jagadeesan <[email protected]>
+Naveen Kumar <[email protected]>
 Neeraj Pathak <[email protected]>
 Nishant Shinde <[email protected]>
 Nithin Katta <[email protected]>
@@ -71,10 +74,10 @@ Ori Miles <[email protected]>
 Philipp Burckhardt <[email protected]>
 Prajwal Kulkarni <[email protected]>
 Pranav Goswami <[email protected]>
-Praneki <[email protected]>
-Pratik <[email protected]>
+Pranjal Jha <[email protected]>
+Pratik Singh <[email protected]>
 Pratyush Kumar Chouhan <[email protected]>
-Priyansh <[email protected]>
+Priyansh Prajapati <[email protected]>
 Priyanshu Agarwal <[email protected]>
 Pushpendra Chandravanshi <[email protected]>
 Raunak Kumar Gupta <[email protected]>
@@ -93,7 +96,7 @@ Sarthak Paandey <[email protected]>
 Saurabh Singh <[email protected]>
 Seyyed Parsa Neshaei <[email protected]>
 Shashank Shekhar Singh <[email protected]>
-Shivam <[email protected]>
+Shivam Ahir <[email protected]>
 Shraddheya Shendre <[email protected]>
 Shubh Mehta <[email protected]>
 Shubham Mishra <[email protected]>
@@ -112,10 +115,10 @@ UtkershBasnet <[email protected]>
 Vaibhav Patel <[email protected]>
 Varad Gupta <[email protected]>
 Vinit Pandit <[email protected]>
+Vivek maurya <[email protected]>
 Xiaochuan Ye <[email protected]>
 Yaswanth Kosuru <[email protected]>
 Yernar Yergaziyev <[email protected]>
-naveen <[email protected]>
 olenkabilonizhka <[email protected]>
 rainn <[email protected]>
 rei2hu <[email protected]>

README.md

@@ -172,6 +172,100 @@ for ( i = 0; i < 10; i++ ) {
 
 <!-- /.examples -->
 
+<!-- C interface documentation. -->
+
+* * *
+
+<section class="c">
+
+## C APIs
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- C usage documentation. -->
+
+<section class="usage">
+
+### Usage
+
+```c
+#include "stdlib/stats/base/dists/triangular/mode.h"
+```
+
+#### stdlib_base_dists_triangular_mode( a, b, c )
+
+Returns the [mode][mode] of a [triangular][triangular-distribution] distribution.
+
+```c
+double out = stdlib_base_dists_triangular_mode( 0.0, 1.0, 0.5 );
+// returns 0.5
+```
+
+The function accepts the following arguments:
+
+-   **a**: `[in] double` minimum support.
+-   **b**: `[in] double` maximum support.
+-   **c**: `[in] double` mode.
+
+```c
+double stdlib_base_dists_triangular_mode( const double a, const double b, const double c );
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- C API usage examples. -->
+
+<section class="examples">
+
+### Examples
+
+```c
+#include "stdlib/stats/base/dists/triangular/mode.h"
+#include <stdlib.h>
+#include <stdio.h>
+
+static double random_uniform( const double min, const double max ) {
+    double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
+    return min + ( v*(max-min) );
+}
+
+int main( void ) {
+    double a;
+    double b;
+    double c;
+    double y;
+    int i;
+
+    for ( i = 0; i < 25; i++ ) {
+        a = random_uniform( 0.0, 10.0 );
+        b = random_uniform( 0.0, 10.0 ) + a;
+        c = a + (b - a) * random_uniform( 0.0, 1.0 ); // mode between a and b
+        y = stdlib_base_dists_triangular_mode( a, b, c );
+        printf( "a: %lf, b: %lf, c: %lf, M(X;a,b,c): %lf\n", a, b, c, y );
+    }
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
 <!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
 
 <section class="references">

benchmark/benchmark.js

@@ -21,28 +21,36 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench-harness' );
+var Float64Array = require( '@stdlib/array-float64' );
 var randu = require( '@stdlib/random-base-randu' );
 var isnan = require( '@stdlib/math-base-assert-is-nan' );
-var EPS = require( '@stdlib/constants-float64-eps' );
 var pkg = require( './../package.json' ).name;
 var mode = require( './../lib' );
 
 
 // MAIN //
 
 bench( pkg, function benchmark( b ) {
-	var min;
-	var max;
+	var bnd;
+	var len;
+	var a;
 	var c;
 	var y;
 	var i;
 
+	len = 100;
+	a = new Float64Array( len );
+	bnd = new Float64Array( len );
+	c = new Float64Array( len );
+	for ( i = 0; i < len; i++ ) {
+		a[ i ] = randu() * 20.0;
+		bnd[ i ] = ( randu() * 20.0 ) + a[ i ];
+		c[ i ] = ( randu() * ( bnd[i] - a[i] ) ) + a[i];
+	}
+
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		min = ( randu()*10.0 );
-		max = ( randu()*10.0 ) + min + EPS;
-		c = ( ( max - min ) * randu() ) + min;
-		y = mode( min, max, c );
+		y = mode( a[i % len], bnd[i % len], c[i % len] );
 		if ( isnan( y ) ) {
 			b.fail( 'should not return NaN' );
 		}

benchmark/benchmark.native.js

@@ -0,0 +1,73 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var resolve = require( 'path' ).resolve;
+var bench = require( '@stdlib/bench-harness' );
+var Float64Array = require( '@stdlib/array-float64' );
+var randu = require( '@stdlib/random-base-randu' );
+var isnan = require( '@stdlib/math-base-assert-is-nan' );
+var tryRequire = require( '@stdlib/utils-try-require' );
+var pkg = require( './../package.json' ).name;
+
+
+// VARIABLES //
+
+var mode = tryRequire( resolve( __dirname, './../lib/native.js' ) );
+var opts = {
+	'skip': ( mode instanceof Error )
+};
+
+
+// MAIN //
+
+bench( pkg+'::native', opts, function benchmark( b ) {
+	var bnd;
+	var len;
+	var a;
+	var c;
+	var y;
+	var i;
+
+	len = 100;
+	a = new Float64Array( len );
+	bnd = new Float64Array( len );
+	c = new Float64Array( len );
+	for ( i = 0; i < len; i++ ) {
+		a[ i ] = ( randu() * 20.0 ); // Lower bound
+		bnd[ i ] = ( randu() * 20.0 ) + a[ i ]; // Upper bound
+		c[ i ] = ( randu() * ( bnd[i] - a[i] ) ) + a[i]; // Mode
+	}
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		y = mode( a[ i % len ], bnd[ i % len ], c[ i % len ] );
+		if ( isnan( y ) ) {
+			b.fail( 'should not return NaN' );
+		}
+	}
+	b.toc();
+	if ( isnan( y ) ) {
+		b.fail( 'should not return NaN' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});