-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
feat: add math/base/special/roundbf
#9679
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.
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
Open
Amansingh0807
wants to merge
9
commits into
stdlib-js:develop
Choose a base branch
from
Amansingh0807:roundbf-changes
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 3 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
4168f93
feat: add roundbf package for rounding single-precision floats to b^n
Amansingh0807 39173d2
fix: correct roundbf CI errors (package name, gypfile, addon type sig…
Amansingh0807 5e6dfe5
fix: remove flaky native n=0 random test and correct JSDoc
Amansingh0807 ad88834
Fix type documentation for base parameter b (float not int32_t)
Amansingh0807 2bef5e3
fix: change `b` parameter type from `float` to `int32_t`
Planeshifter 6dc07bf
fix: address review feedback and add f32 casting
Planeshifter bc507fa
refactor: fix include order and standardize variable naming
Planeshifter fae97f3
refactor: use `logEachMap` in examples
Planeshifter 9c17b3f
Merge branch 'develop' into roundbf-changes
Amansingh0807 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
222 changes: 222 additions & 0 deletions
222
lib/node_modules/@stdlib/math/base/special/roundbf/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,222 @@ | ||
| <!-- | ||
|
|
||
| @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. | ||
|
|
||
| --> | ||
|
|
||
| # roundbf | ||
|
|
||
| > Round a single-precision floating-point number to the nearest multiple of b^n on a linear scale. | ||
|
|
||
| <section class="usage"> | ||
|
|
||
| ## Usage | ||
|
|
||
| ```javascript | ||
| var roundbf = require( '@stdlib/math/base/special/roundbf' ); | ||
| ``` | ||
|
|
||
| #### roundbf( x, n, b ) | ||
|
|
||
| Rounds a single-precision floating-point number to the nearest multiple of `b^n` on a linear scale. | ||
|
|
||
| ```javascript | ||
| // Round a value to 2 decimal places: | ||
| var v = roundbf( 3.141592653589793, -2, 10 ); | ||
| // returns ~3.14 | ||
|
|
||
| // If n = 0 or b = 1, `roundbf` behaves like `roundf`: | ||
| v = roundbf( 3.141592653589793, 0, 2 ); | ||
| // returns 3.0 | ||
|
|
||
| // Round a value to the nearest multiple of two: | ||
| v = roundbf( 5.0, 1, 2 ); | ||
| // returns 6.0 | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.usage --> | ||
|
|
||
| <section class="notes"> | ||
|
|
||
| ## Notes | ||
|
|
||
| - Due to rounding error in [floating-point numbers][ieee754], rounding may **not** be exact. For example, | ||
|
|
||
| ```javascript | ||
| var x = 0.2 + 0.1; | ||
| // returns ~0.3 | ||
|
|
||
| // Should round to 0.3... | ||
| var v = roundbf( x, -7, 10 ); | ||
| // returns ~0.3 | ||
| ``` | ||
|
|
||
| - When operating on [floating-point numbers][ieee754] in bases other than `2`, rounding to specified digits can be **inexact**. | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.notes --> | ||
|
|
||
| <section class="examples"> | ||
|
|
||
| ## Examples | ||
|
|
||
| <!-- eslint no-undef: "error" --> | ||
|
|
||
| ```javascript | ||
| var randu = require( '@stdlib/random/base/randu' ); | ||
| var round = require( '@stdlib/math/base/special/round' ); | ||
| var powf = require( '@stdlib/math/base/special/powf' ); | ||
| var roundbf = require( '@stdlib/math/base/special/roundbf' ); | ||
|
|
||
| var x; | ||
| var n; | ||
| var b; | ||
| var v; | ||
| var i; | ||
|
|
||
| for ( i = 0; i < 100; i++ ) { | ||
| x = (randu()*100.0) - 50.0; | ||
| n = round( (randu()*10.0) - 5.0 ); | ||
| b = round( randu()*10.0 ); | ||
| v = roundbf( x, n, b ); | ||
| console.log( 'x: %d. %d^%d: %d. Rounded: %d.', x, b, n, powf( b, n ), v ); | ||
| } | ||
| ``` | ||
|
|
||
| </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/roundbf.h" | ||
| ``` | ||
|
|
||
| #### stdlib_base_roundbf( x, n, b ) | ||
|
|
||
| Rounds a single-precision floating-point number to the nearest multiple of `b^n` on a linear scale. | ||
|
|
||
| ```c | ||
| // Round a value to 2 decimal places: | ||
| float y = stdlib_base_roundbf( 3.14159f, -2, 10 ); | ||
| // returns ~3.14f | ||
|
|
||
| // If n = 0 or b = 1, `roundbf` behaves like `roundf`: | ||
| y = stdlib_base_roundbf( 3.14159f, 0, 2 ); | ||
| // returns 3.0f | ||
| ``` | ||
|
|
||
| The function accepts the following arguments: | ||
|
|
||
| - **x**: `[in] float` input value. | ||
| - **n**: `[in] int32_t` power. | ||
| - **b**: `[in] int32_t` base. | ||
|
|
||
| ```c | ||
| float stdlib_base_roundbf( const float x, const int32_t n, const int32_t b ); | ||
| ``` | ||
|
|
||
| </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/roundbf.h" | ||
| #include <stdio.h> | ||
| #include <stdint.h> | ||
|
|
||
| int main( void ) { | ||
| const float x[] = { 3.14f, -3.14f, 5.0f, -5.0f }; | ||
| const int32_t n[] = { -2, -2, 1, 1 }; | ||
| const int32_t b[] = { 10, 10, 2, 2 }; | ||
|
|
||
| float y; | ||
| int i; | ||
| for ( i = 0; i < 4; i++ ) { | ||
| y = stdlib_base_roundbf( x[ i ], n[ i ], b[ i ] ); | ||
| printf( "roundbf(%f, %d, %d) = %f\n", x[ i ], n[ i ], b[ 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 --> | ||
54 changes: 54 additions & 0 deletions
54
lib/node_modules/@stdlib/math/base/special/roundbf/benchmark/benchmark.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| /** | ||
| * @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 isnanf = require( '@stdlib/math/base/assert/is-nanf' ); | ||
| var pkg = require( './../package.json' ).name; | ||
| var roundbf = require( './../lib' ); | ||
|
|
||
|
|
||
| // MAIN // | ||
|
|
||
| bench( pkg, function benchmark( b ) { | ||
| var x; | ||
| var y; | ||
| var i; | ||
|
|
||
| x = uniform( 100, -5.0e6, 5.0e6, { | ||
| 'dtype': 'float32' | ||
| }); | ||
|
|
||
| b.tic(); | ||
| for ( i = 0; i < b.iterations; i++ ) { | ||
| y = roundbf( x[ i%x.length ], 2, 20 ); | ||
| 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
63
lib/node_modules/@stdlib/math/base/special/roundbf/benchmark/benchmark.native.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 uniform = require( '@stdlib/random/array/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 roundbf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); | ||
| var opts = { | ||
| 'skip': ( roundbf instanceof Error ) | ||
| }; | ||
|
|
||
|
|
||
| // MAIN // | ||
|
|
||
| bench( pkg+'::native', opts, function benchmark( b ) { | ||
| var x; | ||
| var y; | ||
| var i; | ||
|
|
||
| x = uniform( 100, -5.0e6, 5.0e6, { | ||
| 'dtype': 'float32' | ||
| }); | ||
|
|
||
| b.tic(); | ||
| for ( i = 0; i < b.iterations; i++ ) { | ||
| y = roundbf( x[ i%x.length ], 2, 20 ); | ||
| 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(); | ||
| }); | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.