Multiply a vector by a scalar constant.
npm install @stdlib/blas-base-gscalWe 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!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Multiply a vector by a scalar constant.
``bash`
npm install @stdlib/blas-base-gscal
`javascript`
var gscal = require( '@stdlib/blas-base-gscal' );
#### gscal( N, alpha, x, stride )
Multiplies a vector by a scalar constant.
`javascript
var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ];
gscal( x.length, 5.0, x, 1 );
// x => [ -10.0, 5.0, 15.0, -25.0, 20.0, 0.0, -5.0, -15.0 ]
`
The function has the following parameters:
- N: number of indexed elements.
- alpha: scalar constant.
- x: input [Array][mdn-array] or [typed array][mdn-typed-array].
- stride: stride length.
The N and stride parameters determine which elements in the strided array are accessed at runtime. For example, to multiply every other value by a scalar constant:
`javascript
var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ];
gscal( 4, 5.0, x, 2 );
// x => [ -10.0, 1.0, 15.0, -5.0, 20.0, 0.0, -5.0, -3.0 ]
`
Note that indexing is relative to the first index. To introduce an offset, use [typed array][mdn-typed-array] views.
`javascript
var Float64Array = require( '@stdlib/array-float64' );
// Initial array:
var x0 = new Float64Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
// Create an offset view:
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
// Scale every other value:
gscal( 3, 5.0, x1, 2 );
// x0 =>
`
If either N or stride is less than or equal to 0, the function returns x unchanged.
#### gscal.ndarray( N, alpha, x, stride, offset )
Multiplies a vector by a scalar constant using alternative indexing semantics.
`javascript
var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ];
gscal.ndarray( x.length, 5.0, x, 1, 0 );
// x => [ -10.0, 5.0, 15.0, -25.0, 20.0, 0.0, -5.0, -15.0 ]
`
The function has the following additional parameters:
- offset: starting index.
While [typed array][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to multiply the last three elements:
`javascript
var x = [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ];
gscal.ndarray( 3, 5.0, x, 1, x.length-3 );
// x => [ 1.0, -2.0, 3.0, -20.0, 25.0, -30.0 ]
`
- If N <= 0, both functions return x unchanged.gscal()
- corresponds to the [BLAS][blas] level 1 function [dscal][dscal] with the exception that this implementation works with any array type, not just Float64Arrays. Depending on the environment, the typed versions ([dscal][@stdlib/blas/base/dscal], [sscal][@stdlib/blas/base/sscal], etc.) are likely to be significantly more performant.@stdlib/array-base/accessor
- Both functions support array-like objects having getter and setter accessors for array element access (e.g., [][@stdlib/array/base/accessor]).
`javascript
var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var gscal = require( '@stdlib/blas-base-gscal' );
var opts = {
'dtype': 'float64'
};
var x = discreteUniform( 10, -100, 100, opts );
console.log( x );
gscal( x.length, 5.0, x, 1 );
console.log( x );
`
*
- [@stdlib/blas-base/dscal][@stdlib/blas/base/dscal]: multiply a double-precision floating-point vector by a constant.
- [@stdlib/blas-base/gaxpy][@stdlib/blas/base/gaxpy]: multiply a vector x by a constant and add the result to y.
- [@stdlib/blas-base/sscal][@stdlib/blas/base/sscal]: multiply a single-precision floating-point vector by a constant.
*
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/blas-base-gscal.svg
[npm-url]: https://npmjs.org/package/@stdlib/blas-base-gscal
[test-image]: https://github.com/stdlib-js/blas-base-gscal/actions/workflows/test.yml/badge.svg?branch=v0.3.1
[test-url]: https://github.com/stdlib-js/blas-base-gscal/actions/workflows/test.yml?query=branch:v0.3.1
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/blas-base-gscal/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/blas-base-gscal?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/blas-base-gscal/tree/deno
[deno-readme]: https://github.com/stdlib-js/blas-base-gscal/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/blas-base-gscal/tree/umd
[umd-readme]: https://github.com/stdlib-js/blas-base-gscal/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/blas-base-gscal/tree/esm
[esm-readme]: https://github.com/stdlib-js/blas-base-gscal/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/blas-base-gscal/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/blas-base-gscal/main/LICENSE
[blas]: http://www.netlib.org/blas
[dscal]: http://www.netlib.org/lapack/explore-html/de/da4/group__double__blas__level1.html
[mdn-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
[@stdlib/array/base/accessor]: https://www.npmjs.com/package/@stdlib/array-base-accessor
[@stdlib/blas/base/dscal]: https://www.npmjs.com/package/@stdlib/blas-base-dscal
[@stdlib/blas/base/sscal]: https://www.npmjs.com/package/@stdlib/blas-base-sscal
[@stdlib/blas/base/gaxpy]: https://www.npmjs.com/package/@stdlib/blas-base-gaxpy