Skip to content

feat: add math/base/special/roundnf #9389

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Planeshifter merged 19 commits into from
Jan 8, 2026
Merged

feat: add math/base/special/roundnf #9389

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
54a0638
feat: add math/base/special/roundnf
Amansingh0807 Dec 27, 2025
763596a
fix: correct float32 doctest values and lint errors in roundnf
Amansingh0807 Dec 27, 2025
153d4e9
fixes the Lint errors
Amansingh0807 Dec 27, 2025
ff1cfab
fixes the Lint errors
Amansingh0807 Dec 27, 2025
15255de
fix: resolve all CI errors - float32 precision, lint fixes, and N-API…
Amansingh0807 Dec 27, 2025
6737724
fix: resolve lint errors in test.native.js
Amansingh0807 Dec 27, 2025
8a020f2
refactor: use standard N-API pattern matching ldexpf convention
Amansingh0807 Dec 27, 2025
07c8f39
test: add edge case tests for n=±Infinity and extreme exponent values
Amansingh0807 Dec 28, 2025
2df69c1
docs: fix examples
anandkaranubc Dec 30, 2025
e80d5d6
fix: use correct `f32` emulation
anandkaranubc Dec 30, 2025
dd9e666
docs: fix examples
anandkaranubc Dec 31, 2025
6271ce2
docs: fix examples
anandkaranubc Dec 31, 2025
8669756
chore: change the order of type casting
anandkaranubc Dec 31, 2025
fef58ac
Fix roundnf: address PR review comments with ulpdiff testing and docu…
Amansingh0807 Dec 31, 2025
c3318fb
Fix roundnf native tests: remove NaN/Infinity tests for n parameter
Amansingh0807 Dec 31, 2025
838432c
docs: match C example with README section
Amansingh0807 Jan 7, 2026
248bc4c
Merge remote-tracking branch 'upstream/develop' into feat-math-base-s…
stdlib-bot Jan 7, 2026
2e3ddcd
chore: update copyright years
stdlib-bot Jan 7, 2026
6911adc
style: remove leading spaces before TSDoc lines
Planeshifter Jan 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
214 changes: 214 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/roundnf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,214 @@
<!--

@license Apache-2.0

Copyright (c) 2026 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.

-->

# roundnf

> Round a single-precision floating-point number to the nearest multiple of 10^n.

<section class="usage">

## Usage

```javascript
var roundnf = require( '@stdlib/math/base/special/roundnf' );
```

#### roundnf( x, n )

Rounds a single-precision floating-point number to the nearest multiple of `10^n`.

```javascript
// Round a value to 2 decimal places:
var v = roundnf( 3.1415927410125732, -2 );
// returns ~3.14

// If n = 0, `roundnf` behaves like `roundf`:
v = roundnf( 3.1415927410125732, 0 );
// returns 3.0

// Round a value to the nearest thousand:
v = roundnf( 12368.0, 3 );
// returns ~12000.0
```

</section>

<!-- /.usage -->

<section class="notes">

## Notes

- When operating on [floating-point numbers][ieee754] in bases other than `2`, rounding to specified digits can be **inexact**. For example,

```javascript
var x = 0.2 + 0.1;
// returns 0.30000000000000004

// Should round to 0.3...
var v = roundnf( x, -16 );
// returns 0.30000001192092896
```

- Ties are rounded toward positive infinity.

</section>

<!-- /.notes -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var uniform = require( '@stdlib/random/array/uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var roundnf = require( '@stdlib/math/base/special/roundnf' );

var x = uniform( 100, -50.0, 50.0, {
'dtype': 'float32'
});

var n = discreteUniform( 100, -5, 0, {
'dtype': 'int32'
});

logEachMap( 'x: %0.8f. Number of decimals: %d. Rounded: %0.8f', x, n, roundnf );
```

</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/roundnf.h"
```

#### stdlib_base_roundnf( x, n )

Rounds a single-precision floating-point number to the nearest multiple of `10^n`.

```c
// Round a value to 2 decimal places:
float y = stdlib_base_roundnf( 3.14159f, -2 );
// returns ~3.14f

// If n = 0, `roundnf` behaves like `roundf`:
y = stdlib_base_roundnf( 3.14159f, 0 );
// returns 3.0f
```

The function accepts the following arguments:

- **x**: `[in] float` input value.
- **n**: `[in] int32_t` integer power of 10.

```c
float stdlib_base_roundnf( const float x, const int32_t n );
```

</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/roundnf.h"
#include <stdio.h>

int main( void ) {
const float x[] = { 3.14f, -3.14f, 0.0f, 0.0f/0.0f };

float y;
int i;
for ( i = 0; i < 4; i++ ) {
y = stdlib_base_roundnf( x[ i ], -2 );
printf( "roundnf(%f, -2) = %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">

[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985

<!-- <related-links> -->

<!-- </related-links> -->

</section>

<!-- /.links -->
57 changes: 57 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/roundnf/benchmark/benchmark.js
View file
Open in desktop
Copy link
Contributor

@anandkaranubc anandkaranubc Dec 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment here. Check https://github.com/stdlib-js/stdlib/blob/develop/lib/node_modules/%40stdlib/math/base/special/secf/benchmark/benchmark.js

Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2026 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 discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
var pkg = require( './../package.json' ).name;
var roundnf = require( './../lib' );


// MAIN //

bench( pkg, function benchmark( b ) {
var x;
var n;
var y;
var i;

x = uniform( 100, -100.0, 100.0, {
'dtype': 'float32'
});
n = discreteUniform( 100, -5, 0 );

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
y = roundnf( x[ i%x.length ], n[ i%n.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();
});
63 changes: 63 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/roundnf/benchmark/benchmark.native.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2026 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 discreteUniform = require( '@stdlib/random/base/discrete-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 roundnf = tryRequire( resolve( __dirname, './../lib/native.js' ) );
var opts = {
'skip': ( roundnf instanceof Error )
};


// MAIN //

bench( pkg+'::native', opts, function benchmark( b ) {

Check warning on line 42 in lib/node_modules/@stdlib/math/base/special/roundnf/benchmark/benchmark.native.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Use `@stdlib/string/format` instead of string concatenation for benchmark descriptions
var x;
var n;
var y;
var i;

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
x = ( randu() * 100.0 ) - 50.0;
n = discreteUniform( -5, 0 );
y = roundnf( x, n );
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();
});
Loading