Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
257 changes: 257 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/cfloornf/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,257 @@
<!--

@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.

-->

# cfloornf

> Round each component of a single-precision complex floating-point number to the nearest multiple of `10^n` toward negative infinity.

<section class="usage">

## Usage

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

#### cfloornf( z, n )

Rounds each component of a single-precision complex floating-point number to the nearest multiple of `10^n` toward negative infinity.

```javascript
var Complex64 = require( '@stdlib/complex/float32/ctor' );

// Round components to the nearest ten:
var v = cfloornf( new Complex64( -15.0, 15.0 ), 1 );
// returns <Complex64>[ -20.0, 10.0 ]

// If n = 0, `cfloornf` behaves like `cfloorf`:
v = cfloornf( new Complex64( -3.14, 3.14 ), 0 );
// returns <Complex64>[ -4.0, 3.0 ]

// Round components to the nearest hundred:
v = cfloornf( new Complex64( -150.0, 150.0 ), 2 );
// returns <Complex64>[ -200.0, 100.0 ]

v = cfloornf( new Complex64( NaN, NaN ), 0 );
// returns <Complex64>[ NaN, NaN ]
```

</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 Complex64 = require( '@stdlib/complex/float32/ctor' );
var f32 = require( '@stdlib/number/float64/base/to-float32' );

var x = f32( -0.2 - 0.1 );
// returns ~-0.30000001192092896

// Should round components to -0.3, but may differ due to float32 precision:
var v = cfloornf( new Complex64( x, x ), -6 );
```

</section>

<!-- /.notes -->

<section class="examples">

## Examples

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

```javascript
var Complex64 = require( '@stdlib/complex/float32/ctor' );
var uniform = require( '@stdlib/random/base/uniform' );
var randint = require( '@stdlib/random/base/discrete-uniform' );
var cfloornf = require( '@stdlib/math/base/special/cfloornf' );

var z;
var w;
var n;
var i;

for ( i = 0; i < 100; i++ ) {
z = new Complex64( uniform( -50.0, 50.0 ), uniform( -50.0, 50.0 ) );

n = randint( -5.0, 0.0 );
w = cfloornf( z, n );

console.log( 'cfloornf(%s,%s) = %s', z.toString(), n.toString(), w.toString() );
}
```

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

#### stdlib_base_cfloornf( z, n )

Rounds each component of a single-precision complex floating-point number to the nearest multiple of `10^n` toward negative infinity.

```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( -3.14f, 3.14f );
stdlib_complex64_t out = stdlib_base_cfloornf( z, -2 );

float re = stdlib_complex64_real( out );
// returns -3.15f

float im = stdlib_complex64_imag( out );
// returns 3.14f
```

The function accepts the following arguments:

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

```c
stdlib_complex64_t stdlib_base_cfloornf( const stdlib_complex64_t z, 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/cfloornf.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.14f, 1.5f ),
stdlib_complex64( -3.14f, -1.5f ),
stdlib_complex64( 0.0f, 0.0f ),
stdlib_complex64( 0.0f/0.0f, 0.0f/0.0f )
};

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_cfloornf( v, -2 );
stdlib_complex64_reim( v, &re1, &im1 );
stdlib_complex64_reim( y, &re2, &im2 );
printf( "cfloornf(%f + %fi, -2) = %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/cfloorn`][@stdlib/math/base/special/cfloorn]</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 toward negative infinity.</span>
- <span class="package-name">[`@stdlib/math/base/special/cfloorf`][@stdlib/math/base/special/cfloorf]</span><span class="delimiter">: </span><span class="description">round each component of a single-precision complex floating-point number toward negative infinity.</span>
- <span class="package-name">[`@stdlib/math/base/special/floornf`][@stdlib/math/base/special/floornf]</span><span class="delimiter">: </span><span class="description">round a single-precision floating-point number to the nearest multiple of 10^n toward negative infinity.</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">

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

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

[@stdlib/math/base/special/cfloorn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cfloorn

[@stdlib/math/base/special/cfloorf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cfloorf

[@stdlib/math/base/special/floornf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/floornf

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

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
/**
* @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 isnanf = require( '@stdlib/math/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 uniform = require( '@stdlib/random/base/uniform' );
var pkg = require( './../package.json' ).name;
var cfloornf = 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 = cfloornf( values[ i%values.length ], -2 );
if ( isnanf( real( y ) ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();
if ( isnanf( imag( y ) ) ) {
b.fail( 'should not return NaN' );
}
b.pass( 'benchmark finished' );
b.end();
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
/**
* @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/base/uniform' );
var isnanf = require( '@stdlib/math/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 tryRequire = require( '@stdlib/utils/try-require' );
var format = require( '@stdlib/string/format' );
var pkg = require( './../package.json' ).name;


// VARIABLES //

var cfloornf = tryRequire( resolve( __dirname, './../lib/native.js' ) );
var opts = {
'skip': ( cfloornf instanceof Error )
};


// MAIN //

bench( format( '%s::native', pkg ), opts, 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 = cfloornf( values[ i%values.length ], -2 );
if ( isnanf( real( y ) ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();
if ( isnanf( imag( y ) ) ) {
b.fail( 'should not return NaN' );
}
b.pass( 'benchmark finished' );
b.end();
});
Loading