All files / drotg/lib assign.js

54.25% Statements 51/94
100% Branches 1/1
0% Functions 0/1
54.25% Lines 51/94

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 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 951x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x                                                                                       1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2023 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 abs = require( '@stdlib/math/base/special/abs' );
var sqrt = require( '@stdlib/math/base/special/sqrt' );
var abs2 = require( '@stdlib/math/base/special/abs2' );
var copysign = require( '@stdlib/math/base/special/copysign' );
 
 
// MAIN //
 
/**
* Constructs a Givens plane rotation.
*
* @param {number} a - rotational elimination parameter
* @param {number} b - rotational elimination parameter
* @param {Float64Array} out - output array
* @param {integer} stride - index increment
* @param {NonNegativeInteger} offset - starting index
* @returns {Float64Array} output array
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var out = drotg( 0.0, 2.0, new Float64Array( 4 ), 1, 0 );
* // returns <Float64Array>[ 2.0, 1.0, 0.0, 1.0 ]
*/
function drotg( a, b, out, stride, offset ) {
	var scale;
	var sign;
	var aa;
	var ab;
	var r;
	var c;
	var s;
	var z;

	aa = abs( a );
	ab = abs( b );
	if ( aa > ab ) {
		sign = copysign( 1.0, a );
	} else {
		sign = copysign( 1.0, b );
	}
	scale = aa + ab;
	if ( scale === 0.0 ) {
		c = 1.0;
		s = 0.0;
		r = 0.0;
		z = 0.0;
	} else {
		r = scale * sqrt( abs2( a/scale ) + abs2( b/scale ) );
		r *= sign;
		c = a / r;
		s = b / r;
		z = 1.0;
		if ( aa > ab ) {
			z = s;
		} else if ( c !== 0.0 ) {
			z = 1.0 / c;
		}
	}
	a = r;
	b = z;
	out[ offset ] = a;
	out[ offset + stride ] = b;
	out[ offset + ( 2 * stride ) ] = c;
	out[ offset + ( 3 * stride ) ] = s;
	return out;
}
 
 
// EXPORTS //
 
module.exports = drotg;