Skip to content

feat: add native addon to ceiln and cceiln #988

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
merged 20 commits into from
Sep 23, 2023
Merged

feat: add native addon to ceiln and cceiln #988

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
8ddd657
feat: remove out keyword and accept double-precision complex numbers
steff456 Feb 28, 2023
4ce2847
feat: add addon to ceiln
steff456 Mar 1, 2023
94e010d
fix: remove unused import
steff456 Mar 1, 2023
44d00ce
Merge branch 'develop' into cceiln-addon
steff456 Mar 28, 2023
5873c90
feat: add addon to cceiln package
steff456 Mar 29, 2023
eac1170
test: fix failing tests
steff456 Apr 20, 2023
e69ce9d
fix: add self review changes
steff456 Jul 11, 2023
bc74f9b
fix: fix indentation for manifest.json files
steff456 Jul 20, 2023
0f93619
fix: add review changes
steff456 Jul 25, 2023
048901e
fix: fix tests and add review comments
steff456 Aug 28, 2023
11ce816
Merge branch 'develop' into cceiln-addon
steff456 Aug 29, 2023
55fcdfe
Apply suggestions from code review
kgryte Sep 8, 2023
79dd926
Apply suggestions from code review
kgryte Sep 8, 2023
7181955
fix: fix C addon implementation
steff456 Sep 18, 2023
148ed3f
fix: fix C implementation
steff456 Sep 22, 2023
133dc4a
fix: fix HUGE variable declaration
steff456 Sep 22, 2023
a2b72f2
fix: add missing semicolon
steff456 Sep 22, 2023
f8e55da
Move variable to parent scope
kgryte Sep 23, 2023
13912c9
Apply suggestions from code review
kgryte Sep 23, 2023
3d90695
Apply suggestions from code review
kgryte Sep 23, 2023
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
210 changes: 170 additions & 40 deletions lib/node_modules/@stdlib/math/base/special/cceiln/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ limitations under the License.

-->

# ceiln
# cceiln

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

<section class="usage">

Expand All @@ -30,39 +30,56 @@ limitations under the License.
var cceiln = require( '@stdlib/math/base/special/cceiln' );
```

#### cceiln( \[out,] re, im, n )
#### cceiln( z, n )

Rounds a `complex` number comprised of a **real** component `re` and an **imaginary** component `im` to the nearest multiple of `10^n` toward positive infinity.
Rounds each component of a double-precision complex floating-point number to the nearest multiple of `10^n` toward positive infinity.

```javascript
var Complex128 = require( '@stdlib/complex/float64' );
var real = require( '@stdlib/complex/real' );
var imag = require( '@stdlib/complex/imag' );

// Round components to 2 decimal places:
var v = cceiln( -3.141592653589793, 3.141592653589793, -2 );
// returns [ -3.14, 3.15 ]
var z = new Complex128( -3.141592653589793, 3.141592653589793 );
var v = cceiln( z, -2 );
// returns <Complex128>

var re = real( v );
// returns -3.14

var im = imag( v );
// returns 3.15

// If n = 0, `cceiln` behaves like `cceil`:
v = cceiln( -3.141592653589793, 3.141592653589793, 0 );
// returns [ -3.0, 4.0 ]
z = new Complex128( 9.99999, 0.1 );
v = cceiln( z, 0 );
// returns <Complex128>

// Round components to the nearest thousand:
v = cceiln( -12368.0, 12368.0, 3 );
// returns [ -12000.0, 13000.0 ]
re = real( v );
// returns 10.0

v = cceiln( NaN, NaN, 0 );
// returns [ NaN, NaN ]
```
im = imag( v );
// returns 1.0

// Round components to the nearest thousand:
z = new Complex128( 12368.0, -12368.0 );
v = cceiln( z, 3 );
// returns <Complex128>

By default, the function returns real and imaginary components as a two-element `array`. To avoid unnecessary memory allocation, the function supports providing an output (destination) object.
re = real( v );
// returns 13000.0

```javascript
var Float32Array = require( '@stdlib/array/float32' );
im = imag( v );
// returns -12000.0

var out = new Float32Array( 2 );
v = cceiln( new Complex128( NaN, NaN ), 2 );
// returns <Complex128>

var v = cceiln( out, -4.2, 5.5, 0 );
// returns <Float32Array>[ -4.0, 6.0 ]
re = real( v );
// returns NaN

var bool = ( v === out );
// returns true
im = imag( v );
// returns NaN
```

</section>
Expand All @@ -76,12 +93,22 @@ var bool = ( v === out );
- When operating on [floating-point numbers][ieee754] in bases other than `2`, rounding to specified digits can be **inexact**. For example,

```javascript
var Complex128 = require( '@stdlib/complex/float64' );
var real = require( '@stdlib/complex/real' );
var imag = require( '@stdlib/complex/imag' );

var x = 0.2 + 0.1;
// returns 0.30000000000000004

// Should round components to 0.3:
var v = cceiln( x, x, -16 );
// returns [ 0.3000000000000001, 0.3000000000000001 ]
var v = cceiln( new Complex128( x, x ), -16 );
// returns <Complex128>

var re = real( v );
// returns 0.3000000000000001

var im = imag( v );
// returns 0.3000000000000001
```

</section>
Expand All @@ -95,38 +122,141 @@ var bool = ( v === out );
<!-- eslint no-undef: "error" -->

```javascript
var uniform = require( '@stdlib/random/base/uniform' ).factory;
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
var Complex128 = require( '@stdlib/complex/float64' );
var randu = require( '@stdlib/random/base/randu' );
var ceil = require( '@stdlib/math/base/special/ceil' );
var real = require( '@stdlib/complex/real' );
var imag = require( '@stdlib/complex/imag' );
var cceiln = require( '@stdlib/math/base/special/cceiln' );

