@stdlib/blas-base-cscal

Scale a single-precision complex floating-point vector by a single-precision complex floating-point constant.

https://github.com/stdlib-js/blas-base-cscal

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (15.3%) to scientific vocabulary

Keywords

algebra array blas complex complex64 cscal javascript level-1 linear math mathematics ndarray node node-js nodejs scale stdlib subroutines typed vector

Last synced: 4 months ago · JSON representation ·

Repository

Scale a single-precision complex floating-point vector by a single-precision complex floating-point constant.

Basic Info

Host: GitHub
Owner: stdlib-js
License: apache-2.0
Language: C
Default Branch: main
Homepage: https://github.com/stdlib-js/stdlib
Size: 390 KB

Statistics

Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Releases: 0

Topics

algebra array blas complex complex64 cscal javascript level-1 linear math mathematics ndarray node node-js nodejs scale stdlib subroutines typed vector

Created over 1 year ago · Last pushed 5 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Security

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!

cscal

Scales a single-precision complex floating-point vector by a single-precision complex floating-point constant.

## Installation ```bash npm install @stdlib/blas-base-cscal ``` Alternatively, - To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]). - If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions). - For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]). The [branches.md][branches-url] 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 ```javascript var cscal = require( '@stdlib/blas-base-cscal' ); ``` #### cscal( N, alpha, x, strideX ) Scales values from `x` by `alpha`. ```javascript var Complex64Array = require( '@stdlib/array-complex64' ); var Complex64 = require( '@stdlib/complex-float32-ctor' ); var x = new Complex64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] ); var alpha = new Complex64( 2.0, 0.0 ); cscal( 3, alpha, x, 1 ); // x => [ 2.0, 2.0, 2.0, 2.0, 2.0, 2.0 ] ``` The function has the following parameters: - **N**: number of indexed elements. - **alpha**: scalar [`Complex64`][@stdlib/complex/float32/ctor] constant. - **x**: input [`Complex64Array`][@stdlib/array/complex64]. - **strideX**: index increment for `x`. The `N` and stride parameters determine how values from `x` are scaled by `alpha`. For example, to scale every other value in `x` by `alpha`, ```javascript var Complex64Array = require( '@stdlib/array-complex64' ); var Complex64 = require( '@stdlib/complex-float32-ctor' ); var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); var alpha = new Complex64( 2.0, 0.0 ); cscal( 2, alpha, x, 2 ); // x => [ 2.0, 4.0, 3.0, 4.0, 10.0, 12.0, 7.0, 8.0 ] ``` Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. ```javascript var Complex64Array = require( '@stdlib/array-complex64' ); var Complex64 = require( '@stdlib/complex-float32-ctor' ); // Initial array: var x0 = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); // Define a scalar constant: var alpha = new Complex64( 2.0, 2.0 ); // Create an offset view: var x1 = new Complex64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element // Scales every other value from `x1` by `alpha`... cscal( 3, alpha, x1, 1 ); // x0 => [ 1.0, 2.0, -2.0, 14.0, -2.0, 22.0, -2.0, 30.0 ] ``` #### cscal.ndarray( N, alpha, x, strideX, offsetX ) Scales values from `x` by `alpha` using alternative indexing semantics. ```javascript var Complex64Array = require( '@stdlib/array-complex64' ); var Complex64 = require( '@stdlib/complex-float32-ctor' ); var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); var alpha = new Complex64( 2.0, 2.0 ); cscal.ndarray( 3, alpha, x, 1, 0 ); // x => [ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ] ``` The function has the following additional parameters: - **offsetX**: starting index for `x`. 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 scale every other value in the input strided array starting from the second element, ```javascript var Complex64Array = require( '@stdlib/array-complex64' ); var Complex64 = require( '@stdlib/complex-float32-ctor' ); var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); var alpha = new Complex64( 2.0, 2.0 ); cscal.ndarray( 2, alpha, x, 2, 1 ); // x => [ 1.0, 2.0, -2.0, 14.0, 5.0, 6.0, -2.0, 30.0 ] ```

