feat: add math/base/special/wrapf

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

@@ -0,0 +1,255 @@
+<!--
+
+@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.
+
+-->
+
+# wrapf
+
+> Wrap a value on the half-open interval `[min,max)` for single-precision floating-point numbers.
+
+<!-- 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 -->
+
+<!-- Package usage documentation. -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var wrapf = require( '@stdlib/math/base/special/wrapf' );
+```
+
+#### wrapf( v, min, max )
+
+Wraps a value on the half-open interval `[min,max)`.
+
+```javascript
+var v = wrapf( 3.14, 0.0, 5.0 );
+// returns 3.14
+
+v = wrapf( -3.14, 0.0, 5.0 );
+// returns ~1.86
+
+v = wrapf( 10.0, 0.0, 5.0 );
+// returns 0.0
+
+v = wrapf( -0.0, 0.0, 5.0 );
+// returns 0.0
+
+v = wrapf( 0.0, -3.14, -0.0 );
+// returns -3.14
+```
+
+If provided `NaN` for any argument, the function returns `NaN`.
+
+```javascript
+var v = wrapf( NaN, 0.0, 5.0 );
+// returns NaN
+
+v = wrapf( 0.0, NaN, 5.0 );
+// returns NaN
+
+v = wrapf( 3.14, 0.0, NaN );
+// returns NaN
+```
+
+If provided `min == max`, the function returns `NaN`.
+
+```javascript
+var v = wrapf( 3.14, 3.0, 3.0 );
+// returns NaN
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+## Notes
+
+-   The function does **not** distinguish between positive and negative zero. Where appropriate, the function returns positive zero.
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
+var wrapf = require( '@stdlib/math/base/special/wrapf' );
+
+var min;
+var max;
+var v;
+var i;
+
+for ( i = 0; i < 100; i++ ) {
+    min = discreteUniform( 0.0, 10.0 );
+    max = discreteUniform( 5.0, 15.0 );
+    v = discreteUniform( -20.0, 20.0 );
+    console.log( 'wrapf(%d,%d,%d) => %d', v, min, max, wrapf( v, min, max ) );
+}
+```
+
+</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/wrapf.h"
+```
+
+#### stdlib_base_wrapf( v, min, max )
+
+Wraps a value on the half-open interval `[min,max)` for single-precision floating-point numbers.
+
+```c
+float v = stdlib_base_wrapf( 3.14, 0.0, 5.0 );
+// returns 3.14
+
+v = stdlib_base_wrapf( -3.14, 0.0, 5.0 );
+// returns ~1.86
+```
+
+The function accepts the following arguments:
+
+-   **v**: `[in] float` input value to wrap.
+-   **min**: `[in] float` minimum value.
+-   **max**: `[in] float` maximum value.
+
+```c
+float stdlib_base_wrapf( const float v, const float min, const float max )
+```
+
+</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/wrapf.h"
+#include <stdio.h>
+
+int main( void ) {
+    const float min[] = { 0.0, 0.0, 0.0, 0.0, -3.14 };
+    const float max[] = { 5.0, 5.0, 5.0, 5.0, -0.0 };
+    const float v[] = { 3.14, -3.14, 10.0, -0.0, 0.0 };
+
+    float out;
+    int i;
+    for ( i = 0; i < 5; i++ ) {
+        out = stdlib_base_wrapf( v[i], min[i], max[i] );
+        printf( "wrapf(%f,%f,%f) => %f\n", v[i], min[i], max[i], out );
+    }
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
+<!-- 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">
+
+</section>
+
+<!-- /.references -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/math/base/special/clampf`][@stdlib/math/base/special/clampf]</span><span class="delimiter">: </span><span class="description">restrict a single-precision floating-point number to a specified range.</span>
+
+</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> -->
+
+[@stdlib/math/base/special/clampf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/clampf
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/math/base/special/wrapf/benchmark/benchmark.js

@@ -0,0 +1,51 @@
+/**
+* @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/base/randu' );
+var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
+var pkg = require( './../package.json' ).name;
+var wrapf = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var x;
+	var y;
+	var i;
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		x = ( randu()*20.0 ) - 10.0;
+		y = wrapf( x, -5.0, 5.0 );
+		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();
+});

lib/node_modules/@stdlib/math/base/special/wrapf/benchmark/benchmark.native.js

@@ -0,0 +1,60 @@
+/**
+* @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/base/randu' );
+var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
+var tryRequire = require( '@stdlib/utils/try-require' );
+var pkg = require( './../package.json' ).name;
+
+
+// VARIABLES //
+
+var wrapf = tryRequire( resolve( __dirname, './../lib/native.js' ) );
+var opts = {
+	'skip': ( wrapf instanceof Error )
+};
+
+
+// MAIN //
+
+bench( pkg+'::native', opts, function benchmark( b ) {
+	var x;
+	var y;
+	var i;
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		x = ( randu()*20.0 ) - 10.0;
+		y = wrapf( x, -5.0, 5.0 );
+		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();
+});