-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7b4f640
commit b3ab016
Showing
27 changed files
with
2,287 additions
and
3 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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,251 @@ | ||
| <!-- | ||
| @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. | ||
| --> | ||
|
|
||
| # croundf | ||
|
|
||
| > Round each component of a single-precision complex floating-point number to the nearest integer. | ||
| <section class="usage"> | ||
|
|
||
| ## Usage | ||
|
|
||
| ```javascript | ||
| var croundf = require( '@stdlib/math/base/special/croundf' ); | ||
| ``` | ||
|
|
||
| #### croundf( z ) | ||
|
|
||
| Rounds each component of a single-precision complex floating-point number to the nearest integer. | ||
|
|
||
| ```javascript | ||
| var Complex64 = require( '@stdlib/complex/float32/ctor' ); | ||
| var real = require( '@stdlib/complex/float32/real' ); | ||
| var imag = require( '@stdlib/complex/float32/imag' ); | ||
|
|
||
| var v = croundf( new Complex64( -4.2, 5.5 ) ); | ||
| // returns <Complex64> | ||
|
|
||
| var re = real( v ); | ||
| // returns -4.0 | ||
|
|
||
| var im = imag( v ); | ||
| // returns 6.0 | ||
|
|
||
| v = croundf( new Complex64( 9.99999, 0.1 ) ); | ||
| // returns <Complex64> | ||
|
|
||
| re = real( v ); | ||
| // returns 10.0 | ||
|
|
||
| im = imag( v ); | ||
| // returns 0.0 | ||
|
|
||
| v = croundf( new Complex64( 0.0, 0.0 ) ); | ||
| // returns <Complex64> | ||
|
|
||
| re = real( v ); | ||
| // returns 0.0 | ||
|
|
||
| im = imag( v ); | ||
| // returns 0.0 | ||
|
|
||
| v = croundf( new Complex64( NaN, NaN ) ); | ||
| // returns <Complex64> | ||
|
|
||
| re = real( v ); | ||
| // returns NaN | ||
|
|
||
| im = imag( v ); | ||
| // returns NaN | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.usage --> | ||
|
|
||
| <section class="examples"> | ||
|
|
||
| ## Examples | ||
|
|
||
| <!-- eslint no-undef: "error" --> | ||
|
|
||
| ```javascript | ||
| var uniform = require( '@stdlib/random/base/uniform' ).factory; | ||
| var Complex64 = require( '@stdlib/complex/float32/ctor' ); | ||
| var croundf = require( '@stdlib/math/base/special/croundf' ); | ||
|
|
||
| var rand = uniform( -50.0, 50.0 ); | ||
|
|
||
| var z; | ||
| var i; | ||
| for ( i = 0; i < 100; i++ ) { | ||
| z = new Complex64( rand(), rand() ); | ||
| console.log( 'croundf(%s) = %s', z, croundf( z ) ); | ||
| } | ||
| ``` | ||
|
|
||
| </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/croundf.h" | ||
| ``` | ||
|
|
||
| #### stdlib_base_croundf( z ) | ||
|
|
||
| Rounds each component of a single-precision complex floating-point number to the nearest integer. | ||
|
|
||
| ```c | ||
| #include "stdlib/complex/float32/ctor.h" | ||
| #include "stdlib/complex/float32/real.h" | ||
| #include "stdlib/complex/float32/imag.h" | ||
|
|
||
| stdlib_complex64_t z = stdlib_complex64( -4.2, 5.5 ); | ||
|
|
||
| stdlib_complex64_t out = stdlib_base_croundf( z ); | ||
|
|
||
| float re = stdlib_complex64_real( out ); | ||
| // returns -4.0 | ||
|
|
||
| float im = stdlib_complex64_imag( out ); | ||
| // returns 6.0 | ||
| ``` | ||
|
|
||
| The function accepts the following arguments: | ||
|
|
||
| - **z**: `[in] stdlib_complex64_t` input value. | ||
|
|
||
| ```c | ||
| stdlib_complex64_t stdlib_base_croundf( const stdlib_complex64_t z ); | ||
| ``` | ||
| </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/croundf.h" | ||
| #include "stdlib/complex/float32/ctor.h" | ||
| #include "stdlib/complex/float32/reim.h" | ||
| #include <stdio.h> | ||
| int main( void ) { | ||
| const stdlib_complex64_t x[] = { | ||
| stdlib_complex64( 3.14, 1.5 ), | ||
| stdlib_complex64( -3.14, -1.5 ), | ||
| stdlib_complex64( 0.0, 0.0 ), | ||
| stdlib_complex64( 0.0/0.0, 0.0/0.0 ) | ||
| }; | ||
| stdlib_complex64_t v; | ||
| stdlib_complex64_t y; | ||
| float re1; | ||
| float im1; | ||
| float re2; | ||
| float im2; | ||
| int i; | ||
| for ( i = 0; i < 4; i++ ) { | ||
| v = x[ i ]; | ||
| y = stdlib_base_croundf( v ); | ||
| stdlib_complex64_reim( v, &re1, &im1 ); | ||
| stdlib_complex64_reim( y, &re2, &im2 ); | ||
| printf( "croundf(%f + %fi) = %f + %fi\n", re1, im1, re2, im2 ); | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.examples --> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.c --> | ||
|
|
||
| <!-- 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/cceilf`][@stdlib/math/base/special/cceilf]</span><span class="delimiter">: </span><span class="description">round a single-precision complex floating-point number toward positive infinity.</span> | ||
| - <span class="package-name">[`@stdlib/math/base/special/cfloor`][@stdlib/math/base/special/cfloor]</span><span class="delimiter">: </span><span class="description">round a double-precision complex floating-point number toward negative infinity.</span> | ||
| - <span class="package-name">[`@stdlib/math/base/special/croundn`][@stdlib/math/base/special/croundn]</span><span class="delimiter">: </span><span class="description">round each component of a double-precision complex floating-point number to the nearest multiple of 10^n.</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/cceilf]: https://github.com/stdlib-js/math/tree/main/base/special/cceilf | ||
|
|
||
| [@stdlib/math/base/special/cfloor]: https://github.com/stdlib-js/math/tree/main/base/special/cfloor | ||
|
|
||
| [@stdlib/math/base/special/croundn]: https://github.com/stdlib-js/math/tree/main/base/special/croundn | ||
|
|
||
| <!-- </related-links> --> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.links --> |
This file contains 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,58 @@ | ||
| /** | ||
| * @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/base/uniform' ); | ||
| var isnanf = require( './../../../../base/assert/is-nanf' ); | ||
| var Complex64 = require( '@stdlib/complex/float32/ctor' ); | ||
| var real = require( '@stdlib/complex/float32/real' ); | ||
| var imag = require( '@stdlib/complex/float32/imag' ); | ||
| var pkg = require( './../package.json' ).name; | ||
| var croundf = require( './../lib' ); | ||
|
|
||
|
|
||
| // MAIN // | ||
|
|
||
| bench( pkg, function benchmark( b ) { | ||
| var values; | ||
| var y; | ||
| var i; | ||
|
|
||
| values = [ | ||
| new Complex64( uniform( -500.0, 500.0 ), uniform( -500.0, 500.0 ) ), | ||
| new Complex64( uniform( -500.0, 500.0 ), uniform( -500.0, 500.0 ) ) | ||
| ]; | ||
|
|
||
| b.tic(); | ||
| for ( i = 0; i < b.iterations; i++ ) { | ||
| y = croundf( values[ i%values.length ] ); | ||
| if ( isnanf( real( y ) ) ) { | ||
| b.fail( 'should not return NaN' ); | ||
| } | ||
| } | ||
| b.toc(); | ||
| if ( isnanf( imag( y ) ) ) { | ||
| b.fail( 'should not return not NaN' ); | ||
| } | ||
| b.pass( 'benchmark finished' ); | ||
| b.end(); | ||
| }); |
Oops, something went wrong.