Merge branch 'develop' of https://github.com/stdlib-js/stdlib into develop

Author: kgryte

lib/node_modules/@stdlib/_tools/licenses/licenses/README.md

@@ -38,7 +38,7 @@ var licenses = require( '@stdlib/_tools/licenses/licenses' );
 
 #### licenses( \[options], clbk )
 
-Reads installed package dependencies and extracts license information from `package.json` files. 
+Reads installed package dependencies and extracts license information from `package.json` files.
 
 ```javascript
 licenses( onResults );

lib/node_modules/@stdlib/math/base/special/cinv/README.md

@@ -228,6 +228,7 @@ int main() {
 ## See Also
 
 -   <span class="package-name">[`@stdlib/complex/float64/base/div`][@stdlib/complex/float64/base/div]</span><span class="delimiter">: </span><span class="description">divide two complex numbers.</span>
+-   <span class="package-name">[`@stdlib/math/base/special/cinvf`][@stdlib/math/base/special/cinvf]</span><span class="delimiter">: </span><span class="description">compute the inverse of a single-precision complex floating-point number.</span>
 
 </section>
 
@@ -249,6 +250,8 @@ int main() {
 
 [@stdlib/complex/float64/base/div]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/div
 
+[@stdlib/math/base/special/cinvf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cinvf
+
 <!-- </related-links> -->
 
 </section>

lib/node_modules/@stdlib/math/base/special/cosm1/lib/index.js

@@ -31,7 +31,7 @@
 * // returns 0.0
 *
 * v = cosm1( PI/4.0 );
-* // returns ~-0.291
+* // returns ~-0.293
 *
 * v = cosm1( -PI/6.0 );
 * // returns ~-0.134

lib/node_modules/@stdlib/math/base/special/cosm1/test/fixtures/python/data.json

@@ -53,7 +53,7 @@ def gen(x, name):
     }
 
     # Based on the script directory, create an output filepath:
-    filepath = os.path.join(dir, name)
+    filepath = os.path.join(DIR, name)
 
     # Write the data to the output filepath as JSON:
     with open(filepath, "w", encoding="utf-8") as outfile:

lib/node_modules/@stdlib/math/base/special/cosm1/test/fixtures/python/runner.py

@@ -47,14 +47,12 @@ var data = require( './fixtures/python/data.json' );
 
 tape( 'main export is a function', function test( t ) {
 	t.ok( true, __filename );
-	t.strictEqual( typeof cos, 'function', 'main export is a function' );
+	t.strictEqual( typeof cosm1, 'function', 'main export is a function' );
 	t.end();
 });
 
 tape( 'the function computes the cosine minus one more accurately inside the interval [-π/4,π/4]', function test( t ) {
 	var expected;
-	var delta;
-	var tol;
 	var x;
 	var y;
 	var i;
@@ -64,13 +62,7 @@ tape( 'the function computes the cosine minus one more accurately inside the int
 
 	for ( i = 0; i < x.length; i++ ) {
 		y = cosm1( x[i] );
-		if ( y === expected[ i ] ) {
-			t.strictEqual( y, expected[ i ], 'x: '+x[i]+'. E: '+expected[i] );
-		} else {
-			delta = abs( y - expected[i] );
-			tol = 2.0 * EPS * abs( expected[i] );
-			t.ok( delta <= tol, 'within tolerance. x: '+x[i]+'. Value: '+y+'. E: '+expected[i]+'. tol: '+tol+'. Δ: '+delta+'.' );
-		}
+		t.strictEqual( y, expected[ i ], 'returns expected value' );
 	}
 
 	t.end();

lib/node_modules/@stdlib/math/base/special/cosm1/test/test.js

@@ -52,14 +52,12 @@ var data = require( './fixtures/python/data.json' );
 
 tape( 'main export is a function', opts, function test( t ) {
 	t.ok( true, __filename );
-	t.strictEqual( typeof cos, 'function', 'main export is a function' );
+	t.strictEqual( typeof cosm1, 'function', 'main export is a function' );
 	t.end();
 });
 
 tape( 'the function computes the cosine minus one more accurately inside the interval [-π/4,π/4]', opts, function test( t ) {
 	var expected;
-	var delta;
-	var tol;
 	var x;
 	var y;
 	var i;
@@ -69,13 +67,7 @@ tape( 'the function computes the cosine minus one more accurately inside the int
 
 	for ( i = 0; i < x.length; i++ ) {
 		y = cosm1( x[i] );
-		if ( y === expected[ i ] ) {
-			t.strictEqual( y, expected[ i ], 'x: '+x[i]+'. E: '+expected[i] );
-		} else {
-			delta = abs( y - expected[i] );
-			tol = 2.0 * EPS * abs( expected[i] );
-			t.ok( delta <= tol, 'within tolerance. x: '+x[i]+'. Value: '+y+'. E: '+expected[i]+'. tol: '+tol+'. Δ: '+delta+'.' );
-		}
+		t.strictEqual( y, expected[ i ], 'returns expected value' );
 	}
 
 	t.end();

lib/node_modules/@stdlib/math/base/special/cosm1/test/test.native.js

@@ -0,0 +1,200 @@
+<!--
+
+@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.
+
+-->
+
+# Hacovercosine
+
+> Compute the half-value [coversed cosine][coversed-cosine] of a single-precision floating-point number (in radians).
+
+<section class="intro">
+
+The half-value [coversed cosine][coversed-cosine] is defined as
+
+<!-- <equation class="equation" label="eq:hacovercosine" align="center" raw="\operatorname{hacovercos}(\theta) = \frac{1 + \sin \theta}{2}" alt="Half-value coversed cosine."> -->
+
+```math
+\mathop{\mathrm{hacovercos}}(\theta) = \frac{1 + \sin \theta}{2}
+```
+
+<!-- </equation> -->
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var hacovercosf = require( '@stdlib/math/base/special/hacovercosf' );
+```
+
+#### hacovercosf( x )
+
+Computes the half-value [coversed cosine][coversed-cosine] of a single-precision floating-point number (in radians).
+
+```javascript
+var v = hacovercosf( 0.0 );
+// returns 0.5
+
+v = hacovercosf( 3.141592653589793/2.0 );
+// returns 1.0
+
+v = hacovercosf( -3.141592653589793/6.0 );
+// returns 0.25
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var uniform = require( '@stdlib/random/array/uniform' );
+var logEachMap = require( '@stdlib/console/log-each-map' );
+var TWO_PI = require( '@stdlib/constants/float32/two-pi' );
+var hacovercosf = require( '@stdlib/math/base/special/hacovercosf' );
+
+var opts = {
+    'dtype': 'float32'
+};
+var x = uniform( 100, 0.0, TWO_PI, opts );
+
+logEachMap( 'hacovercosf(%0.4f) = %0.4f', x, hacovercosf );
+```
+
+</section>
+
+<!-- /.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/hacovercosf.h"
+```
+
+#### stdlib_base_hacovercosf( x )
+
+Computes the half-value [coversed cosine][coversed-cosine] of a single-precision floating-point number (in radians).
+
+```c
+float out = stdlib_base_hacovercosf( 0.0f );
+// returns 0.5f
+
+out = stdlib_base_hacovercosf( 3.141592653589793f / 2.0f );
+// returns 1.0f
+```
+
+The function accepts the following arguments:
+
+-   **x**: `[in] float` input value (in radians).
+
+```c
+float stdlib_base_hacovercosf( const float x );
+```
+
+</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/hacovercosf.h"
+#include <stdio.h>
+
+int main( void ) {
+    const float x[] = { 0.0f, 0.523f, 0.785f, 1.047f, 3.14f };
+
+    float y;
+    int i;
+    for ( i = 0; i < 5; i++ ) {
+        y = stdlib_base_hacovercosf( x[ i ] );
+        printf( "hacovercosf(%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">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[coversed-cosine]: https://en.wikipedia.org/wiki/Versine
+
+<!-- <related-links> -->
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/math/base/special/hacovercosf/README.md

@@ -0,0 +1,54 @@
+/**
+* @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 bench = require( '@stdlib/bench' );
+var uniform = require( '@stdlib/random/array/uniform' );
+var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
+var pkg = require( './../package.json' ).name;
+var hacovercosf = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var x;
+	var y;
+	var i;
+
+	x = uniform( 100, -10.0, 10.0, {
+		'dtype': 'float32'
+	});
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		y = hacovercosf( 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();
+});