Skip to content

docs: update examples for complex/float64/base/div #7266

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 1 commit into from
Jun 8, 2025
Merged

docs: update examples for complex/float64/base/div #7266

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/complex/float64/base/div/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,20 +42,12 @@ Divides two double-precision complex floating-point numbers.

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

var z1 = new Complex128( -13.0, -1.0 );
var z2 = new Complex128( -2.0, 1.0 );

var v = cdiv( z1, z2 );
// returns <Complex128>

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

var im = imag( v );
// returns 3.0
// returns <Complex128>[ 5.0, 3.0 ]
```

</section>
Expand Down
13 changes: 1 addition & 12 deletions lib/node_modules/@stdlib/complex/float64/base/div/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,23 +31,12 @@ import { Complex128 } from '@stdlib/types/complex';
*
* @example
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
* var real = require( '@stdlib/complex/float64/real' );
* var imag = require( '@stdlib/complex/float64/imag' );
*
* var z1 = new Complex128( -13.0, -1.0 );
* // returns <Complex128>
*
* var z2 = new Complex128( -2.0, 1.0 );
* // returns <Complex128>
*
* var out = cdiv( z1, z2 );
* // returns <Complex128>
*
* var re = real( out );
* // returns 5.0
*
* var im = imag( out );
* // returns 3.0
* // returns <Complex128>[ 5.0, 3.0 ]
*/
declare function cdiv( z1: Complex128, z2: Complex128 ): Complex128;

Expand Down
13 changes: 1 addition & 12 deletions lib/node_modules/@stdlib/complex/float64/base/div/lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,24 +25,13 @@
*
* @example
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
* var real = require( '@stdlib/complex/float64/real' );
* var imag = require( '@stdlib/complex/float64/imag' );
* var cdiv = require( '@stdlib/complex/float64/base/div' );
*
* var z1 = new Complex128( -13.0, -1.0 );
* // returns <Complex128>
*
* var z2 = new Complex128( -2.0, 1.0 );
* // returns <Complex128>
*
* var out = cdiv( z1, z2 );
* // returns <Complex128>
*
* var re = real( out );
* // returns 5.0
*
* var im = imag( out );
* // returns 3.0
* // returns <Complex128>[ 5.0, 3.0 ]
*/

// MODULES //
Expand Down
13 changes: 1 addition & 12 deletions lib/node_modules/@stdlib/complex/float64/base/div/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,23 +53,12 @@ var RECIP_EPS_SQR = 2.0 / ( EPS * EPS );
*
* @example
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
* var real = require( '@stdlib/complex/float64/real' );
* var imag = require( '@stdlib/complex/float64/imag' );
*
* var z1 = new Complex128( -13.0, -1.0 );
* // returns <Complex128>
*
* var z2 = new Complex128( -2.0, 1.0 );
* // returns <Complex128>
*
* var out = cdiv( z1, z2 );
* // returns <Complex128>
*
* var re = real( out );
* // returns 5.0
*
* var im = imag( out );
* // returns 3.0
* // returns <Complex128>[ 5.0, 3.0 ]
*/
function cdiv( z1, z2 ) {
var re1;
Expand Down
13 changes: 1 addition & 12 deletions lib/node_modules/@stdlib/complex/float64/base/div/lib/native.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,23 +36,12 @@ 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 z1 = new Complex128( -13.0, -1.0 );
* // returns <Complex128>
*
* var z2 = new Complex128( -2.0, 1.0 );
* // returns <Complex128>
*
* var out = cdiv( z1, z2 );
* // returns <Complex128>
*
* var re = real( out );
* // returns 5.0
*
* var im = imag( out );
* // returns 3.0
* // returns <Complex128>[ 5.0, 3.0 ]
*/
function cdiv( z1, z2 ) {
var v = addon( z1, z2 );
Expand Down