index.js (1545B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 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` and a constant and add the result to `y`. 23 * 24 * @module @stdlib/blas/base/gaxpy 25 * 26 * @example 27 * var gaxpy = require( '@stdlib/blas/base/gaxpy' ); 28 * 29 * var x = [ 1.0, 2.0, 3.0, 4.0, 5.0 ]; 30 * var y = [ 1.0, 1.0, 1.0, 1.0, 1.0 ]; 31 * var alpha = 5.0; 32 * 33 * gaxpy( x.length, alpha, x, 1, y, 1 ); 34 * // y => [ 6.0, 11.0, 16.0, 21.0, 26.0 ] 35 * 36 * 37 * @example 38 * var gaxpy = require( '@stdlib/blas/base/gaxpy' ); 39 * 40 * var x = [ 1.0, 2.0, 3.0, 4.0, 5.0 ]; 41 * var y = [ 1.0, 1.0, 1.0, 1.0, 1.0 ]; 42 * var alpha = 5.0; 43 * 44 * gaxpy.ndarray( x.length, alpha, x, 1, 0, y, 1, 0 ); 45 * // y => [ 6.0, 11.0, 16.0, 21.0, 26.0 ] 46 */ 47 48 // MODULES // 49 50 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); 51 var gaxpy = require( './main.js' ); 52 var ndarray = require( './ndarray.js' ); 53 54 55 // MAIN // 56 57 setReadOnly( gaxpy, 'ndarray', ndarray ); 58 59 60 // EXPORTS // 61 62 module.exports = gaxpy;