index.js (1459B)
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 * BLAS level 1 routine to multiply `x` by a constant. 23 * 24 * @module @stdlib/blas/base/gscal 25 * 26 * @example 27 * var gscal = require( '@stdlib/blas/base/gscal' ); 28 * 29 * var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ]; 30 * 31 * gscal( x.length, 5.0, x, 1 ); 32 * // x => [ -10.0, 5.0, 15.0, -25.0, 20.0, 0.0, -5.0, -15.0 ] 33 * 34 * @example 35 * var gscal = require( '@stdlib/blas/base/gscal' ); 36 * 37 * var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ]; 38 * 39 * gscal.ndarray( x.length, 5.0, x, 1, 0 ); 40 * // x => [ -10.0, 5.0, 15.0, -25.0, 20.0, 0.0, -5.0, -15.0 ] 41 */ 42 43 // MODULES // 44 45 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); 46 var gscal = require( './main.js' ); 47 var ndarray = require( './ndarray.js' ); 48 49 50 // MAIN // 51 52 setReadOnly( gscal, 'ndarray', ndarray ); 53 54 55 // EXPORTS // 56 57 module.exports = gscal;