## Notes - If `N <= 0` or `strideX <= 0`, both functions return `x` unchanged. - `cscal()` corresponds to the [BLAS][blas] level 1 function [`cscal`][cscal].

## Examples ```javascript var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); var filledarrayBy = require( '@stdlib/array-filled-by' ); var Complex64 = require( '@stdlib/complex-float32-ctor' ); var cscal = require( '@stdlib/blas-base-cscal' ); function rand() { return new Complex64( discreteUniform( 0, 10 ), discreteUniform( -5, 5 ) ); } var x = filledarrayBy( 10, 'complex64', rand ); console.log( x.toString() ); var alpha = new Complex64( 2.0, 2.0 ); console.log( alpha.toString() ); // Scale elements from `x` by `alpha`: cscal( x.length, alpha, x, 1 ); console.log( x.get( x.length-1 ).toString() ); ```

## C APIs

### Usage ```c #include "stdlib/blas/base/cscal.h" ``` #### c_cscal( N, alpha, \*X, strideX ) Scales values from `X` by `alpha`. ```c #include "stdlib/complex/float32/ctor.h" float x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f }; const stdlib_complex64_t alpha = stdlib_complex64( 2.0f, 2.0f ); c_cscal( 4, alpha, (void *)x, 1 ); ``` The function accepts the following arguments: - **N**: `[in] CBLAS_INT` number of indexed elements. - **alpha**: `[in] stdlib_complex64_t` scalar constant. - **X**: `[inout] void*` input array. - **strideX**: `[in] CBLAS_INT` index increment for `X`. ```c void c_cscal( const CBLAS_INT N, const stdlib_complex64_t alpha, void *X, const CBLAS_INT strideX ); ``` #### c_cscal_ndarray( N, alpha, \*X, strideX, offsetX ) Scales values from `X` by `alpha` using alternative indexing semantics. ```c #include "stdlib/complex/float32/ctor.h" float x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f }; const stdlib_complex64_t alpha = stdlib_complex64( 2.0f, 2.0f ); c_cscal_ndarray( 4, alpha, (void *)x, 1, 0 ); ``` The function accepts the following arguments: - **N**: `[in] CBLAS_INT` number of indexed elements. - **alpha**: `[in] stdlib_complex64_t` scalar constant. - **X**: `[inout] void*` input array. - **strideX**: `[in] CBLAS_INT` index increment for `X`. - **offsetX**: `[in] CBLAS_INT` starting index for `X`. ```c void c_cscal_ndarray( const CBLAS_INT N, const stdlib_complex64_t alpha, void *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); ```

### Examples ```c #include "stdlib/blas/base/cscal.h" #include "stdlib/complex/float32/ctor.h" #include int main( void ) { // Create a strided array of interleaved real and imaginary components: float x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f }; // Create a complex scalar: const stdlib_complex64_t alpha = stdlib_complex64( 2.0f, 2.0f ); // Specify the number of elements: const int N = 4; // Specify stride length: const int strideX = 1; // Scale the elements of the array: c_cscal( N, alpha, (void *)x, strideX ); // Print the result: for ( int i = 0; i < N; i++ ) { printf( "x[ %i ] = %f + %fj\n", i, x[ i*2 ], x[ (i*2)+1 ] ); } // Scale the elements of the array using alternative indexing semantics: c_cscal_ndarray( N, alpha, (void *)x, -strideX, 3 ); // Print the result: for ( int i = 0; i < N; i++ ) { printf( "x[ %i ] = %f + %fj\n", i, x[ i*2 ], x[ (i*2)+1 ] ); } } ```

* * * ## Notice 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] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

Owner

Name: stdlib
Login: stdlib-js
Kind: organization

Website: https://stdlib.io
Twitter: stdlibjs
Repositories: 3,692
Profile: https://github.com/stdlib-js

Standard library for JavaScript.

Citation (CITATION.cff)

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total

Push event: 72

Last Year

Push event: 72

Packages

