Auto-generated commit

stdlib-js · Aug 24, 2024 · 0f5ff7c · 0f5ff7c
1 parent 52b2192
commit 0f5ff7c
Show file tree

Hide file tree

Showing 30 changed files with 2,178 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -120,6 +120,28 @@
 
 <!-- /.package -->
 
+<section class="package" id="math-base-special-xlogyf-unreleased">
+
+#### [@stdlib/math/base/special/xlogyf](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/xlogyf)
+
+<details>
+
+<section class="features">
+
+##### Features
+
+-   [`16c19b6`](https://github.com/stdlib-js/stdlib/commit/16c19b67c7452b3ae9755cc7ef2a5d2540ab1cf9) - add `math/base/special/xlogyf` [(#2813)](https://github.com/stdlib-js/stdlib/pull/2813)
+
+</section>
+
+<!-- /.features -->
+
+</details>
+
+</section>
+
+<!-- /.package -->
+
 </section>
 
 <!-- /.packages -->
@@ -144,6 +166,7 @@ A total of 3 people contributed to this release. Thank you to the following cont
 
 <details>
 
+-   [`16c19b6`](https://github.com/stdlib-js/stdlib/commit/16c19b67c7452b3ae9755cc7ef2a5d2540ab1cf9) - **feat:** add `math/base/special/xlogyf` [(#2813)](https://github.com/stdlib-js/stdlib/pull/2813) _(by Gunj Joshi)_
 -   [`71c43cf`](https://github.com/stdlib-js/stdlib/commit/71c43cf5165749e2ce2647cb52d92f6c97f16959) - **feat:** add `math/base/special/ldexpf` _(by Gunj Joshi, Philipp Burckhardt)_
 -   [`6c8f019`](https://github.com/stdlib-js/stdlib/commit/6c8f019db8adb12466250957693edb9830496a7b) - **feat:** add `math/base/special/logf` _(by Gunj Joshi, Philipp Burckhardt)_
 -   [`50b38f9`](https://github.com/stdlib-js/stdlib/commit/50b38f941b50a3f71b531d965c7312d4c6932f84) - **feat:** add `math/base/special/acotdf` [(#2799)](https://github.com/stdlib-js/stdlib/pull/2799) _(by Gunj Joshi)_

diff --git a/base/special/xlogyf/README.md b/base/special/xlogyf/README.md
@@ -0,0 +1,200 @@
+<!--
+
+@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.
+
+-->
+
+# xlogyf
+
+> Compute `x * ln(y)` so that the result is `0` if `x = 0` for single-precision floating-point numbers `x` and `y`.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var xlogyf = require( '@stdlib/math/base/special/xlogyf' );
+```
+
+#### xlogyf( x, y )
+
+Computes `x * ln(y)` so that the result is `0` if `x = 0` for single-precision floating-point numbers `x` and `y`.
+
+```javascript
+var out = xlogyf( 3.0, 2.0 );
+// returns ~2.079
+
+out = xlogyf( 1.5, 5.9 );
+// returns ~2.662
+
+out = xlogyf( 0.9, 1.0 );
+// returns 0.0
+
+out = xlogyf( 0.0, -2.0 );
+// returns 0.0
+
+out = xlogyf( 1.5, NaN );
+// returns NaN
+
+out = xlogyf( 0.0, NaN );
+// returns NaN
+
+out = xlogyf( NaN, 2.3 );
+// returns NaN
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var randu = require( '@stdlib/random/base/randu' );
+var xlogyf = require( '@stdlib/math/base/special/xlogyf' );
+
+var x;
+var y;
+var i;
+
+for ( i = 0; i < 100; i++ ) {
+    x = randu();
+    if ( x < 0.5 ) {
+        x = 0.0;
+    }
+    y = ( randu() * 20.0 ) - 5.0;
+    console.log( 'xlogyf(%d, %d) = %d', x, y, xlogyf( x, y ) );
+}
+```
+
+</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/xlogyf.h"
+```
+
+#### stdlib_base_xlogyf( x, y )
+
+Computes `x * ln(y)` so that the result is `0` if `x = 0` for single-precision floating-point numbers `x` and `y`.
+
+```c
+float v = stdlib_base_xlogyf( 3.0f, 2.0f );
+// returns ~2.079f
+```
+
+The function accepts the following arguments:
+
+-   **x**: `[in] float` input value.
+-   **y**: `[in] float` input value.
+
+```c
+float stdlib_base_xlogyf( const float x, const float y );
+```
+
+</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/xlogyf.h"
+#include <stdio.h>
+#include <stdlib.h>
+
+int main( void ) {
+    float out;
+    float x;
+    float y;
+    int i;
+
+    for ( i = 0; i < 100; i++ ) {
+        x = ( (float)rand() / (float)RAND_MAX ) * 100.0f;
+        y = ( (float)rand() / (float)RAND_MAX ) * 5.0f;
+        out = stdlib_base_xlogyf( x, y );
+        printf( "xlogyf(%f, %f) = %f\n", x, y, out );
+    }
+}
+```
+
+</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">
+
+<!-- <related-links> -->
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->
diff --git a/base/special/xlogyf/benchmark/benchmark.js b/base/special/xlogyf/benchmark/benchmark.js
@@ -0,0 +1,54 @@
+/**
+* @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 bench = require( '@stdlib/bench' );
+var randu = require( '@stdlib/random/array/uniform' );
+var isnanf = require( './../../../../base/assert/is-nanf' );
+var pkg = require( './../package.json' ).name;
+var xlogyf = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var out;
+	var x;
+	var y;
+	var i;
+
+	x = randu( 100, 1.0, 100.0 );
+	y = randu( 100, 1.0, 100.0 );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		out = xlogyf( x[ i % x.length ], y[ i % y.length ] );
+		if ( isnanf( out ) ) {
+			b.fail( 'should not return NaN' );
+		}
+	}
+	b.toc();
+	if ( isnanf( out ) ) {
+		b.fail( 'should not return NaN' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
diff --git a/base/special/xlogyf/benchmark/benchmark.native.js b/base/special/xlogyf/benchmark/benchmark.native.js
@@ -0,0 +1,63 @@
+/**
+* @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' );
+var randu = require( '@stdlib/random/array/uniform' );
+var isnanf = require( './../../../../base/assert/is-nanf' );
+var tryRequire = require( '@stdlib/utils/try-require' );
+var pkg = require( './../package.json' ).name;
+
+
+// VARIABLES //
+
+var xlogyf = tryRequire( resolve( __dirname, './../lib/native.js' ) );
+var opts = {
+	'skip': ( xlogyf instanceof Error )
+};
+
+
+// MAIN //
+
+bench( pkg+'::native', opts, function benchmark( b ) {
+	var out;
+	var x;
+	var y;
+	var i;
+
+	x = randu( 100, 1.0, 100.0 );
+	y = randu( 100, 1.0, 100.0 );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		out = xlogyf( x[ i % x.length ], y[ i % y.length ] );
+		if ( isnanf( out ) ) {
+			b.fail( 'should not return NaN' );
+		}
+	}
+	b.toc();
+	if ( isnanf( out ) ) {
+		b.fail( 'should not return NaN' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});