Skip to content
/ math Public

Commit 1ec4d23

Browse files
committed
Auto-generated commit
1 parent a728844 commit 1ec4d23

File tree

7 files changed

+7
-50
lines changed

7 files changed

+7
-50
lines changed

CHANGELOG.md

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

709709
<details>
710710

711+
- [`62b365f`](https://github.com/stdlib-js/stdlib/commit/62b365f072bd98518e08b00b14344143c8df521c) - **docs:** improve doctests for complex number instances in `math/base/special/cinvf` [(#9020)](https://github.com/stdlib-js/stdlib/pull/9020) _(by Aryan kumar)_
711712
- [`b15e507`](https://github.com/stdlib-js/stdlib/commit/b15e507fbb9876c64c68f883217604872a7e76c9) - **docs:** improve doctests for complex number instances in `math/base/special/cinv` [(#9024)](https://github.com/stdlib-js/stdlib/pull/9024) _(by Aryan kumar)_
712713
- [`2c59b22`](https://github.com/stdlib-js/stdlib/commit/2c59b225c1d4d2b05bc433837e1c286535783443) - **docs:** improve doctests for complex number instances in `math/base/special/cround` [(#9025)](https://github.com/stdlib-js/stdlib/pull/9025) _(by Prajjwal Bajpai, Philipp Burckhardt)_
713714
- [`6a15889`](https://github.com/stdlib-js/stdlib/commit/6a15889a2462fa8cf48ef659e8962485065c8830) - **docs:** update `math/base/special` TypeScript declarations [(#9017)](https://github.com/stdlib-js/stdlib/pull/9017) _(by stdlib-bot)_

base/special/cinvf/README.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -52,17 +52,9 @@ Computes the inverse of a single-precision complex floating-point number.
5252

5353
```javascript
5454
var Complex64 = require( '@stdlib/complex/float32/ctor' );
55-
var realf = require( '@stdlib/complex/float32/real' );
56-
var imagf = require( '@stdlib/complex/float32/imag' );
5755

5856
var v = cinvf( new Complex64( 2.0, 4.0 ) );
59-
// returns <Complex64>
60-
61-
var re = realf( v );
62-
// returns ~0.1
63-
64-
var im = imagf( v );
65-
// returns ~-0.2
57+
// returns <Complex64>[ ~0.1, ~-0.2 ]
6658
```
6759

6860
</section>

base/special/cinvf/docs/repl.txt

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,7 @@
1515
Examples
1616
--------
1717
> var v = {{alias}}( new {{alias:@stdlib/complex/float32/ctor}}( 2.0, 4.0 ) )
18-
<Complex64>
19-
> var re = {{alias:@stdlib/complex/float32/real}}( v )
20-
~0.1
21-
> var im = {{alias:@stdlib/complex/float32/imag}}( v )
22-
~-0.2
18+
<Complex64>[ ~0.1, ~-0.2 ]
2319

2420
See Also
2521
--------

base/special/cinvf/docs/types/index.d.ts

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,9 @@ import { Complex64 } from '@stdlib/types/complex';
3030
*
3131
* @example
3232
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
33-
* var realf = require( '@stdlib/complex/float32/real' );
34-
* var imagf = require( '@stdlib/complex/float32/imag' );
3533
*
3634
* var v = cinvf( new Complex64( 2.0, 4.0 ) );
37-
* // returns <Complex64>
38-
*
39-
* var re = realf( v );
40-
* // returns ~0.1
41-
*
42-
* var im = imagf( v );
43-
* // returns ~-0.2
35+
* // returns <Complex64>[ ~0.1, ~-0.2 ]
4436
*/
4537
declare function cinvf( z: Complex64 ): Complex64;
4638

base/special/cinvf/lib/index.js

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,10 @@
2525
*
2626
* @example
2727
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
28-
* var realf = require( '@stdlib/complex/float32/real' );
29-
* var imagf = require( '@stdlib/complex/float32/imag' );
3028
* var cinvf = require( '@stdlib/math/base/special/cinvf' );
3129
*
3230
* var v = cinvf( new Complex64( 2.0, 4.0 ) );
33-
* // returns <Complex64>
34-
*
35-
* var re = realf( v );
36-
* // returns ~0.1
37-
*
38-
* var im = imagf( v );
39-
* // returns ~-0.2
31+
* // returns <Complex64>[ ~0.1, ~-0.2 ]
4032
*/
4133

4234
// MODULES //

base/special/cinvf/lib/main.js

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -55,17 +55,9 @@ var RECIP_EPS_SQR = f32( TWO / f32(EPS*EPS) );
5555
*
5656
* @example
5757
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
58-
* var realf = require( '@stdlib/complex/float32/real' );
59-
* var imagf = require( '@stdlib/complex/float32/imag' );
6058
*
6159
* var v = cinvf( new Complex64( 2.0, 4.0 ) );
62-
* // returns <Complex64>
63-
*
64-
* var re = realf( v );
65-
* // returns ~0.1
66-
*
67-
* var im = imagf( v );
68-
* // returns ~-0.2
60+
* // returns <Complex64>[ ~0.1, ~-0.2 ]
6961
*/
7062
function cinvf( z ) {
7163
var ab;

base/special/cinvf/lib/native.js

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,17 +35,9 @@ var addon = require( './../src/addon.node' );
3535
*
3636
* @example
3737
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
38-
* var realf = require( '@stdlib/complex/float32/real' );
39-
* var imagf = require( '@stdlib/complex/float32/imag' );
4038
*
4139
* var v = cinvf( new Complex64( 2.0, 4.0 ) );
42-
* // returns <Complex64>
43-
*
44-
* var re = realf( v );
45-
* // returns ~0.1
46-
*
47-
* var im = imagf( v );
48-
* // returns ~-0.2
40+
* // returns <Complex64>[ ~0.1, ~-0.2 ]
4941
*/
5042
function cinvf( z ) {
5143
var v = addon( z );

0 commit comments

Comments
 (0)