All files / lapack/base/dlartg/lib dlartg.js

100% Statements 65/65
100% Branches 2/2
100% Functions 1/1
100% Lines 65/65

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 662x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 4x 4x 4x 2x 2x 2x 2x 2x  
/**
* @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 base = require( './base.js' );
 
 
// MAIN //
 
/**
* Constructs a Givens rotation of a two-dimensional vector that zeros out the second component.
*
* For a two-dimensional vector ( f, g ) it computes the sine `S`, cosine `C` and the resultant `R` such that the following equation is satisfied:
*
* ```tex
* \(\begin{bmatrix} C & S \\ -S & C \end{bmatrix} \begin{bmatrix} F \\ G \end{bmatrix} = \begin{bmatrix} R \\ 0 \end{bmatrix}\)
* ```
*
* @param {Float64Array} F - single element array representing the first component of the vector to be rotated
* @param {Float64Array} G - single element array representing the second component of the vector to be rotated
* @param {Float64Array} C - single element array overwritten by the cosine of the rotation
* @param {Float64Array} S - single element array overwritten by the sine of the rotation
* @param {Float64Array} R - single element array overwritten by the length of the rotated vector
* @returns {void}
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var F = new Float64Array( [ 3.0 ] );
* var G = new Float64Array( [ 4.0 ] );
* var C = new Float64Array( 1 );
* var S = new Float64Array( 1 );
* var R = new Float64Array( 1 );
*
* dlartg( F, G, C, S, R );
* // R => <Float64Array>[ 5.0 ]
* // C => <Float64Array>[ 0.6 ]
* // S => <Float64Array>[ 0.8 ]
*/
function dlartg( F, G, C, S, R ) {
	base( F, 0, G, 0, C, 0, S, 0, R, 0 );
}
 
 
// EXPORTS //
 
module.exports = dlartg;