Data

Tools

Indexes

Applications

Experiments

Open Source Science

blas-base-sger

Perform the rank 1 operation `A = α*x*y^T + A`.

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

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
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.7%) to scientific vocabulary

Keywords

algebra array blas float float32 float32array javascript level-2 linear math mathematics ndarray node node-js nodejs sger stdlib subroutines
Last synced: 4 months ago · JSON representation ·

Repository

Perform the rank 1 operation `A = α*x*y^T + A`.

Basic Info
Statistics
  • Stars: 0
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
algebra array blas float float32 float32array javascript level-2 linear math mathematics ndarray node node-js nodejs sger stdlib subroutines
Created 6 months ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

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!

sger

NPM version Build Status Coverage Status <!-- dependencies -->

Perform the rank 1 operation A = α*x*y^T + A.

## Installation ```bash npm install @stdlib/blas-base-sger ``` 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 sger = require( '@stdlib/blas-base-sger' ); ``` #### sger( order, M, N, α, x, sx, y, sy, A, lda ) Performs the rank 1 operation `A = α*x*y^T + A`, where `α` is a scalar, `x` is an `M` element vector, `y` is an `N` element vector, and `A` is an `M` by `N` matrix. ```javascript var Float32Array = require( '@stdlib/array-float32' ); var A = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); var x = new Float32Array( [ 1.0, 1.0 ] ); var y = new Float32Array( [ 1.0, 1.0, 1.0 ] ); sger( 'row-major', 2, 3, 1.0, x, 1, y, 1, A, 3 ); // A => [ 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ] ``` The function has the following parameters: - **order**: storage layout. - **M**: number of rows in the matrix `A`. - **N**: number of columns in the matrix `A`. - **α**: scalar constant. - **x**: an `M` element [`Float32Array`][mdn-float32array]. - **sx**: stride length for `x`. - **y**: an `N` element [`Float32Array`][mdn-float32array]. - **sy**: stride length for `y`. - **A**: input matrix stored in linear memory as a [`Float32Array`][mdn-float32array]. - **lda**: stride of the first dimension of `A` (leading dimension of `A`). The stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to iterate over every other element in `x` and `y`, ```javascript var Float32Array = require( '@stdlib/array-float32' ); var A = new Float32Array( [ 1.0, 4.0, 2.0, 5.0, 3.0, 6.0 ] ); var x = new Float32Array( [ 1.0, 0.0, 1.0, 0.0 ] ); var y = new Float32Array( [ 1.0, 0.0, 1.0, 0.0, 1.0, 0.0 ] ); sger( 'column-major', 2, 3, 1.0, x, 2, y, 2, A, 2 ); // A => [ 2.0, 5.0, 3.0, 6.0, 4.0, 7.0 ] ``` 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 arrays... var x0 = new Float32Array( [ 0.0, 1.0, 1.0 ] ); var y0 = new Float32Array( [ 0.0, 1.0, 1.0, 1.0 ] ); var A = new Float32Array( [ 1.0, 4.0, 2.0, 5.0, 3.0, 6.0 ] ); // Create offset views... var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element var y1 = new Float32Array( y0.buffer, y0.BYTES_PER_ELEMENT*1 ); // start at 2nd element sger( 'column-major', 2, 3, 1.0, x1, -1, y1, -1, A, 2 ); // A => [ 2.0, 5.0, 3.0, 6.0, 4.0, 7.0 ] ``` #### sger.ndarray( M, N, α, x, sx, ox, y, sy, oy, A, sa1, sa2, oa ) Performs the rank 1 operation `A = α*x*y^T + A`, using alternative indexing semantics and where `α` is a scalar, `x` is an `M` element vector, `y` is an `N` element vector, and `A` is an `M` by `N` matrix. ```javascript var Float32Array = require( '@stdlib/array-float32' ); var A = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); var x = new Float32Array( [ 1.0, 1.0 ] ); var y = new Float32Array( [ 1.0, 1.0, 1.0 ] ); sger.ndarray( 2, 3, 1.0, x, 1, 0, y, 1, 0, A, 3, 1, 0 ); // A => [ 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ] ``` The function has the following additional parameters: - **sa1**: stride of the first dimension of `A`. - **sa2**: stride of the second dimension of `A`. - **oa**: starting index for `A`. - **ox**: starting index for `x`. - **oy**: starting index for `y`. While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, ```javascript var Float32Array = require( '@stdlib/array-float32' ); var A = new Float32Array( [ 0.0, 0.0, 1.0, 4.0, 2.0, 5.0, 3.0, 6.0 ] ); var x = new Float32Array( [ 0.0, 1.0, 0.0, 1.0, 0.0 ] ); var y = new Float32Array( [ 0.0, 1.0, 0.0, 1.0, 0.0, 1.0, 0.0 ] ); sger.ndarray( 2, 3, 1.0, x, 2, 1, y, 2, 1, A, 1, 2, 2 ); // A => [ 0.0, 0.0, 2.0, 5.0, 3.0, 6.0, 4.0, 7.0 ] ```
## Notes - `sger()` corresponds to the [BLAS][blas] level 2 function [`sger`][blas-sger].
## Examples ```javascript var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); var sger = require( '@stdlib/blas-base-sger' ); var opts = { 'dtype': 'float32' }; var M = 3; var N = 5; var A = discreteUniform( M*N, 0, 255, opts ); var x = discreteUniform( M, 0, 255, opts ); var y = discreteUniform( N, 0, 255, opts ); sger( 'row-major', M, N, 1.0, x, 1, y, 1, A, N ); console.log( A ); sger.ndarray( M, N, 1.0, x, 1, 0, y, 1, 0, A, 1, M, 0 ); console.log( A ); ```
## C APIs
### Usage ```c #include "stdlib/blas/base/sger.h" ``` #### c_sger( layout, M, N, alpha, \*X, strideX, \*Y, strideY, \*A, LDA ) Performs the rank 1 operation `A = alpha*x*y^T + A`, where `alpha` is a scalar, `X` is an `M` element vector, `Y` is an `N` element vector, and `A` is an `M`-by-`N` matrix. ```c #include "stdlib/blas/base/shared.h" float A[ 3*4 ] = { 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f }; const float x[ 3 ] = { 1.0f, 4.0f, 0.0f }; const float y[ 4 ] = { 0.0f, 1.0f, 2.0f, 3.0f }; c_sger( CblasRowMajor, 3, 4, 1.0f, x, 1, y, 1, A, 4 ); ``` The function accepts the following arguments: - **layout**: `[in] CBLAS_LAYOUT` storage layout. - **M**: `[in] CBLAS_INT` number of rows in the matrix `A`. - **N**: `[in] CBLAS_INT` number of columns in the matrix `A`. - **alpha**: `[in] float` scalar constant. - **X**: `[in] float*` an `M` element vector. - **strideX**: `[in] CBLAS_INT` stride length for `X`. - **Y**: `[in] float*` an `N` element vector. - **strideY**: `[in] CBLAS_INT` stride length for `Y`. - **A**: `[inout] float*` input matrix. - **LDA**: `[in] CBLAS_INT` stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`). ```c void c_sger( const CBLAS_LAYOUT layout, const CBLAS_INT M, const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX, const float *Y, const CBLAS_INT strideY, float *A, const CBLAS_INT LDA ); ``` #### c_sger_ndarray( M, N, alpha, \*X, sx, ox, \*Y, sy, oy, \*A, sa1, sa2, oa ) Performs the rank 1 operation `A = alpha*x*y^T + A`, using alternative indexing semantics and where `alpha` is a scalar, `X` is an `M` element vector, `Y` is an `N` element vector, and `A` is an `M`-by-`N` matrix. ```c #include "stdlib/blas/base/shared.h" float A[ 3*4 ] = { 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f }; const float x[ 3 ] = { 1.0f, 4.0f, 0.0f }; const float y[ 4 ] = { 0.0f, 1.0f, 2.0f, 3.0f }; c_sger_ndarray( 3, 4, 1.0f, x, 1, 0, y, 1, 0, A, 4, 1, 0 ); ``` The function accepts the following arguments: - **layout**: `[in] CBLAS_LAYOUT` storage layout. - **M**: `[in] CBLAS_INT` number of rows in the matrix `A`. - **N**: `[in] CBLAS_INT` number of columns in the matrix `A`. - **alpha**: `[in] float` scalar constant. - **X**: `[in] float*` an `M` element vector. - **sx**: `[in] CBLAS_INT` stride length for `X`. - **ox**: `[in] CBLAS_INT` starting index for `X`. - **Y**: `[in] float*` an `N` element vector. - **sy**: `[in] CBLAS_INT` stride length for `Y`. - **oy**: `[in] CBLAS_INT` starting index for `Y`. - **A**: `[inout] float*` input matrix. - **sa1**: `[in] CBLAS_INT` stride of the first dimension of `A`. - **sa2**: `[in] CBLAS_INT` stride of the second dimension of `A`. - **oa**: `[in] CBLAS_INT` starting index for `A`. ```c void c_sger_ndarray( const CBLAS_INT M, const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const float *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY, float *A, const CBLAS_INT strideA1, const CBLAS_INT strideA2, const CBLAS_INT offsetA ); ```
### Examples ```c #include "stdlib/blas/base/sger.h" #include "stdlib/blas/base/shared.h" #include int main( void ) { // Define a 3x4 matrix stored in row-major order: float A[ 3*4 ] = { 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f }; // Define `x` and `y^T` vectors: const float x[ 3 ] = { 1.0f, 4.0f, 0.0f }; // M const float y[ 4 ] = { 0.0f, 1.0f, 2.0f, 3.0f }; // N // Specify the number of rows and columns: const int M = 3; const int N = 4; // Specify stride lengths: const int strideX = 1; const int strideY = 1; // Perform operation: c_sger( CblasRowMajor, M, N, 1.0f, x, strideX, y, strideY, A, N ); // Print the result: for ( int i = 0; i < M; i++ ) { for ( int j = 0; j < N; j++ ) { printf( "A[%i,%i] = %f\n", i, j, A[ (i*N)+j ] ); } } // Perform operation using alternative indexing semantics: c_sger( CblasRowMajor, M, N, 1.0f, x, strideX, 0, y, 0, strideY, A, N, 1, 0 ); // Print the result: for ( int i = 0; i < M; i++ ) { for ( int j = 0; j < N; j++ ) { printf( "A[%i,%i] = %f\n", i, j, A[ (i*N)+j ] ); } } } ```

