Multiply a single-precision floating-point vector by a constant.
npm install @stdlib/blas-base-sscalWe 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 single-precision floating-point vector x by a constant alpha.
``bash`
npm install @stdlib/blas-base-sscal
`javascript`
var sscal = require( '@stdlib/blas-base-sscal' );
#### sscal( N, alpha, x, stride )
Multiplies a single-precision floating-point vector x by a constant alpha.
`javascript
var Float32Array = require( '@stdlib/array-float32' );
var x = new Float32Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );
sscal( x.length, 5.0, x, 1 );
// x =>
`
The function has the following parameters:
- N: number of indexed elements.
- alpha: scalar constant.
- x: input [Float32Array][@stdlib/array/float32].
- stride: index increment.
The N and stride parameters determine which elements in x are accessed at runtime. For example, to multiply every other value by a constant
`javascript
var Float32Array = require( '@stdlib/array-float32' );
var x = new Float32Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );
sscal( 4, 5.0, x, 2 );
// x =>
`
Note that indexing is relative to the first index. To introduce an offset, use [typed array][mdn-typed-array] views.
`javascript
var Float32Array = require( '@stdlib/array-float32' );
// Initial array:
var x0 = new Float32Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
// Create an offset view:
var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
// Scale every other value:
sscal( 3, 5.0, x1, 2 );
// x0 =>
`
If either N or stride is less than or equal to 0, the function returns x unchanged.
#### sscal.ndarray( N, alpha, x, stride, offset )
Multiplies a single-precision floating-point vector x by a constant alpha using alternative indexing semantics.
`javascript
var Float32Array = require( '@stdlib/array-float32' );
var x = new Float32Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );
sscal.ndarray( x.length, 5.0, x, 1, 0 );
// x =>
`
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 of x by a constant
`javascript
var Float32Array = require( '@stdlib/array-float32' );
var x = new Float32Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
sscal.ndarray( 3, 5.0, x, 1, x.length-3 );
// x =>
`
- If N <= 0, both functions return x unchanged.sscal()
- corresponds to the [BLAS][blas] level 1 function [sscal][sscal].
`javascript
var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var sscal = require( '@stdlib/blas-base-sscal' );
var opts = {
'dtype': 'float32'
};
var x = discreteUniform( 10, -100, 100, opts );
console.log( x );
sscal( x.length, 5.0, x, 1 );
console.log( x );
`
*
`c`
#include "stdlib/blas/base/sscal.h"
#### c_sscal( N, alpha, \*X, stride )
Multiplies each element of a single-precision floating-point vector by a constant.
`c
float x[] = { 1.0f, 2.0f, 3.0f, 4.0f };
c_sscal( 4, 5.0f, x, 1 );
`
The function accepts the following arguments:
- N: [in] CBLAS_INT number of indexed elements.[in] float
- alpha: scalar constant.[inout] float*
- X: input array.[in] CBLAS_INT
- stride: index increment for X.
`c`
void c_sscal( const CBLAS_INT N, const float alpha, float *X, const CBLAS_INT stride );
#### c_sscal_ndarray( N, alpha, \*X, stride, offset )
Multiplies each element of a single-precision floating-point vector by a constant using alternative indexing semantics.
`c
float x[] = { 1.0f, 2.0f, 3.0f, 4.0f };
c_sscal_ndarray( 4, 5.0f, x, 1, 0 );
`
The function accepts the following arguments:
- N: [in] CBLAS_INT number of indexed elements.[in] float
- alpha: scalar constant.[inout] float*
- X: input array.[in] CBLAS_INT
- stride: index increment for X.[in] CBLAS_INT
- offset: starting index for X.
`c`
void c_sscal_ndarray( const CBLAS_INT N, const float alpha, float *X, const CBLAS_INT stride, const CBLAS_INT offset );
`c
#include "stdlib/blas/base/sscal.h"
#include
int main( void ) {
// Create a strided array:
float x[] = { 1.0f, -2.0f, 3.0f, -4.0f, 5.0f, -6.0f, 7.0f, -8.0f };
// Specify the number of elements:
const int N = 8;
// Specify a stride:
const int stride = 1;
// Scale the vector:
c_sscal( N, 5.0f, x, stride );
// Print the result:
for ( int i = 0; i < 8; i++ ) {
printf( "x[ %i ] = %f\n", i, x[ i ] );
}
// Scale the vector using alternative indexing semantics:
c_sscal_ndarray( N, 5.0f, x, -stride, N-1 );
// Print the result:
for ( int i = 0; i < 8; i++ ) {
printf( "x[ %i ] = %f\n", i, x[ i ] );
}
}
`
*
- [@stdlib/blas-base/daxpy][@stdlib/blas/base/daxpy]: multiply a vector x by a constant and add the result to y.
- [@stdlib/blas-base/dscal][@stdlib/blas/base/dscal]: multiply a double-precision floating-point vector by a constant.
- [@stdlib/blas-base/gscal][@stdlib/blas/base/gscal]: multiply a vector by a scalar constant.
- [@stdlib/blas-base/saxpy][@stdlib/blas/base/saxpy]: multiply a vector x by a constant and add the result to y.
*
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-sscal.svg
[npm-url]: https://npmjs.org/package/@stdlib/blas-base-sscal
[test-image]: https://github.com/stdlib-js/blas-base-sscal/actions/workflows/test.yml/badge.svg?branch=v0.3.1
[test-url]: https://github.com/stdlib-js/blas-base-sscal/actions/workflows/test.yml?query=branch:v0.3.1
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/blas-base-sscal/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/blas-base-sscal?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-sscal/tree/deno
[deno-readme]: https://github.com/stdlib-js/blas-base-sscal/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/blas-base-sscal/tree/umd
[umd-readme]: https://github.com/stdlib-js/blas-base-sscal/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/blas-base-sscal/tree/esm
[esm-readme]: https://github.com/stdlib-js/blas-base-sscal/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/blas-base-sscal/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/blas-base-sscal/main/LICENSE
[blas]: http://www.netlib.org/blas
[sscal]: http://www.netlib.org/lapack/explore-html/df/d28/group__single__blas__level1.html
[@stdlib/array/float32]: https://www.npmjs.com/package/@stdlib/array-float32
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
[@stdlib/blas/base/daxpy]: https://www.npmjs.com/package/@stdlib/blas-base-daxpy
[@stdlib/blas/base/dscal]: https://www.npmjs.com/package/@stdlib/blas-base-dscal
[@stdlib/blas/base/gscal]: https://www.npmjs.com/package/@stdlib/blas-base-gscal
[@stdlib/blas/base/saxpy]: https://www.npmjs.com/package/@stdlib/blas-base-saxpy