var re;
var im;
var rand1 = uniform( -50.0, 50.0 );
var rand2 = discreteUniform( -5.0, 0.0 );

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

var n;
for ( i = 0; i < 100; i++ ) {
re = ( randu()*100.0 ) - 50.0;
im = ( randu()*100.0 ) - 50.0;
z = new Complex128( re, im );
n = rand2();
z = new Complex128( rand1(), rand1() );
console.log( 'cceiln(%s, %s) = %s', z, n, cceiln( z, n ) );
}
```

</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>

n = ceil( randu()*5.0 );
o = cceiln( real(z), imag(z), -n );
w = new Complex128( o[ 0 ], o[ 1 ] );
<!-- /.intro -->

console.log( 'ceiln(%s,%s) = %s', z.toString(), n.toString(), w.toString() );
<!-- C usage documentation. -->

<section class="usage">

### Usage

```c
#include "stdlib/math/base/special/cceiln.h"
```

#### stdlib_base_cceiln( z, n )

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

```c
#include "stdlib/complex/float64.h"
#include "stdlib/complex/real.h"
#include "stdlib/complex/imag.h"

stdlib_complex128_t z = stdlib_complex128( -3.141592653589793, 3.141592653589793 );

stdlib_complex128_t out = stdlib_base_cceiln( z, -2 );

double re = stdlib_real( out );
// returns -3.14

double im = stdlib_imag( out );
// returns 3.15
```

The function accepts the following arguments:

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

```c
stdlib_complex128_t stdlib_base_cceiln( const stdlib_complex128_t z, 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/cceiln.h"
#include "stdlib/complex/float64.h"
#include "stdlib/complex/reim.h"
#include <stdio.h>

int main() {
const stdlib_complex128_t x[] = {
stdlib_complex128( 3.14, 1.5 ),
stdlib_complex128( -3.14, -1.5 ),
stdlib_complex128( 0.0, 0.0 ),
stdlib_complex128( 0.0/0.0, 0.0/0.0 )
};

stdlib_complex128_t v;
stdlib_complex128_t y;
double re1;
double im1;
double re2;
double im2;
int i;
for ( i = 0; i < 4; i++ ) {
v = x[ i ];
y = stdlib_base_cceiln( v, -2 );
stdlib_reim( v, &re1, &im1 );
stdlib_reim( y, &re2, &im2 );
printf( "cceiln(%lf + %lfi, -2) = %lf + %lfi\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">
Expand Down
101 changes: 15 additions & 86 deletions lib/node_modules/@stdlib/math/base/special/cceiln/benchmark/benchmark.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,108 +21,37 @@
// MODULES //

var bench = require( '@stdlib/bench' );
var randu = require( '@stdlib/random/base/randu' );
var isArray = require( '@stdlib/assert/is-array' );
var ceiln = require( '@stdlib/math/base/special/ceiln' );
var uniform = require( '@stdlib/random/base/uniform' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var Complex128 = require( '@stdlib/complex/float64' );
var real = require( '@stdlib/complex/real' );
var imag = require( '@stdlib/complex/imag' );
var pkg = require( './../package.json' ).name;
var cceiln = require( './../lib' );


// MAIN //

bench( pkg, function benchmark( b ) {
var re;
var im;
var values;
var y;
var i;

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
re = ( randu()*1000.0 ) - 500.0;
im = ( randu()*1000.0 ) - 500.0;
y = cceiln( re, im, -2 );
if ( y.length === 0 ) {
b.fail( 'should not be empty' );
}
}
b.toc();
if ( !isArray( y ) ) {
b.fail( 'should return an array' );
}
b.pass( 'benchmark finished' );
b.end();
});

bench( pkg+'::memory_reuse', function benchmark( b ) {
var out;
var re;
var im;
var y;
var i;

out = [ 0.0, 0.0 ];

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
re = ( randu()*1000.0 ) - 500.0;
im = ( randu()*1000.0 ) - 500.0;
y = cceiln( out, re, im, -2 );
if ( y.length === 0 ) {
b.fail( 'should not be empty' );
}
}
b.toc();
if ( !isArray( y ) ) {
b.fail( 'should return an array' );
}
b.pass( 'benchmark finished' );
b.end();
});

bench( pkg+'::manual', function benchmark( b ) {
var re;
var im;
var y;
var i;

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
re = ( randu()*1000.0 ) - 500.0;
im = ( randu()*1000.0 ) - 500.0;
y = [ ceiln( re, -2 ), ceiln( im, -2 ) ];
if ( y.length === 0 ) {
b.fail( 'should not be empty' );
}
}
b.toc();
if ( !isArray( y ) ) {
b.fail( 'should return an array' );
}
b.pass( 'benchmark finished' );
b.end();
});

bench( pkg+'::manual,memory_reuse', function benchmark( b ) {
var re;
var im;
var y;
var i;

y = [ 0.0, 0.0 ];
values = [
new Complex128( uniform( -500.0, 500.0 ), uniform( -500.0, 500.0 ) ),
new Complex128( uniform( -500.0, 500.0 ), uniform( -500.0, 500.0 ) )
];

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
re = ( randu()*1000.0 ) - 500.0;
im = ( randu()*1000.0 ) - 500.0;
y[ 0 ] = ceiln( re, -2 );
y[ 1 ] = ceiln( im, -2 );
if ( y.length === 0 ) {
b.fail( 'should not be empty' );
y = cceiln( values[ i%values.length ], -2 );
if ( isnan( real( y ) ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();
if ( !isArray( y ) ) {
b.fail( 'should return an array' );
if ( isnan( imag( y ) ) ) {
b.fail( 'should not return NaN' );
}
b.pass( 'benchmark finished' );
b.end();
Expand Down
Loading