Skip to content

docs: change package naming and examples for complex/float32/base/add #7169

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 9 commits into from
Jun 4, 2025
Merged

docs: change package naming and examples for complex/float32/base/add #7169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
203e57a
docs: change package naming and examples for complex/float32/base/add
ShabiShett07 Jun 2, 2025
3e632a1
chore: update implementation
ShabiShett07 Jun 2, 2025
14682d8
Merge remote-tracking branch 'upstream/develop' into docs/add
stdlib-bot Jun 2, 2025
6362f35
chore: minor clean-up
ShabiShett07 Jun 2, 2025
bb69095
chore: minor clean-up
ShabiShett07 Jun 2, 2025
83bc4b5
chore: minor clean-up
ShabiShett07 Jun 3, 2025
c6986a7
chore: minor clean-up
ShabiShett07 Jun 3, 2025
2ef731e
chore: minor clean-up
ShabiShett07 Jun 3, 2025
44634b8
chore: minor clean-up
ShabiShett07 Jun 3, 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/float32/base/add/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,22 +68,17 @@ var im = imagf( v );
<!-- eslint no-undef: "error" -->

```javascript
var Complex64 = require( '@stdlib/complex/float32/ctor' );
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
var Complex64Array = require( '@stdlib/array/complex64' );
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var add = require( '@stdlib/complex/float32/base/add' );

var rand = discreteUniform( -50, 50 );

var z1;
var z2;
var z3;
var i;
for ( i = 0; i < 100; i++ ) {
z1 = new Complex64( rand(), rand() );
z2 = new Complex64( 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 Complex64Array( discreteUniform( 200, -50, 50 ) );
var z2 = new Complex64Array( discreteUniform( 200, -50, 50 ) );

// Perform element-wise addition:
logEachMap( '(%s) + (%s) = %s', z1, z2, add );
```

</section>
Expand Down
21 changes: 8 additions & 13 deletions lib/node_modules/@stdlib/complex/float32/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 Complex64 = require( '@stdlib/complex/float32/ctor' );
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
var Complex64Array = require( '@stdlib/array/complex64' );
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 arrays of random values:
var z1 = new Complex64Array( discreteUniform( 200, -50, 50 ) );
var z2 = new Complex64Array( discreteUniform( 200, -50, 50 ) );

var z1;
var z2;
var z3;
var i;
for ( i = 0; i < 100; i++ ) {
z1 = new Complex64( rand(), rand() );
z2 = new Complex64( rand(), rand() );
z3 = add( z1, z2 );
console.log( '(%s) + (%s) = %s', z1.toString(), z2.toString(), z3.toString() );
}
// Perform element-wise addition:
logEachMap( '(%s) + (%s) = %s', z1, z2, add );
6 changes: 3 additions & 3 deletions lib/node_modules/@stdlib/complex/float32/base/add/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

// MODULES //

var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' );
var f32 = require( '@stdlib/number/float64/base/to-float32' );
var Complex64 = require( '@stdlib/complex/float32/ctor' );
var realf = require( '@stdlib/complex/float32/real' );
var imagf = require( '@stdlib/complex/float32/imag' );
Expand Down Expand Up @@ -53,8 +53,8 @@ var imagf = require( '@stdlib/complex/float32/imag' );
* // returns 6.0
*/
function add( z1, z2 ) {
var re = float64ToFloat32( realf( z1 ) + realf( z2 ) );
var im = float64ToFloat32( imagf( z1 ) + imagf( z2 ) );
var re = f32( realf( z1 ) + realf( z2 ) );
var im = f32( imagf( z1 ) + imagf( z2 ) );
return new Complex64( re, im );
}

Expand Down