@stdlib/blas-base-snrm2
TypeScript icon, indicating that this package has built-in type declarations

0.2.1 • Public • Published
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!

snrm2

NPM version Build Status Coverage Status

Calculate the L2-norm of a single-precision floating-point vector.

The L2-norm is defined as

L2-norm definition.

Installation

npm install @stdlib/blas-base-snrm2

Usage

var snrm2 = require( '@stdlib/blas-base-snrm2' );

snrm2( N, x, stride )

Computes the L2-norm of a single-precision floating-point vector x.

var Float32Array = require( '@stdlib/array-float32' );

var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );

var z = snrm2( x.length, x, 1 );
// returns 3.0

The function has the following parameters:

  • N: number of indexed elements.
  • x: input Float32Array.
  • stride: index increment for x.

The N and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute the L2-norm of every other element in x,

var Float32Array = require( '@stdlib/array-float32' );

var x = new Float32Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] );

var z = snrm2( 4, x, 2 );
// returns 5.0

Note that indexing is relative to the first index. To introduce an offset, use typed array views.

var Float32Array = require( '@stdlib/array-float32' );

var x0 = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element

var z = snrm2( 4, x1, 2 );
// returns 5.0

If either N or stride is less than or equal to 0, the function returns 0.

snrm2.ndarray( N, x, stride, offset )

Computes the L2-norm of a single-precision floating-point vector using alternative indexing semantics.

var Float32Array = require( '@stdlib/array-float32' );

var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );

var z = snrm2.ndarray( x.length, x, 1, 0 );
// returns 3.0

The function has the following additional parameters:

  • offset: starting index for x.

While 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 calculate the L2-norm for every other value in x starting from the second value

var Float32Array = require( '@stdlib/array-float32' );

var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );

var z = snrm2.ndarray( 4, x, 2, 1 );
// returns 5.0

Notes

  • If N <= 0, both functions return 0.0.
  • snrm2() corresponds to the BLAS level 1 function snrm2.

Examples

var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var snrm2 = require( '@stdlib/blas-base-snrm2' );

var opts = {
    'dtype': 'float32'
};
var x = discreteUniform( 10, 0, 100, opts );
console.log( x );

var out = snrm2( x.length, x, 1 );
console.log( out );

See Also


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-2024. The Stdlib Authors.

Package Sidebar

Install

npm i @stdlib/blas-base-snrm2

Homepage

stdlib.io

Weekly Downloads

15

Version

0.2.1

License

Apache-2.0

Unpacked Size

71.3 kB

Total Files

28

Last publish

Collaborators

  • stdlib-bot
  • kgryte
  • planeshifter
  • rreusser