time-to-botec/squiggle/node_modules/@stdlib/blas/base/gdot/lib/index.js
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

61 lines
1.4 KiB
JavaScript

/**
* @license Apache-2.0
*
* Copyright (c) 2020 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
'use strict';
/**
* BLAS level 1 routine to compute the dot product of vectors `x` and `y`.
*
* @module @stdlib/blas/base/gdot
*
* @example
* var gdot = require( '@stdlib/blas/base/gdot' );
*
* var x = [ 4.0, 2.0, -3.0, 5.0, -1.0 ];
* var y = [ 2.0, 6.0, -1.0, -4.0, 8.0 ];
*
* var z = gdot( x.length, x, 1, y, 1 );
* // returns -5.0
*
*
* @example
* var gdot = require( '@stdlib/blas/base/gdot' );
*
* var x = [ 4.0, 2.0, -3.0, 5.0, -1.0 ];
* var y = [ 2.0, 6.0, -1.0, -4.0, 8.0 ];
*
* var z = gdot.ndarray( x.length, x, 1, 0, y, 1, 0 );
* // returns -5.0
*/
// MODULES //
var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
var gdot = require( './main.js' );
var ndarray = require( './ndarray.js' );
// MAIN //
setReadOnly( gdot, 'ndarray', ndarray );
// EXPORTS //
module.exports = gdot;