Skip to content

docs: update examples for complex/float32/base/scale #7292

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 9, 2025
Merged

docs: update examples for complex/float32/base/scale #7292

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/float32/base/scale/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,19 +42,11 @@ Scales a single-precision complex floating-point number by a real-valued single-

```javascript
var Complex64 = require( '@stdlib/complex/float32/ctor' );
var realf = require( '@stdlib/complex/float32/real' );
var imagf = require( '@stdlib/complex/float32/imag' );

var c = new Complex64( 5.0, 3.0 );

var v = scale( 5.0, c );
// returns <Complex64>

var re = realf( v );
// returns 25.0

var im = imagf( v );
// returns 15.0
// returns <Complex64>[ 25.0, 15.0 ]
```

The function supports the following parameters:
Expand Down
22 changes: 2 additions & 20 deletions lib/node_modules/@stdlib/complex/float32/base/scale/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,20 +36,11 @@ interface Scale {
*
* @example
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* var z = new Complex64( 5.0, 3.0 );
* // returns <Complex64>
*
* var out = scale( 5.0, z );
* // returns <Complex64>
*
* var re = realf( out );
* // returns 25.0
*
* var im = imagf( out );
* // returns 15.0
* // returns <Complex64>[ 25.0, 15.0 ]
*/
( alpha: number, z: Complex64 ): Complex64;

Expand Down Expand Up @@ -108,20 +99,11 @@ interface Scale {
*
* @example
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* var z = new Complex64( 5.0, 3.0 );
* // returns <Complex64>
*
* var out = scale( 5.0, z );
* // returns <Complex64>
*
* var re = realf( out );
* // returns 25.0
*
* var im = imagf( out );
* // returns 15.0
* // returns <Complex64>[ 25.0, 15.0 ]
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
Expand Down
11 changes: 1 addition & 10 deletions lib/node_modules/@stdlib/complex/float32/base/scale/lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,21 +25,12 @@
*
* @example
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
* var scale = require( '@stdlib/complex/float32/base/scale' );
*
* var z = new Complex64( 5.0, 3.0 );
* // returns <Complex64>
*
* var out = scale( scalar, z );
* // returns <Complex64>
*
* var re = realf( out );
* // returns 25.0
*
* var im = imagf( out );
* // returns 15.0
* // returns <Complex64>[ 25.0, 15.0 ]
*/

// MODULES //
Expand Down
11 changes: 1 addition & 10 deletions lib/node_modules/@stdlib/complex/float32/base/scale/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,20 +37,11 @@ var imagf = require( '@stdlib/complex/float32/imag' );
*
* @example
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* var z = new Complex64( 5.0, 3.0 );
* // returns <Complex64>
*
* var out = scale( 5.0, z );
* // returns <Complex64>
*
* var re = realf( out );
* // returns 25.0
*
* var im = imagf( out );
* // returns 15.0
* // returns <Complex64>[ 25.0, 15.0 ]
*/
function scale( alpha, z ) {
return new Complex64( f32( realf(z)*alpha ), f32( imagf(z)*alpha ) );
Expand Down
11 changes: 1 addition & 10 deletions lib/node_modules/@stdlib/complex/float32/base/scale/lib/native.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,20 +36,11 @@ var addon = require( './../src/addon.node' );
*
* @example
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* var z = new Complex64( 5.0, 3.0 );
* // returns <Complex64>
*
* var out = scale( 5.0, z );
* // returns <Complex64>
*
* var re = realf( out );
* // returns 25.0
*
* var im = imagf( out );
* // returns 15.0
* // returns <Complex64>[ 25.0, 15.0 ]
*/
function scale( alpha, z ) {
var v = addon( alpha, z );
Expand Down