feat: add math/base/special/round10f

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

@@ -0,0 +1,203 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2018 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.
+
+-->
+
+# round10f
+
+> Round a numeric value to the nearest multiple of \\(10^n\\) using single-precision floating-point arithmetic.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var round10f = require( '@stdlib/math/base/special/round10f' );
+```
+
+#### round10f( v, n )
+
+Rounds a numeric value to the nearest multiple of 10^n usingsingle-precision floating-point arithmetic.
+
+```javascript
+var y;
+
+y = round10f( 3.1415926, -2 );
+// returns 1
+
+y = round10f( 3.1415926, 0 );
+// returns 1
+
+y = round10f( 123.456, 1 );
+// returns 100
+
+y = round10f( -2.5, 0 );
+// returns -1
+
+y = round10f( -0.0, 0 );
+// returns -0
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="examples">
+
+## Examples
+
+```javascript
+var uniform = require( '@stdlib/random/array/uniform' );
+var logEachMap = require( '@stdlib/console/log-each-map' );
+var toFloat32 = require( '@stdlib/number/float64/base/to-float32' );
+var round10f = require( '@stdlib/math/base/special/round10f' );
+
+var opts = {
+    'dtype': 'float32'
+};
+
+var x = uniform( 100, -50.0, 50.0, opts );
+
+// Ensure float32 precision:
+var i;
+for ( i = 0; i < x.length; i++ ) {
+    x[ i ] = toFloat32( x[ i ] );
+}
+
+var n = -1;
+
+function fcn( v ) {
+    return round10f( v, n );
+}
+
+logEachMap('x: %0.4f. Rounded: %0.4f.', x, fcn);
+```
+
+</section>
+
+<!-- /.examples -->
+
+
+* * *
+
+<section class="c">
+
+## C APIs
+
+<section class="intro">
+
+This package provides a C API for rounding single-precision floating-point numbers to the nearest multiple of \\(10^n\\).
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+### Usage
+
+```c
+#include "stdlib/math/base/special/round10f.h"
+```
+
+#### stdlib_base_round10f( x, n )
+
+Rounds a single-precision floating-point number to the nearest multiple of \\(10^n\\).
+
+```c
+float out = stdlib_base_round10f( 3.14f, 0 );
+// returns 3.0f
+
+out = stdlib_base_round10f( 3.14f, -1 );
+// returns 3.1f
+```
+
+**Arguments**
+
+-   **x**: `[in] float` input value.
+-   **n**: `[in] int32_t` power of ten exponent.
+
+**Returns**
+
+-   `float`: rounded value.
+
+```c
+float stdlib_base_round10f( const float x, const int32_t n );
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="examples">
+
+### Examples
+
+```c
+#include "stdlib/math/base/special/round10f.h"
+#include <stdio.h>
+
+int main( void ) {
+    const float x[] = {
+        -5.0f, -3.89f, -2.78f, -1.67f, -0.56f,
+         0.56f,  1.67f,  2.78f,  3.89f,  5.0f
+    };
+    const int n = -1;
+
+    float v;
+    int i;
+    for ( i = 0; i < 10; i++ ) {
+        v = stdlib_base_round10f( x[ i ], n );
+        printf( "round10f(%f,%d) = %f\n", x[ i ], n, v );
+    }
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
+<section class="related">
+
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/math/base/special/ceil10`][@stdlib/math/base/special/ceil10]</span><span class="delimiter">: </span><span class="description">round a numeric value to the nearest power of 10 toward positive infinity.</span>
+-   <span class="package-name">[`@stdlib/math/base/special/floor10`][@stdlib/math/base/special/floor10]</span><span class="delimiter">: </span><span class="description">round a numeric value to the nearest power of 10 toward negative infinity.</span>
+-   <span class="package-name">[`@stdlib/math/base/special/round`][@stdlib/math/base/special/round]</span><span class="delimiter">: </span><span class="description">round a numeric value to the nearest integer.</span>
+-   <span class="package-name">[`@stdlib/math/base/special/round2`][@stdlib/math/base/special/round2]</span><span class="delimiter">: </span><span class="description">round a numeric value to the nearest power of two on a linear scale.</span>
+
+</section>
+
+<!-- /.related -->
+
+<section class="links">
+
+[@stdlib/math/base/special/ceil10]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/ceil10
+[@stdlib/math/base/special/floor10]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/floor10
+[@stdlib/math/base/special/round]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/round
+[@stdlib/math/base/special/round2]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/round2
+
+</section>
+
+<!-- /.links -->

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

@@ -0,0 +1,61 @@
+/**
+* @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 uniform = require( '@stdlib/random/array/uniform' );
+var toFloat32 = require( '@stdlib/number/float64/base/to-float32' );
+var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
+var round10f = require( './../lib/main.js' );
+var pkg = require( './../package.json' ).name;
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var exps;
+	var x;
+	var y;
+	var i;
+
+	// Generate float32 input values:
+	x = uniform( 100, -5.0e3, 5.0e3 );
+	for ( i = 0; i < x.length; i++ ) {
+		x[ i ] = toFloat32( x[ i ] );
+	}
+
+	exps = [ -3, -1, 0, 1, 3 ];
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		y = round10f( x[ i % x.length ], exps[ i % exps.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();
+});

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

@@ -0,0 +1,71 @@
+/**
+* @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 uniform = require( '@stdlib/random/array/uniform' );
+var toFloat32 = require( '@stdlib/number/float64/base/to-float32' );
+var isnan = require( '@stdlib/math/base/assert/is-nanf' );
+var tryRequire = require( '@stdlib/utils/try-require' );
+var format = require( '@stdlib/string/format' );
+var pkg = require( './../package.json' ).name;
+
+
+// VARIABLES //
+
+var round10f = tryRequire( resolve( __dirname, './../lib/native.js' ) );
+var opts = {
+	'skip': ( round10f instanceof Error )
+};
+
+
+// MAIN //
+
+bench( format( '%s::native', pkg ), opts, function benchmark( b ) {
+	var exps;
+	var x;
+	var y;
+	var i;
+
+	// Generate float32 input data:
+	x = uniform( 100, -5.0e3, 5.0e3 );
+	for ( i = 0; i < x.length; i++ ) {
+		x[ i ] = toFloat32( x[ i ] );
+	}
+
+	exps = [ -3, -1, 0, 1, 3 ];
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		y = round10f( x[ i % x.length ], exps[ i % exps.length ] );
+		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();
+});