Skip to content

docs: change examples for complex/float64/base/add #7177

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 3 commits into from
Jun 2, 2025
Merged

docs: change examples for complex/float64/base/add #7177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3b5512c
docs: change examples for complex/float64/base/add
ShabiShett07 Jun 2, 2025
9235d2e
chore: minor clean-up
ShabiShett07 Jun 2, 2025
428ed9e
chore: minor clean-up
ShabiShett07 Jun 2, 2025
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
23 changes: 9 additions & 14 deletions lib/node_modules/@stdlib/complex/float64/base/add/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,22 +123,17 @@ The function supports the following parameters:
<!-- eslint no-undef: "error" -->

```javascript
var Complex128 = require( '@stdlib/complex/float64/ctor' );
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
var Complex128Array = require( '@stdlib/array/complex128' );
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var add = require( '@stdlib/complex/float64/base/add' );

var rand = discreteUniform( -50, 50 );

var z1;
var z2;
var z3;
var i;
for ( i = 0; i < 100; i++ ) {
z1 = new Complex128( rand(), rand() );
z2 = new Complex128( rand(), rand() );
z3 = add( z1, z2 );
console.log( '(%s) + (%s) = %s', z1.toString(), z2.toString(), z3.toString() );
}
// Generate arrays of random values:
var z1 = new Complex128Array( discreteUniform( 200, -50, 50 ) );
var z2 = new Complex128Array( discreteUniform( 200, -50, 50 ) );

// Perform multiplication on each element of arrays:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Planeshifter Please perform more careful reviews. This comment is clearly incorrect.

logEachMap( '(%s) * (%s) = %s', z1, z2, add );
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is incorrect.

```

</section>
Expand Down
21 changes: 8 additions & 13 deletions lib/node_modules/@stdlib/complex/float64/base/add/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,14 @@

'use strict';

var Complex128 = require( '@stdlib/complex/float64/ctor' );
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
var Complex128Array = require( '@stdlib/array/complex128' );
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var add = require( './../lib' );

var rand = discreteUniform( -50, 50 );
// Generate an array of random values:
var z1 = new Complex128Array( discreteUniform( 200, -50, 50 ) );
var z2 = new Complex128Array( discreteUniform( 200, -50, 50 ) );

var z1;
var z2;
var z3;
var i;
for ( i = 0; i < 100; i++ ) {
z1 = new Complex128( rand(), rand() );
z2 = new Complex128( rand(), rand() );
z3 = add( z1, z2 );
console.log( '(%s) + (%s) = %s', z1.toString(), z2.toString(), z3.toString() );
}
// Scale each by a scalar constant:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Planeshifter Same comment.

logEachMap( '(%s) * (%s) = %s', z1, z2, add );
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is incorrect. The operation is addition not multiplication.