Skip to content

docs: improve doctests for complex number instances in math/base/special/cinvf #9020

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
Planeshifter merged 1 commit into from
Dec 13, 2025
Merged

docs: improve doctests for complex number instances in math/base/special/cinvf #9020

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 1 addition & 9 deletions lib/node_modules/@stdlib/math/base/special/cinvf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,17 +52,9 @@ Computes the inverse of a single-precision complex floating-point number.

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

var v = cinvf( new Complex64( 2.0, 4.0 ) );
// returns <Complex64>

var re = realf( v );
// returns ~0.1

var im = imagf( v );
// returns ~-0.2
// returns <Complex64>[ ~0.1, ~-0.2 ]
```

</section>
Expand Down
6 changes: 1 addition & 5 deletions lib/node_modules/@stdlib/math/base/special/cinvf/docs/repl.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,7 @@
Examples
--------
> var v = {{alias}}( new {{alias:@stdlib/complex/float32/ctor}}( 2.0, 4.0 ) )
<Complex64>
> var re = {{alias:@stdlib/complex/float32/real}}( v )
~0.1
> var im = {{alias:@stdlib/complex/float32/imag}}( v )
~-0.2
<Complex64>[ ~0.1, ~-0.2 ]

See Also
--------
Expand Down
10 changes: 1 addition & 9 deletions lib/node_modules/@stdlib/math/base/special/cinvf/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,9 @@ import { Complex64 } from '@stdlib/types/complex';
*
* @example
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* var v = cinvf( new Complex64( 2.0, 4.0 ) );
* // returns <Complex64>
*
* var re = realf( v );
* // returns ~0.1
*
* var im = imagf( v );
* // returns ~-0.2
* // returns <Complex64>[ ~0.1, ~-0.2 ]
*/
declare function cinvf( z: Complex64 ): Complex64;

Expand Down
10 changes: 1 addition & 9 deletions lib/node_modules/@stdlib/math/base/special/cinvf/lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,10 @@
*
* @example
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
* var cinvf = require( '@stdlib/math/base/special/cinvf' );
*
* var v = cinvf( new Complex64( 2.0, 4.0 ) );
* // returns <Complex64>
*
* var re = realf( v );
* // returns ~0.1
*
* var im = imagf( v );
* // returns ~-0.2
* // returns <Complex64>[ ~0.1, ~-0.2 ]
*/

// MODULES //
Expand Down
10 changes: 1 addition & 9 deletions lib/node_modules/@stdlib/math/base/special/cinvf/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,17 +55,9 @@ var RECIP_EPS_SQR = f32( TWO / f32(EPS*EPS) );
*
* @example
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* var v = cinvf( new Complex64( 2.0, 4.0 ) );
* // returns <Complex64>
*
* var re = realf( v );
* // returns ~0.1
*
* var im = imagf( v );
* // returns ~-0.2
* // returns <Complex64>[ ~0.1, ~-0.2 ]
*/
function cinvf( z ) {
var ab;
Expand Down
10 changes: 1 addition & 9 deletions lib/node_modules/@stdlib/math/base/special/cinvf/lib/native.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,17 +35,9 @@ var addon = require( './../src/addon.node' );
*
* @example
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* var v = cinvf( new Complex64( 2.0, 4.0 ) );
* // returns <Complex64>
*
* var re = realf( v );
* // returns ~0.1
*
* var im = imagf( v );
* // returns ~-0.2
* // returns <Complex64>[ ~0.1, ~-0.2 ]
*/
function cinvf( z ) {
var v = addon( z );
Expand Down