Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,12 +4,13 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-04-11)
+## Unreleased (2025-05-18)
 
 <section class="features">
 
 ### Features
 
+-   [`9b48575`](https://github.com/stdlib-js/stdlib/commit/9b48575a2670874e64b076f79ebd9989b43db5a0) - add C implementation for `math/base/special/heavisidef` [(#7022)](https://github.com/stdlib-js/stdlib/pull/7022)
 -   [`a2133de`](https://github.com/stdlib-js/stdlib/commit/a2133de85c6de60892a54b387dbf7bd1ad58e0c8) - add `math/base/special/heavisidef` [(#3374)](https://github.com/stdlib-js/stdlib/pull/3374)
 
 </section>
@@ -22,6 +23,7 @@
 
 <details>
 
+-   [`9b48575`](https://github.com/stdlib-js/stdlib/commit/9b48575a2670874e64b076f79ebd9989b43db5a0) - **feat:** add C implementation for `math/base/special/heavisidef` [(#7022)](https://github.com/stdlib-js/stdlib/pull/7022) _(by Karan Anand, stdlib-bot)_
 -   [`0395909`](https://github.com/stdlib-js/stdlib/commit/03959095fb9ffbe34ca9603b27c5204ce82d8c89) - **docs:** replace manual `for` loop in examples [(#6638)](https://github.com/stdlib-js/stdlib/pull/6638) _(by Harsh)_
 -   [`630ddb7`](https://github.com/stdlib-js/stdlib/commit/630ddb777824b5f6e501fda6dadf4ce41dccb964) - **test:** replace equal with strictEqual _(by Karan Anand)_
 -   [`a2133de`](https://github.com/stdlib-js/stdlib/commit/a2133de85c6de60892a54b387dbf7bd1ad58e0c8) - **feat:** add `math/base/special/heavisidef` [(#3374)](https://github.com/stdlib-js/stdlib/pull/3374) _(by Vivek Maurya, Athan Reines, stdlib-bot)_

CONTRIBUTORS

@@ -51,15 +51,18 @@ Dorrin Sotoudeh <dorrinsotoudeh123@gmail.com>
 EuniceSim142 <77243938+EuniceSim142@users.noreply.github.com>
 Frank Kovacs <fran70kk@gmail.com>
 GK Bishnoi <gkishan1kyt@gmail.com>
+GURU PRASAD SHARMA <168292003+GURUPRASADSHARMA@users.noreply.github.com>
 Gaurav <gaurav70380@gmail.com>
 Gautam sharma <gautamkrishnasharma1@gmail.com>
+Girish Garg <garggirish2020@gmail.com>
 Golden Kumar <103646877+AuenKr@users.noreply.github.com>
 Gunj Joshi <gunjjoshi8372@gmail.com>
 Gururaj Gurram <gururajgurram1512@gmail.com>
 Haroon Rasheed <51189276+haroon26@users.noreply.github.com>
-Harsh <149176984+hrshya@users.noreply.github.com>
+Harsh <harshyadav6078@gmail.com>
 HarshaNP <96897754+GittyHarsha@users.noreply.github.com>
 Harshita Kalani <harshitakalani02@gmail.com>
+Hemang Choudhary <coehemang@gmail.com>
 Hemant M Mehta <92446645+hemantmm@users.noreply.github.com>
 Hridyanshu <124202756+HRIDYANSHU054@users.noreply.github.com>
 Jaimin Godhani <112328542+Jai0401@users.noreply.github.com>
@@ -85,6 +88,7 @@ Kohantika Nath <145763549+kohantikanath@users.noreply.github.com>
 Krishnam Agarwal <83017176+888krishnam@users.noreply.github.com>
 Krishnendu Das <86651039+itskdhere@users.noreply.github.com>
 Kshitij-Dale <152467202+Kshitij-Dale@users.noreply.github.com>
+Lalit Narayan Yadav <162928571+LalitNarayanYadav@users.noreply.github.com>
 Lovelin Dhoni J B <100030865+lovelindhoni@users.noreply.github.com>
 MANI <77221000+Eternity0207@users.noreply.github.com>
 Mahfuza Humayra Mohona <mhmohona@gmail.com>
@@ -105,6 +109,7 @@ Naveen Kumar <stupiddint@gmail.com>
 Neeraj Pathak <neerajrpathak710@gmail.com>
 NirvedMishra <139633597+NirvedMishra@users.noreply.github.com>
 Nishant Shinde <97207366+nishant-s7@users.noreply.github.com>
+Nishant singh <38534128+Nishantsingh11@users.noreply.github.com>
 Nishchay Rajput <121144841+NishchayRajput@users.noreply.github.com>
 Nithin Katta <88046362+nithinkatta@users.noreply.github.com>
 Nourhan Hasan <109472010+TheNourhan@users.noreply.github.com>
@@ -169,6 +174,7 @@ Utkarsh <http://utkarsh11105@gmail.com>
 Utkarsh Raj <rajutkarsh2505@gmail.com>
 UtkershBasnet <119008923+UtkershBasnet@users.noreply.github.com>
 Vaibhav Patel <98279986+noobCoderVP@users.noreply.github.com>
+Vara Rahul Rajana <123227543+rajanarahul93@users.noreply.github.com>
 Varad Gupta <varadgupta21@gmail.com>
 Vinit Pandit <106718914+MeastroZI@users.noreply.github.com>
 Vivek Maurya <vm8118134@gmail.com>
@@ -177,12 +183,15 @@ Yaswanth Kosuru <116426380+yaswanthkosuru@users.noreply.github.com>
 Yernar Yergaziyev <yernar.yergaziyev@erg.kz>
 Yugal Kaushik <yugalkaushik14@gmail.com>
 Yuvi Mittal <128018763+yuvi-mittal@users.noreply.github.com>
+devshree-bhati <147095250+devshree-bhati@users.noreply.github.com>
 ditsu <170345142+ditsus@users.noreply.github.com>
 ekambains <bainsinbusiness@gmail.com>
 fadiothman22 <48636283+fadiothman22@users.noreply.github.com>
+iraandrushko <71790513+iraandrushko@users.noreply.github.com>
 lohithganni <116790357+lohithganni@users.noreply.github.com>
 olenkabilonizhka <62379231+olenkabilonizhka@users.noreply.github.com>
 pranav-1720 <123018993+pranav-1720@users.noreply.github.com>
 rahulrangers <127782777+rahulrangers@users.noreply.github.com>
 rainn <88160429+AmCodesLame@users.noreply.github.com>
 rei2hu <reimu@reimu.ws>
+zhanggy <geodaoyu@foxmail.com>

README.md

@@ -188,7 +188,7 @@ var heavisidef = require( '@stdlib/math-base-special-heavisidef' );
 var opts = {
     'dtype': 'float32'
 };
-var x = uniform( 101, -10.0, 10.0, opts );
+var x = uniform( 100, -10.0, 10.0, opts );
 
 logEachMap( 'H(%0.4f) = %0.4f', x, heavisidef );
 ```
@@ -197,6 +197,104 @@ logEachMap( 'H(%0.4f) = %0.4f', x, heavisidef );
 
 <!-- /.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/math/base/special/heavisidef.h"
+```
+
+#### stdlib_base_heavisidef( x, continuity )
+
+Evaluates the [Heaviside function][heaviside-function] for a single-precision floating-point number.
+
+```c
+float y = stdlib_base_heavisidef( 0.0f, STDLIB_BASE_HEAVISIDEF_CONTINUITY_HALF_MAXIMUM );
+// returns 0.5f
+
+y = stdlib_base_heavisidef( 0.0f, STDLIB_BASE_HEAVISIDEF_CONTINUITY_LEFT_CONTINUOUS );
+// returns 0.0f
+```
+
+The function accepts the following arguments:
+
+-   **x**: `[in] float` input value.
+-   **continuity**: `[in] STDLIB_BASE_HEAVISIDEF_CONTINUITY` continuity option.
+
+The `continuity` parameter may be one of the following values:
+
+-   `STDLIB_BASE_HEAVISIDEF_CONTINUITY_HALF_MAXIMUM`: if `x == 0`, the function returns `0.5`.
+-   `STDLIB_BASE_HEAVISIDEF_CONTINUITY_LEFT_CONTINUOUS`: if `x == 0`, the function returns `0.0`.
+-   `STDLIB_BASE_HEAVISIDEF_CONTINUITY_RIGHT_CONTINUOUS`: if `x == 0`, the function returns `1.0`.
+-   `STDLIB_BASE_HEAVISIDEF_CONTINUITY_DISCONTINUOUS`: if `x == 0`, the function returns `NaN`.
+
+If provided a `continuity` argument which is not one of the enumeration constants listed above, the function returns `NaN` for `x == 0`, behaving like the discontinuous case.
+
+```c
+float stdlib_base_heavisidef( const float x, const STDLIB_BASE_HEAVISIDEF_CONTINUITY continuity );
+```
+
+</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/math/base/special/heavisidef.h"
+#include <stdio.h>
+
+int main( void ) {
+    const float x[] = { -4.0f, -3.0f, -2.0f, -1.0f, 0.0f, 1.0f, 2.0f, 3.0f, 4.0f, 5.0f };
+
+    float y;
+    int i;
+    for ( i = 0; i < 10; i++ ) {
+        y = stdlib_base_heavisidef( x[ i ], STDLIB_BASE_HEAVISIDEF_CONTINUITY_HALF_MAXIMUM );
+        printf( "H(%f) = %f\n", x[ i ], y );
+    }
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
 <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
 
 <section class="related">

benchmark/benchmark.js

@@ -34,11 +34,13 @@ bench( pkg, function benchmark( b ) {
 	var y;
 	var i;
 
-	x = uniform( 100, -50.0, 50.0 );
+	x = uniform( 100, -50.0, 50.0, {
+		'dtype': 'float32'
+	});
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		y = heavisidef( x[ i % x.length ] );
+		y = heavisidef( x[ i%x.length ] );
 		if ( y > 1.0 ) {
 			b.fail( 'should not return a value greater than 1' );
 		}
@@ -56,11 +58,13 @@ bench( pkg+'::left-continuous', function benchmark( b ) {
 	var y;
 	var i;
 
-	x = uniform( 100, -50.0, 50.0 );
+	x = uniform( 100, -50.0, 50.0, {
+		'dtype': 'float32'
+	});
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		y = heavisidef( x[ i % x.length ], 'left-continuous' );
+		y = heavisidef( x[ i%x.length ], 'left-continuous' );
 		if ( isnanf( y ) ) {
 			b.fail( 'should not return NaN' );
 		}
@@ -78,11 +82,13 @@ bench( pkg+'::right-continuous', function benchmark( b ) {
 	var y;
 	var i;
 
-	x = uniform( 100, -50.0, 50.0 );
+	x = uniform( 100, -50.0, 50.0, {
+		'dtype': 'float32'
+	});
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		y = heavisidef( x[ i % x.length ], 'right-continuous' );
+		y = heavisidef( x[ i%x.length ], 'right-continuous' );
 		if ( isnanf( y ) ) {
 			b.fail( 'should not return NaN' );
 		}
@@ -100,11 +106,13 @@ bench( pkg+'::half-maximum', function benchmark( b ) {
 	var y;
 	var i;
 
-	x = uniform( 100, -50.0, 50.0 );
+	x = uniform( 100, -50.0, 50.0, {
+		'dtype': 'float32'
+	});
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		y = heavisidef( x[ i % x.length ], 'half-maximum' );
+		y = heavisidef( x[ i%x.length ], 'half-maximum' );
 		if ( isnanf( y ) ) {
 			b.fail( 'should not return NaN' );
 		}

benchmark/benchmark.native.js

@@ -0,0 +1,63 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2025 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 uniform = require( '@stdlib/random-array-uniform' );
+var isnanf = require( '@stdlib/math-base-assert-is-nanf' );
+var tryRequire = require( '@stdlib/utils-try-require' );
+var pkg = require( './../package.json' ).name;
+
+
+// VARIABLES //
+
+var heavisidef = tryRequire( resolve( __dirname, './../lib/native.js' ) );
+var opts = {
+	'skip': ( heavisidef instanceof Error )
+};
+
+
+// MAIN //
+
+bench( pkg+'::native', opts, function benchmark( b ) {
+	var x;
+	var y;
+	var i;
+
+	x = uniform( 100, -50.0, 50.0, {
+		'dtype': 'float32'
+	});
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		y = heavisidef( x[ i%x.length ] );
+		if ( isnanf( y ) ) {
+			b.fail( 'should not return NaN' );
+		}
+	}
+	b.toc();
+	if ( isnanf( y ) ) {
+		b.fail( 'should not return NaN' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});