Skip to content

Commit 3b08499

Browse files
authored
docs: change package naming and examples for complex/float32/base/mul
PR-URL: #7167 Reviewed-by: Philipp Burckhardt <[email protected]> Signed-off-by: Shabareesh Shetty <[email protected]>
1 parent c705a94 commit 3b08499

File tree

5 files changed

+27
-37
lines changed

5 files changed

+27
-37
lines changed

lib/node_modules/@stdlib/complex/float32/base/mul/README.md

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -124,22 +124,17 @@ The function supports the following parameters:
124124
<!-- eslint no-undef: "error" -->
125125

126126
```javascript
127-
var Complex64 = require( '@stdlib/complex/float32/ctor' );
128-
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
127+
var Complex64Array = require( '@stdlib/array/complex64' );
128+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
129+
var logEachMap = require( '@stdlib/console/log-each-map' );
129130
var mul = require( '@stdlib/complex/float32/base/mul' );
130131

131-
var rand = discreteUniform( -50, 50 );
132-
133-
var z1;
134-
var z2;
135-
var z3;
136-
var i;
137-
for ( i = 0; i < 100; i++ ) {
138-
z1 = new Complex64( rand(), rand() );
139-
z2 = new Complex64( rand(), rand() );
140-
z3 = mul( z1, z2 );
141-
console.log( '(%s) * (%s) = %s', z1.toString(), z2.toString(), z3.toString() );
142-
}
132+
// Generate arrays of random values:
133+
var z1 = new Complex64Array( discreteUniform( 200, -50, 50 ) );
134+
var z2 = new Complex64Array( discreteUniform( 200, -50, 50 ) );
135+
136+
// Perform multiplication on each element of arrays:
137+
logEachMap( '(%s) * (%s) = %s', z1, z2, mul );
143138
```
144139

145140
</section>

lib/node_modules/@stdlib/complex/float32/base/mul/examples/index.js

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,14 @@
1818

1919
'use strict';
2020

21-
var Complex64 = require( '@stdlib/complex/float32/ctor' );
22-
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
21+
var Complex64Array = require( '@stdlib/array/complex64' );
22+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
23+
var logEachMap = require( '@stdlib/console/log-each-map' );
2324
var mul = require( './../lib' );
2425

25-
var rand = discreteUniform( -50, 50 );
26+
// Generate arrays of random values:
27+
var z1 = new Complex64Array( discreteUniform( 200, -50, 50 ) );
28+
var z2 = new Complex64Array( discreteUniform( 200, -50, 50 ) );
2629

27-
var z1;
28-
var z2;
29-
var z3;
30-
var i;
31-
for ( i = 0; i < 100; i++ ) {
32-
z1 = new Complex64( rand(), rand() );
33-
z2 = new Complex64( rand(), rand() );
34-
z3 = mul( z1, z2 );
35-
console.log( '(%s) * (%s) = %s', z1.toString(), z2.toString(), z3.toString() );
36-
}
30+
// Scale each by a scalar constant:
31+
logEachMap( '(%s) * (%s) = %s', z1, z2, mul );

lib/node_modules/@stdlib/complex/float32/base/mul/lib/assign.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
// MODULES //
2222

23-
var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' );
23+
var f32 = require( '@stdlib/number/float64/base/to-float32' );
2424

2525

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

lib/node_modules/@stdlib/complex/float32/base/mul/lib/main.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
// MODULES //
2222

23-
var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' );
23+
var f32 = require( '@stdlib/number/float64/base/to-float32' );
2424
var Complex64 = require( '@stdlib/complex/float32/ctor' );
2525
var realf = require( '@stdlib/complex/float32/real' );
2626
var imagf = require( '@stdlib/complex/float32/imag' );
@@ -60,9 +60,9 @@ function mul( z1, z2 ) {
6060
var re2 = realf( z2 );
6161
var im1 = imagf( z1 );
6262
var im2 = imagf( z2 );
63-
var re = float64ToFloat32(re1*re2) - float64ToFloat32(im1*im2);
64-
var im = float64ToFloat32(re1*im2) + float64ToFloat32(im1*re2);
65-
return new Complex64( float64ToFloat32( re ), float64ToFloat32( im ) );
63+
var re = f32(re1*re2) - f32(im1*im2);
64+
var im = f32(re1*im2) + f32(im1*re2);
65+
return new Complex64( f32( re ), f32( im ) );
6666
}
6767

6868

lib/node_modules/@stdlib/complex/float32/base/mul/lib/strided.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
// MODULES //
2222

23-
var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' );
23+
var f32 = require( '@stdlib/number/float64/base/to-float32' );
2424

2525

2626
// MAIN //
@@ -53,8 +53,8 @@ function strided( z1, strideZ1, offsetZ1, z2, strideZ2, offsetZ2, out, strideOut
5353
var im1 = z1[ offsetZ1+strideZ1 ];
5454
var re2 = z2[ offsetZ2 ];
5555
var im2 = z2[ offsetZ2+strideZ2 ];
56-
out[ offsetOut ] = float64ToFloat32(re1*re2) - float64ToFloat32(im1*im2);
57-
out[ offsetOut+strideOut ] = float64ToFloat32(re1*im2) + float64ToFloat32(im1*re2);
56+
out[ offsetOut ] = f32(re1*re2) - f32(im1*im2);
57+
out[ offsetOut+strideOut ] = f32(re1*im2) + f32(im1*re2);
5858
return out;
5959
}
6060

0 commit comments

Comments
 (0)