Total packages: 1
Total downloads:
- npm 31 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 2
Total maintainers: 4

npmjs.org: @stdlib/blas-base-cscal

Scale a single-precision complex floating-point vector by a single-precision complex floating-point constant.

Homepage: https://stdlib.io
License: Apache-2.0
Latest release: 0.0.2
published over 1 year ago

Versions: 2
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 31 Last month

Rankings

Dependent repos count: 27.9%

Average: 34.3%

Dependent packages count: 40.6%

Maintainers (4)

planeshifter rreusser stdlib-bot kgryte

Funding

type: opencollective
url: https://opencollective.com/stdlib

Last synced: 5 months ago

Dependencies

.github/workflows/benchmark.yml actions

actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

.github/workflows/cancel.yml actions

styfle/cancel-workflow-action 85880fa0301c86cca9da44039ee3bb12d3bedbfa composite

.github/workflows/close_pull_requests.yml actions

superbrothers/close-pull-request 9c18513d320d7b2c7185fb93396d0c664d5d8448 composite

.github/workflows/examples.yml actions

actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

.github/workflows/npm_downloads.yml actions

actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
actions/upload-artifact 5d5d22a31266ced268874388b861e4b58bb5c2f3 composite
distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite

.github/workflows/productionize.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
stdlib-js/bundle-action main composite
stdlib-js/transform-errors-action main composite

.github/workflows/publish.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
JS-DevTools/npm-publish 4b07b26a2f6e0a51846e1870223e545bae91c552 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
styfle/cancel-workflow-action 85880fa0301c86cca9da44039ee3bb12d3bedbfa composite

.github/workflows/test.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

.github/workflows/test_bundles.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
denoland/setup-deno 041b854f97b325bd60e53e9dc2de9cb9f9ac0cba composite

.github/workflows/test_coverage.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
codecov/codecov-action 84508663e988701840491b86de86b666e8a86bed composite
distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite

.github/workflows/test_install.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

package.json npm

@stdlib/array-complex64 ^0.2.1 development
@stdlib/array-filled-by ^0.2.1 development
@stdlib/array-float32 ^0.2.1 development
@stdlib/assert-is-browser ^0.2.1 development
@stdlib/bench-harness ^0.2.1 development
@stdlib/blas-base-cscal github:stdlib-js/blas-base-cscal#main development
@stdlib/constants-float32-eps ^0.2.1 development
@stdlib/math-base-assert-is-nanf ^0.2.1 development
@stdlib/math-base-special-abs ^0.2.1 development
@stdlib/math-base-special-pow ^0.2.1 development
@stdlib/random-array-uniform ^0.2.1 development
@stdlib/random-base-discrete-uniform ^0.2.1 development
@stdlib/strided-base-min-view-buffer-index ^0.2.1 development
@stdlib/strided-base-reinterpret-complex64 ^0.2.0 development
istanbul ^0.4.1 development
proxyquire ^2.0.0 development
tap-min git+https://github.com/Planeshifter/tap-min.git development
tape git+https://github.com/kgryte/tape.git#fix/globby development
@stdlib/assert-is-error ^0.2.1
@stdlib/blas-base-shared ^0.0.1
@stdlib/complex-float32-ctor github:stdlib-js/complex-float32-ctor#main
@stdlib/math-base-ops-cmulf ^0.2.1
@stdlib/napi-argv ^0.2.1
@stdlib/napi-argv-complex64 ^0.0.1
@stdlib/napi-argv-int64 ^0.2.1
@stdlib/napi-argv-strided-complex64array ^0.2.1
@stdlib/napi-export ^0.2.1
@stdlib/types ^0.3.2
@stdlib/utils-define-nonenumerable-read-only-property ^0.2.1
@stdlib/utils-library-manifest ^0.2.1
@stdlib/utils-try-require ^0.2.1

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science

@stdlib/blas-base-cscal

Science Score: 44.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

cscal

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Packages

npmjs.org: @stdlib/blas-base-cscal

Rankings

Maintainers (4)

Funding

Dependencies