All files ndarray.js

100% Statements 67/67
100% Branches 4/4
100% Functions 1/1
100% Lines 67/67

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 683x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 23x 23x 23x 23x 23x 23x 4x 4x 19x 19x 19x 19x 23x 3x 3x 3x 3x 3x  
/**
* @license Apache-2.0
*
* Copyright (c) 2025 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';
 
// MODULES //
 
var ddot = require( '@stdlib/blas/base/ddot' ).ndarray;
var dnrm2 = require( '@stdlib/blas/base/dnrm2' ).ndarray;
 
 
// MAIN //
 
/**
* Computes the cosine similarity of two double-precision floating-point strided arrays using alternative indexing semantics.
*
* @param {NonNegativeInteger} N - number of indexed elements
* @param {Float64Array} x - first input array
* @param {integer} strideX - stride length of `x`
* @param {NonNegativeInteger} offsetX - starting index for `x`
* @param {Float64Array} y - second input array
* @param {integer} strideY - stride length of `x`
* @param {NonNegativeInteger} offsetY - starting index for `y`
* @returns {number} cosine similarity
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] );
* var y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );
*
* var z = dcosineSimilarity( x.length, x, 1, 0, y, 1, 0 );
* // returns ~-0.061
*/
function dcosineSimilarity( N, x, strideX, offsetX, y, strideY, offsetY ) {
	var ynrm;
	var xnrm;
	var dot;
 
	if ( N <= 0 ) {
		return 0.0;
	}
	dot = ddot( N, x, strideX, offsetX, y, strideY, offsetY );
	xnrm = dnrm2( N, x, strideX, offsetX );
	ynrm = dnrm2( N, y, strideY, offsetY );
	return dot / ( xnrm * ynrm );
}
 
 
// EXPORTS //
 
module.exports = dcosineSimilarity;