Skip to content

docs: improve doctests for complex number instances in math/base/special/ccis #9014

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 12, 2025
+10 −80
Merged

docs: improve doctests for complex number instances in math/base/special/ccis #9014

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
18 changes: 2 additions & 16 deletions lib/node_modules/@stdlib/math/base/special/ccis/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,30 +57,16 @@ Evaluates the [cis][cis] function for a double-precision complex floating-point

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

var z = new Complex128( 0.0, 0.0 );

var v = ccis( z );
// returns <Complex128>

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

var im = imag( v );
// returns 0.0
// returns <Complex128>[ 1.0, 0.0 ]

z = new Complex128( 1.0, 0.0 );

v = ccis( z );
// returns <Complex128>

re = real( v );
// returns ~0.540

im = imag( v );
// returns ~0.841
// returns <Complex128>[ ~0.540, ~0.841 ]
```

</section>
Expand Down
12 changes: 2 additions & 10 deletions lib/node_modules/@stdlib/math/base/special/ccis/docs/repl.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,9 @@
Examples
--------
> var y = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( 0.0, 0.0 ) )
<Complex128>
> var re = {{alias:@stdlib/complex/float64/real}}( y )
1.0
> var im = {{alias:@stdlib/complex/float64/imag}}( y )
0.0
<Complex128>[ 1.0, 0.0 ]
> y = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( 1.0, 0.0 ) )
<Complex128>
> re = {{alias:@stdlib/complex/float64/real}}( y )
~0.540
> im = {{alias:@stdlib/complex/float64/imag}}( y )
~0.841
<Complex128>[ ~0.540, ~0.841 ]

See Also
--------
Expand Down
20 changes: 2 additions & 18 deletions lib/node_modules/@stdlib/math/base/special/ccis/lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,39 +25,23 @@
*
* @example
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
* var real = require( '@stdlib/complex/float64/real' );
* var imag = require( '@stdlib/complex/float64/imag' );
* var ccis = require( '@stdlib/math/base/special/ccis' );
*
* var z = new Complex128( 0.0, 0.0 );
* // returns <Complex128>
*
* var out = ccis( z );
* // returns <Complex128>
*
* var re = real( out );
* // returns 1.0
*
* var im = imag( out );
* // returns 0.0
* // returns <Complex128>[ 1.0, 0.0 ]
*
* @example
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
* var real = require( '@stdlib/complex/float64/real' );
* var imag = require( '@stdlib/complex/float64/imag' );
* var ccis = require( '@stdlib/math/base/special/ccis' );
*
* var z = new Complex128( 1.0, 0.0 );
* // returns <Complex128>
*
* var out = ccis( z );
* // returns <Complex128>
*
* var re = real( out );
* // returns ~0.540
*
* var im = imag( out );
* // returns ~0.841
* // returns <Complex128>[ ~0.540, ~0.841 ]
*/

// MODULES //
Expand Down
20 changes: 2 additions & 18 deletions lib/node_modules/@stdlib/math/base/special/ccis/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,37 +43,21 @@ var WORKSPACE = [ 0.0, 0.0 ];
*
* @example
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
* var real = require( '@stdlib/complex/float64/real' );
* var imag = require( '@stdlib/complex/float64/imag' );
*
* var z = new Complex128( 0.0, 0.0 );
* // returns <Complex128>
*
* var out = ccis( z );
* // returns <Complex128>
*
* var re = real( out );
* // returns 1.0
*
* var im = imag( out );
* // returns 0.0
* // returns <Complex128>[ 1.0, 0.0 ]
*
* @example
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
* var real = require( '@stdlib/complex/float64/real' );
* var imag = require( '@stdlib/complex/float64/imag' );
*
* var z = new Complex128( 1.0, 0.0 );
* // returns <Complex128>
*
* var out = ccis( z );
* // returns <Complex128>
*
* var re = real( out );
* // returns ~0.54
*
* var im = imag( out );
* // returns ~0.841
* // returns <Complex128>[ ~0.540, ~0.841 ]
*/
function ccis( z ) {
var re;
Expand Down
20 changes: 2 additions & 18 deletions lib/node_modules/@stdlib/math/base/special/ccis/lib/native.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,37 +35,21 @@ var addon = require( './../src/addon.node' );
*
* @example
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
* var real = require( '@stdlib/complex/float64/real' );
* var imag = require( '@stdlib/complex/float64/imag' );
*
* var z = new Complex128( 0.0, 0.0 );
* // returns <Complex128>
*
* var out = ccis( z );
* // returns <Complex128>
*
* var re = real( out );
* // returns 1.0
*
* var im = imag( out );
* // returns 0.0
* // returns <Complex128>[ 1.0, 0.0 ]
*
* @example
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
* var real = require( '@stdlib/complex/float64/real' );
* var imag = require( '@stdlib/complex/float64/imag' );
*
* var z = new Complex128( 1.0, 0.0 );
* // returns <Complex128>
*
* var out = ccis( z );
* // returns <Complex128>
*
* var re = real( out );
* // returns ~0.540
*
* var im = imag( out );
* // returns ~0.841
* // returns <Complex128>[ ~0.540, ~0.841 ]
*/
function ccis( z ) {
var v = addon( z );
Expand Down