* * * ## 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

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
  • Member event: 1
  • Push event: 2
  • Create event: 3
Last Year
  • Member event: 1
  • Push event: 2
  • Create event: 3

Committers

Last synced: 6 months ago

All Time
  • Total Commits: 2
  • Total Committers: 1
  • Avg Commits per committer: 2.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 2
  • Committers: 1
  • Avg Commits per committer: 2.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
stdlib-bot n****y@s****o 2
Committer Domains (Top 20 + Academic)
stdlib.io: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

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 19c28f1ef146469e409470805ea4279d47c3d35c 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
.github/workflows/test_published_package.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
package.json npm
  • @stdlib/array-float32 ^0.2.2 development
  • @stdlib/assert-is-browser ^0.2.2 development
  • @stdlib/bench-harness ^0.2.2 development
  • @stdlib/blas-base-layout-resolve-enum ^0.0.2 development
  • @stdlib/math-base-assert-is-nanf ^0.2.2 development
  • @stdlib/math-base-special-floor ^0.2.3 development
  • @stdlib/math-base-special-pow ^0.3.0 development
  • @stdlib/random-array-discrete-uniform ^0.2.1 development
  • @stdlib/random-array-uniform ^0.2.1 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.2
  • @stdlib/blas-base-assert-is-layout ^0.0.2
  • @stdlib/blas-base-shared ^0.1.0
  • @stdlib/blas-base-xerbla ^0.0.2
  • @stdlib/error-tools-fmtprodmsg ^0.2.2
  • @stdlib/math-base-special-fast-max ^0.3.0
  • @stdlib/napi-argv ^0.2.2
  • @stdlib/napi-argv-float ^0.2.2
  • @stdlib/napi-argv-int32 ^0.2.2
  • @stdlib/napi-argv-int64 ^0.2.2
  • @stdlib/napi-argv-strided-float32array ^0.2.2
  • @stdlib/napi-argv-strided-float32array2d github:stdlib-js/napi-argv-strided-float32array2d#main
  • @stdlib/napi-export ^0.2.2
  • @stdlib/ndarray-base-assert-is-column-major-string github:stdlib-js/ndarray-base-assert-is-column-major-string#main
  • @stdlib/ndarray-base-assert-is-row-major ^0.2.2
  • @stdlib/strided-base-stride2offset ^0.1.0
  • @stdlib/string-format ^0.2.2
  • @stdlib/types ^0.4.3
  • @stdlib/utils-define-nonenumerable-read-only-property ^0.2.2
  • @stdlib/utils-library-manifest ^0.2.2
  • @stdlib/utils-try-require ^0.2.2