About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

scale

Scale a single-precision complex floating-point number by a real-valued single-precision floating-point scalar constant.

Installation

npm install @stdlib/complex-float32-base-scale

Alternatively,

• To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
• If you are using Deno, visit the deno branch (see README for usage intructions).
• For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

var scale = require( '@stdlib/complex-float32-base-scale' );

scale( alpha, c )

Scales a single-precision complex floating-point number by a real-valued single-precision floating-point scalar constant.

var Complex64 = require( '@stdlib/complex-float32-ctor' );

var c = new Complex64( 5.0, 3.0 );

var v = scale( 5.0, c );
// returns <Complex64>[ 25.0, 15.0 ]

The function supports the following parameters:

• alpha: real-valued scalar constant.
• c: complex number.

scale.assign( alpha, re1, im1, out, strideOut, offsetOut )

Scales a single-precision complex floating-point number by a real-valued single-precision floating-point scalar constant and assigns results to a provided output array.

var Float32Array = require( '@stdlib/array-float32' );

var out = new Float32Array( 2 );
var v = scale.assign( 5.0, 5.0, 3.0, out, 1, 0 );
// returns <Float32Array>[ 25.0, 15.0 ]

var bool = ( out === v );
// returns true

The function supports the following parameters:

• alpha: real-valued scalar constant.
• re: real component of the complex number.
• im: imaginary component of the complex number.
• out: output array.
• strideOut: stride length for out.
• offsetOut: starting index for out.

scale.strided( alpha, c, sc, oc, out, so, oo )

Scales a single-precision complex floating-point number stored in a real-valued strided array view by a real-valued single-precision floating-point scalar constant and assigns results to a provided strided output array.

var Float32Array = require( '@stdlib/array-float32' );

var c = new Float32Array( [ 5.0, 3.0 ] );
var out = new Float32Array( 2 );

var v = scale.strided( 5.0, c, 1, 0, out, 1, 0 );
// returns <Float32Array>[ 25.0, 15.0 ]

var bool = ( out === v );
// returns true

The function supports the following parameters:

• alpha: real-valued scalar constant.
• c: complex number strided array view.
• sc: stride length for c.
• oc: starting index for c.
• out: output array.
• so: stride length for out.
• oo: starting index for out.

Examples

var Complex64Array = require( '@stdlib/array-complex64' );
var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var scale = require( '@stdlib/complex-float32-base-scale' );

// Generate an array of random values:
var values = new Complex64Array( discreteUniform( 200, -50, 50 ) );

// Scale each by a scalar constant:
logEachMap( '%0.1f * (%s) = %s', 5.0, values, scale );

---

C APIs

Usage

#include "stdlib/complex/float32/base/scale.h"

stdlib_base_complex64_scale( alpha, c )

Scales a single-precision complex floating-point number by a real-valued single-precision floating-point scalar constant.

#include "stdlib/complex/float32/ctor.h"
#include "stdlib/complex/float32/real.h"
#include "stdlib/complex/float32/imag.h"

stdlib_complex64_t c = stdlib_complex64( 5.0f, 3.0f );

stdlib_complex64_t out = stdlib_base_complex64_scale( 5.0f, c );

float re = stdlib_complex64_real( out );
// returns 25.0f

float im = stdlib_complex64_imag( out );
// returns 15.0f

The function accepts the following arguments:

• alpha: [in] float scalar constant.
• c: [in] stdlib_complex64_t complex number.

stdlib_complex64_t stdlib_base_complex64_scale( const float alpha, const stdlib_complex64_t c );

Examples

#include "stdlib/complex/float32/base/scale.h"
#include "stdlib/complex/float32/ctor.h"
#include "stdlib/complex/float32/reim.h"
#include <stdio.h>

int main( void ) {
    const stdlib_complex64_t x[] = {
        stdlib_complex64( 3.14f, 1.5f ),
        stdlib_complex64( -3.14f, 1.5f ),
        stdlib_complex64( 0.0f, -0.0f ),
        stdlib_complex64( 0.0f/0.0f, 0.0f/0.0f )
    };

    stdlib_complex64_t v;
    stdlib_complex64_t y;
    float re;
    float im;
    int i;
    for ( i = 0; i < 4; i++ ) {
        v = x[ i ];
        stdlib_complex64_reim( v, &re, &im );
        printf( "c = %f + %fi\n", re, im );

        y = stdlib_base_complex64_scale( 5.0f, v );
        stdlib_complex64_reim( y, &re, &im );
        printf( "scale(5.0, c) = %f + %fi\n", re, im );
    }
}

---

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

---

License

See LICENSE.

Copyright

Copyright © 2016-2025. The Stdlib Authors.