Skip to content

Commit fabbf5a

Browse files
gunjjoshiPlaneshifter
gunjjoshi
and
Planeshifter
authored
feat: add math/base/special/roundf
PR-URL: #2725 Ref: #649 --------- Signed-off-by: Gunj Joshi <[email protected]> Signed-off-by: Philipp Burckhardt <[email protected]> Co-authored-by: Philipp Burckhardt <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>
1 parent f966721 commit fabbf5a

File tree

24 files changed

+1973
-0
lines changed

24 files changed

+1973
-0
lines changed

‎lib/node_modules/@stdlib/math/base/special/roundf/README.md

+212
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,212 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2024 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# Round
22+
23+
> Round a single-precision floating-point number to the nearest integer.
24+
25+
<section class="usage">
26+
27+
## Usage
28+
29+
```javascript
30+
var roundf = require( '@stdlib/math/base/special/roundf' );
31+
```
32+
33+
#### roundf( x )
34+
35+
Rounds a single-precision floating-point number to the nearest `integer`.
36+
37+
```javascript
38+
var v = roundf( -4.2 );
39+
// returns -4.0
40+
41+
v = roundf( -4.5 );
42+
// returns -4.0
43+
44+
v = roundf( -4.6 );
45+
// returns -5.0
46+
47+
v = roundf( 9.99999 );
48+
// returns 10.0
49+
50+
v = roundf( 9.5 );
51+
// returns 10.0
52+
53+
v = roundf( 9.2 );
54+
// returns 9.0
55+
56+
v = roundf( 0.0 );
57+
// returns 0.0
58+
59+
v = roundf( -0.0 );
60+
// returns -0.0
61+
62+
v = roundf( Infinity );
63+
// returns Infinity
64+
65+
v = roundf( -Infinity );
66+
// returns -Infinity
67+
68+
v = roundf( NaN );
69+
// returns NaN
70+
```
71+
72+
</section>
73+
74+
<!-- /.usage -->
75+
76+
<section class="notes">
77+
78+
## Notes
79+
80+
- Ties are rounded toward positive infinity.
81+
82+
</section>
83+
84+
<!-- /.notes -->
85+
86+
<section class="examples">
87+
88+
## Examples
89+
90+
<!-- eslint no-undef: "error" -->
91+
92+
```javascript
93+
var randu = require( '@stdlib/random/base/randu' );
94+
var roundf = require( '@stdlib/math/base/special/roundf' );
95+
96+
var x;
97+
var i;
98+
99+
for ( i = 0; i < 100; i++ ) {
100+
x = ( randu() * 100.0 ) - 50.0;
101+
console.log( 'Value: %d. Rounded: %d.', x, roundf( x ) );
102+
}
103+
```
104+
105+
</section>
106+
107+
<!-- /.examples -->
108+
109+
<!-- C interface documentation. -->
110+
111+
* * *
112+
113+
<section class="c">
114+
115+
## C APIs
116+
117+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
118+
119+
<section class="intro">
120+
121+
</section>
122+
123+
<!-- /.intro -->
124+
125+
<!-- C usage documentation. -->
126+
127+
<section class="usage">
128+
129+
### Usage
130+
131+
```c
132+
#include "stdlib/math/base/special/roundf.h"
133+
```
134+
135+
#### stdlib_base_roundf( x )
136+
137+
Rounds a single-precision floating-point number to the nearest `integer`.
138+
139+
```c
140+
float out = stdlib_base_roundf( -4.2f );
141+
// returns -4.0f
142+
```
143+
144+
The function accepts the following arguments:
145+
146+
- **x**: `[in] float` input value.
147+
148+
```c
149+
float stdlib_base_roundf( const float x );
150+
```
151+
152+
</section>
153+
154+
<!-- /.usage -->
155+
156+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
157+
158+
<section class="notes">
159+
160+
</section>
161+
162+
<!-- /.notes -->
163+
164+
<!-- C API usage examples. -->
165+
166+
<section class="examples">
167+
168+
### Examples
169+
170+
```c
171+
#include "stdlib/math/base/special/roundf.h"
172+
#include <stdio.h>
173+
174+
int main( void ) {
175+
const float x[] = { -5.0f, -3.89f, -2.78f, -1.67f, -0.56f, 0.56f, 1.67f, 2.78f, 3.89f, 5.0f };
176+
177+
float v;
178+
int i;
179+
for ( i = 0; i < 10; i++ ) {
180+
v = stdlib_base_roundf( x[ i ] );
181+
printf( "roundf(%f) = %f\n", x[ i ], v );
182+
}
183+
}
184+
```
185+
186+
</section>
187+
188+
<!-- /.examples -->
189+
190+
</section>
191+
192+
<!-- /.c -->
193+
194+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
195+
196+
<section class="related">
197+
198+
</section>
199+
200+
<!-- /.related -->
201+
202+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
203+
204+
<section class="links">
205+
206+
<!-- <related-links> -->
207+
208+
<!-- </related-links> -->
209+
210+
</section>
211+
212+
<!-- /.links -->

‎lib/node_modules/@stdlib/math/base/special/roundf/benchmark/benchmark.js

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var bench = require( '@stdlib/bench' );
24+
var randu = require( '@stdlib/random/base/randu' );
25+
var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
26+
var pkg = require( './../package.json' ).name;
27+
var roundf = require( './../lib' );
28+
29+
30+
// MAIN //
31+
32+
bench( pkg, function benchmark( b ) {
33+
var x;
34+
var y;
35+
var i;
36+
37+
b.tic();
38+
for ( i = 0; i < b.iterations; i++ ) {
39+
x = ( randu() * 1000.0 ) - 500.0;
40+
y = roundf( x );
41+
if ( isnanf( y ) ) {
42+
b.fail( 'should not return NaN' );
43+
}
44+
}
45+
b.toc();
46+
if ( isnanf( y ) ) {
47+
b.fail( 'should not return NaN' );
48+
}
49+
b.pass( 'benchmark finished' );
50+
b.end();
51+
});

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

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var resolve = require( 'path' ).resolve;
24+
var bench = require( '@stdlib/bench' );
25+
var randu = require( '@stdlib/random/base/randu' );
26+
var isnanf = require( '@stdlib/math/base/assert/is-nan' );
27+
var tryRequire = require( '@stdlib/utils/try-require' );
28+
var pkg = require( './../package.json' ).name;
29+
30+
31+
// VARIABLES //
32+
33+
var roundf = tryRequire( resolve( __dirname, './../lib/native.js' ) );
34+
var opts = {
35+
'skip': ( roundf instanceof Error )
36+
};
37+
38+
39+
// MAIN //
40+
41+
bench( pkg+'::native', opts, function benchmark( b ) {
42+
var x;
43+
var y;
44+
var i;
45+
46+
b.tic();
47+
for ( i = 0; i < b.iterations; i++ ) {
48+
x = ( randu() * 1000.0 ) - 500.0;
49+
y = roundf( x );
50+
if ( isnanf( y ) ) {
51+
b.fail( 'should not return NaN' );
52+
}
53+
}
54+
b.toc();
55+
if ( isnanf( y ) ) {
56+
b.fail( 'should not return NaN' );
57+
}
58+
b.pass( 'benchmark finished' );
59+
b.end();
60+
});

0 commit comments

Comments
 (0)