Skip to content

Latest commit

 

History

History
284 lines (182 loc) · 8.91 KB

README.md

File metadata and controls

284 lines (182 loc) · 8.91 KB
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

NPM version Build Status Coverage Status

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

Usage

To use in Observable,

scale = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/complex-float64-base-scale@umd/browser.js' )

To vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:

var scale = require( 'path/to/vendor/umd/complex-float64-base-scale/index.js' )

To include the bundle in a webpage,

<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/complex-float64-base-scale@umd/browser.js"></script>

If no recognized module system is present, access bundle contents via the global scope:

<script type="text/javascript">
(function () {
    window.scale;
})();
</script>

scale( alpha, z )

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

var Complex128 = require( '@stdlib/complex-float64-ctor' );
var real = require( '@stdlib/complex-float64-real' );
var imag = require( '@stdlib/complex-float64-imag' );

var z = new Complex128( 5.0, 3.0 );

var v = scale( 5.0, z );
// returns <Complex128>

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

var im = imag( v );
// returns 15.0

The function supports the following parameters:

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

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

var Float64Array = require( '@stdlib/array-float64' );

var out = new Float64Array( 2 );
var v = scale.assign( 5.0, 5.0, 3.0, out, 1, 0 );
// returns <Float64Array>[ 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, z, sz, oz, out, so, oo )

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

var Float64Array = require( '@stdlib/array-float64' );

var z = new Float64Array( [ 5.0, 3.0 ] );
var out = new Float64Array( 2 );

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

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

The function supports the following parameters:

  • alpha: real-valued scalar constant.
  • z: complex number strided array view.
  • sz: stride length for z.
  • oz: starting index for z.
  • out: output array.
  • so: stride length for out.
  • oo: starting index for out.

Examples

<!DOCTYPE html>
<html lang="en">
<body>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/complex-float64-ctor@umd/browser.js"></script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/random-base-discrete-uniform@umd/browser.js"></script>
<script type="text/javascript">
(function () {.factory;
var scale = require( '@stdlib/complex-float64-base-scale' );

var rand = discreteUniform( -50, 50 );

var z1;
var z2;
var i;
for ( i = 0; i < 100; i++ ) {
    z1 = new Complex128( rand(), rand() );
    z2 = scale( 5.0, z1 );
    console.log( '(%s) * 5.0 = %s', z1.toString(), z2.toString() );
}

})();
</script>
</body>
</html>

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

Chat

License

See LICENSE.

Copyright

Copyright © 2016-2025. The Stdlib Authors.