Skip to content

docs: change package naming and examples for complex/float32/base/mul #7167

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

docs: change package naming and examples for complex/float32/base/mul #7167

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e8f770f
docs: change package naming and examples
ShabiShett07 Jun 2, 2025
80fde06
chore: update implementation
ShabiShett07 Jun 2, 2025
adde591
chore: minor clean-up
ShabiShett07 Jun 2, 2025
04fa0f8
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/float32/base/mul/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,22 +124,17 @@ The function supports the following parameters:
<!-- 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 mul = require( '@stdlib/complex/float32/base/mul' );

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 = mul( 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 multiplication on each element of arrays:
logEachMap( '(%s) * (%s) = %s', z1, z2, mul );
```

</section>
Expand Down
21 changes: 8 additions & 13 deletions lib/node_modules/@stdlib/complex/float32/base/mul/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 mul = 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 = mul( z1, z2 );
console.log( '(%s) * (%s) = %s', z1.toString(), z2.toString(), z3.toString() );
}
// Scale each by a scalar constant:
logEachMap( '(%s) * (%s) = %s', z1, z2, mul );
6 changes: 3 additions & 3 deletions lib/node_modules/@stdlib/complex/float32/base/mul/lib/assign.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' );


// MAIN //
Expand All @@ -44,8 +44,8 @@ var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' );
* // returns <Float32Array>[ -13.0, -1.0 ]
*/
function assign( re1, im1, re2, im2, out, strideOut, offsetOut ) {
out[ offsetOut ] = float64ToFloat32(re1*re2) - float64ToFloat32(im1*im2);
out[ offsetOut+strideOut ] = float64ToFloat32(re1*im2) + float64ToFloat32(im1*re2);
out[ offsetOut ] = f32(re1*re2) - f32(im1*im2);
out[ offsetOut+strideOut ] = f32(re1*im2) + f32(im1*re2);
return out;
}

Expand Down
8 changes: 4 additions & 4 deletions lib/node_modules/@stdlib/complex/float32/base/mul/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 @@ -60,9 +60,9 @@ function mul( z1, z2 ) {
var re2 = realf( z2 );
var im1 = imagf( z1 );
var im2 = imagf( z2 );
var re = float64ToFloat32(re1*re2) - float64ToFloat32(im1*im2);
var im = float64ToFloat32(re1*im2) + float64ToFloat32(im1*re2);
return new Complex64( float64ToFloat32( re ), float64ToFloat32( im ) );
var re = f32(re1*re2) - f32(im1*im2);
var im = f32(re1*im2) + f32(im1*re2);
return new Complex64( f32( re ), f32( im ) );
}


Expand Down
6 changes: 3 additions & 3 deletions lib/node_modules/@stdlib/complex/float32/base/mul/lib/strided.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' );


// MAIN //
Expand Down Expand Up @@ -53,8 +53,8 @@ function strided( z1, strideZ1, offsetZ1, z2, strideZ2, offsetZ2, out, strideOut
var im1 = z1[ offsetZ1+strideZ1 ];
var re2 = z2[ offsetZ2 ];
var im2 = z2[ offsetZ2+strideZ2 ];
out[ offsetOut ] = float64ToFloat32(re1*re2) - float64ToFloat32(im1*im2);
out[ offsetOut+strideOut ] = float64ToFloat32(re1*im2) + float64ToFloat32(im1*re2);
out[ offsetOut ] = f32(re1*re2) - f32(im1*im2);
out[ offsetOut+strideOut ] = f32(re1*im2) + f32(im1*re2);
return out;
}

Expand Down