index.js (1229B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2020 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 /** 22 * Compute the L2-norm of a vector. 23 * 24 * @module @stdlib/blas/base/gnrm2 25 * 26 * @example 27 * var gnrm2 = require( '@stdlib/blas/base/gnrm2' ); 28 * 29 * var x = [ 1.0, -2.0, 2.0 ]; 30 * 31 * var z = gnrm2( x.length, x, 1 ); 32 * // returns 3.0 33 * 34 * @example 35 * var floor = require( '@stdlib/math/base/special/floor' ); 36 * var gnrm2 = require( '@stdlib/blas/base/gnrm2' ); 37 * 38 * var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ]; 39 * var N = floor( x.length / 2 ); 40 * 41 * var z = gnrm2.ndarray( N, x, 2, 1 ); 42 * // returns 5.0 43 */ 44 45 // MODULES // 46 47 var gnrm2 = require( './main.js' ); 48 49 50 // EXPORTS // 51 52 module.exports = gnrm2;