Skip to content

Commit 14f65e6

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent 2ed9cb2 commit 14f65e6

7 files changed

Lines changed: 28 additions & 143 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -726,6 +726,7 @@ A total of 94 issues were closed in this release:
726726

727727
<details>
728728

729+
- [`53641f6`](https://github.com/stdlib-js/stdlib/commit/53641f68e978d8c972ff6d0b8129ac40977d2e5e) - **docs:** improve doctests for complex number instances in `math/base/special/cceiln` [(#10213)](https://github.com/stdlib-js/stdlib/pull/10213) _(by AyushiJain18270, Athan Reines, stdlib-bot)_
729730
- [`1fa7f29`](https://github.com/stdlib-js/stdlib/commit/1fa7f295e091693d97d2a5c1856d1ad2b0cb3b8e) - **chore:** fix JavaScript lint errors [(#10087)](https://github.com/stdlib-js/stdlib/pull/10087) _(by Kunal Dadlani, Athan Reines, stdlib-bot)_
730731
- [`35566af`](https://github.com/stdlib-js/stdlib/commit/35566af0add64775e60422fd16e50e1bec3947e7) - **docs:** fix C examples in READMEs [(#11229)](https://github.com/stdlib-js/stdlib/pull/11229) _(by anee3, Athan Reines)_
731732
- [`48446bf`](https://github.com/stdlib-js/stdlib/commit/48446bf41b398ccab27b401cff5f1545dac0b279) - **fix:** rename header file [(#11232)](https://github.com/stdlib-js/stdlib/pull/11232) _(by Moh Zaid Khan)_

‎base/special/cceiln/README.md‎

Lines changed: 4 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -36,50 +36,24 @@ Rounds each component of a double-precision complex floating-point number to the
3636

3737
```javascript
3838
var Complex128 = require( '@stdlib/complex/float64/ctor' );
39-
var real = require( '@stdlib/complex/float64/real' );
40-
var imag = require( '@stdlib/complex/float64/imag' );
4139

4240
// Round components to 2 decimal places:
4341
var z = new Complex128( -3.141592653589793, 3.141592653589793 );
4442
var v = cceiln( z, -2 );
45-
// returns <Complex128>
46-
47-
var re = real( v );
48-
// returns -3.14
49-
50-
var im = imag( v );
51-
// returns 3.15
43+
// returns <Complex128>[ -3.14, 3.15 ]
5244

5345
// If n = 0, `cceiln` behaves like `cceil`:
5446
z = new Complex128( 9.99999, 0.1 );
5547
v = cceiln( z, 0 );
56-
// returns <Complex128>
57-
58-
re = real( v );
59-
// returns 10.0
60-
61-
im = imag( v );
62-
// returns 1.0
48+
// returns <Complex128>[ 10.0, 1.0 ]
6349

6450
// Round components to the nearest thousand:
6551
z = new Complex128( 12368.0, -12368.0 );
6652
v = cceiln( z, 3 );
67-
// returns <Complex128>
68-
69-
re = real( v );
70-
// returns 13000.0
71-
72-
im = imag( v );
73-
// returns -12000.0
53+
// returns <Complex128>[ 13000.0, -12000.0 ]
7454

7555
v = cceiln( new Complex128( NaN, NaN ), 2 );
76-
// returns <Complex128>
77-
78-
re = real( v );
79-
// returns NaN
80-
81-
im = imag( v );
82-
// returns NaN
56+
// returns <Complex128>[ NaN, NaN ]
8357
```
8458

8559
</section>

‎base/special/cceiln/docs/repl.txt‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,7 @@
1919
Examples
2020
--------
2121
> var out = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( 5.555, -3.333 ), -2 )
22-
<Complex128>
23-
> var re = {{alias:@stdlib/complex/float64/real}}( out )
24-
5.56
25-
> var im = {{alias:@stdlib/complex/float64/imag}}( out )
26-
-3.33
22+
<Complex128>[ 5.56, -3.33 ]
2723

2824
See Also
2925
--------

‎base/special/cceiln/docs/types/index.d.ts‎

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,17 +31,9 @@ import { Complex128 } from '@stdlib/types/complex';
3131
*
3232
* @example
3333
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
34-
* var real = require( '@stdlib/complex/float64/real' );
35-
* var imag = require( '@stdlib/complex/float64/imag' );
3634
*
3735
* var v = cceiln( new Complex128( 5.555, -3.333 ), -2 );
38-
* // returns <Complex128>
39-
*
40-
* var re = real( v );
41-
* // returns 5.56
42-
*
43-
* var im = imag( v );
44-
* // returns -3.33
36+
* // returns <Complex128>[ 5.56, -3.33 ]
4537
*/
4638
declare function cceiln( z: Complex128, n: number ): Complex128;
4739

‎base/special/cceiln/lib/index.js‎

Lines changed: 7 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -25,51 +25,25 @@
2525
*
2626
* @example
2727
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
28-
* var real = require( '@stdlib/complex/float64/real' );
29-
* var imag = require( '@stdlib/complex/float64/imag' );
3028
* var cceiln = require( '@stdlib/math/base/special/cceiln' );
3129
*
3230
* // Round components to 2 decimal places:
33-
* var z = new Complex128( -3.141592653589793, 3.141592653589793 )
31+
* var z = new Complex128( -3.141592653589793, 3.141592653589793 );
3432
* var v = cceiln( z, -2 );
35-
* // returns <Complex128>
36-
*
37-
* var re = real( v );
38-
* // returns -3.14
39-
*
40-
* var im = imag( v );
41-
* // returns 3.15
33+
* // returns <Complex128>[ -3.14, 3.15 ]
4234
*
4335
* // If n = 0, `cceiln` behaves like `cceil`:
44-
* z = new Complex128( 9.99999, 0.1 )
36+
* z = new Complex128( 9.99999, 0.1 );
4537
* v = cceiln( z, 0 );
46-
* // returns <Complex128>
47-
*
48-
* re = real( v );
49-
* // returns 10.0
50-
*
51-
* im = imag( v );
52-
* // returns 1.0
38+
* // returns <Complex128>[ 10.0, 1.0 ]
5339
*
5440
* // Round components to the nearest thousand:
55-
* z = new Complex128( 12368.0, -12368.0 )
41+
* z = new Complex128( 12368.0, -12368.0 );
5642
* v = cceiln( z, 3 );
57-
* // returns <Complex128>
58-
*
59-
* re = real( v );
60-
* // returns 13000.0
61-
*
62-
* im = imag( v );
63-
* // returns -12000.0
43+
* // returns <Complex128>[ 13000.0, -12000.0 ]
6444
*
6545
* v = cceiln( new Complex128( NaN, NaN ), 2 );
66-
* // returns <Complex128>
67-
*
68-
* re = real( v );
69-
* // returns NaN
70-
*
71-
* im = imag( v );
72-
* // returns NaN
46+
* // returns <Complex128>[ NaN, NaN ]
7347
*/
7448

7549
// MODULES //

‎base/special/cceiln/lib/main.js‎

Lines changed: 7 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -37,50 +37,24 @@ var imag = require( '@stdlib/complex/float64/imag' );
3737
*
3838
* @example
3939
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
40-
* var real = require( '@stdlib/complex/float64/real' );
41-
* var imag = require( '@stdlib/complex/float64/imag' );
4240
*
4341
* // Round components to 2 decimal places:
44-
* var z = new Complex128( -3.141592653589793, 3.141592653589793 )
42+
* var z = new Complex128( -3.141592653589793, 3.141592653589793 );
4543
* var v = cceiln( z, -2 );
46-
* // returns <Complex128>
47-
*
48-
* var re = real( v );
49-
* // returns -3.14
50-
*
51-
* var im = imag( v );
52-
* // returns 3.15
44+
* // returns <Complex128>[ -3.14, 3.15 ]
5345
*
5446
* // If n = 0, `cceiln` behaves like `cceil`:
55-
* z = new Complex128( 9.99999, 0.1 )
47+
* z = new Complex128( 9.99999, 0.1 );
5648
* v = cceiln( z, 0 );
57-
* // returns <Complex128>
58-
*
59-
* re = real( v );
60-
* // returns 10.0
61-
*
62-
* im = imag( v );
63-
* // returns 1.0
49+
* // returns <Complex128>[ 10.0, 1.0 ]
6450
*
6551
* // Round components to the nearest thousand:
66-
* z = new Complex128( 12368.0, -12368.0 )
52+
* z = new Complex128( 12368.0, -12368.0 );
6753
* v = cceiln( z, 3 );
68-
* // returns <Complex128>
69-
*
70-
* re = real( v );
71-
* // returns 13000.0
72-
*
73-
* im = imag( v );
74-
* // returns -12000.0
54+
* // returns <Complex128>[ 13000.0, -12000.0 ]
7555
*
7656
* v = cceiln( new Complex128( NaN, NaN ), 2 );
77-
* // returns <Complex128>
78-
*
79-
* re = real( v );
80-
* // returns NaN
81-
*
82-
* im = imag( v );
83-
* // returns NaN
57+
* // returns <Complex128>[ NaN, NaN ]
8458
*/
8559
function cceiln( z, n ) {
8660
return new Complex128( ceiln( real( z ), n ), ceiln( imag( z ), n ) );

‎base/special/cceiln/lib/native.js‎

Lines changed: 7 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -36,50 +36,24 @@ var addon = require( './../src/addon.node' );
3636
*
3737
* @example
3838
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
39-
* var real = require( '@stdlib/complex/float64/real' );
40-
* var imag = require( '@stdlib/complex/float64/imag' );
4139
*
4240
* // Round components to 2 decimal places:
43-
* var z = new Complex128( -3.141592653589793, 3.141592653589793 )
41+
* var z = new Complex128( -3.141592653589793, 3.141592653589793 );
4442
* var v = cceiln( z, -2 );
45-
* // returns <Complex128>
46-
*
47-
* var re = real( v );
48-
* // returns -3.14
49-
*
50-
* var im = imag( v );
51-
* // returns 3.15
43+
* // returns <Complex128>[ -3.14, 3.15 ]
5244
*
5345
* // If n = 0, `cceiln` behaves like `cceil`:
54-
* z = new Complex128( 9.99999, 0.1 )
46+
* z = new Complex128( 9.99999, 0.1 );
5547
* v = cceiln( z, 0 );
56-
* // returns <Complex128>
57-
*
58-
* re = real( v );
59-
* // returns 10.0
60-
*
61-
* im = imag( v );
62-
* // returns 1.0
48+
* // returns <Complex128>[ 10.0, 1.0 ]
6349
*
6450
* // Round components to the nearest thousand:
65-
* z = new Complex128( 12368.0, -12368.0 )
51+
* z = new Complex128( 12368.0, -12368.0 );
6652
* v = cceiln( z, 3 );
67-
* // returns <Complex128>
68-
*
69-
* re = real( v );
70-
* // returns 13000.0
71-
*
72-
* im = imag( v );
73-
* // returns -12000.0
53+
* // returns <Complex128>[ 13000.0, -12000.0 ]
7454
*
7555
* v = cceiln( new Complex128( NaN, NaN ), 2 );
76-
* // returns <Complex128>
77-
*
78-
* re = real( v );
79-
* // returns NaN
80-
*
81-
* im = imag( v );
82-
* // returns NaN
56+
* // returns <Complex128>[ NaN, NaN ]
8357
*/
8458
function cceiln( z, n ) {
8559
var v = addon( z, n );

0 commit comments

Comments
 (0)