All files accessors.js

100% Statements 144/144
100% Branches 9/9
100% Functions 1/1
100% Lines 144/144

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 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 1453x 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 3x 3x 3x 3x 3x 3x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 13x 13x 22x 9x 9x 9x 22x 22x 22x 68x 68x 216x 216x 216x 68x 68x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 46x 46x 46x 46x 46x 46x 46x 22x 22x 22x 22x 22x 22x 22x 20x 20x 20x 22x 22x 22x 4x 4x 4x 22x 22x 3x 3x 3x 3x 3x  
/**
* @license Apache-2.0
*
* Copyright (c) 2026 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 isRowMajor = require( '@stdlib/ndarray/base/assert/is-row-major' );
 
 
// MAIN //
 
/**
* Generates a Fiedler companion matrix using accessor arrays.
*
* @private
* @param {NonNegativeInteger} N - number of indexed elements in `x`
* @param {Object} x - input array object
* @param {Collection} x.data - input array data
* @param {Array<Function>} x.accessors - array element accessors
* @param {integer} strideX - stride length for `x`
* @param {NonNegativeInteger} offsetX - starting index for `x`
* @param {Object} out - output array object
* @param {Collection} out.data - output array data
* @param {Array<Function>} out.accessors - array element accessors
* @param {integer} strideOut1 - stride length for the first dimension of `out`
* @param {integer} strideOut2 - stride length for the second dimension of `out`
* @param {NonNegativeInteger} offsetOut - starting index for `out`
* @returns {Object} output array object
*
* @example
* var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
* var arraylike2object = require( '@stdlib/array/base/arraylike2object' );
*
* var x = [ 1.0, 2.0, 3.0, 4.0 ];
* var out = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
*
* gfiedlerCompanion( 4, arraylike2object( toAccessorArray( x ) ), 1, 0, arraylike2object( toAccessorArray( out ) ), 3, 1, 0 );
* // out => [ -2.0, -3.0, 1.0, 1.0, 0.0, 0.0, 0.0, -4.0, 0.0 ]
*/
function gfiedlerCompanion( N, x, strideX, offsetX, out, strideOut1, strideOut2, offsetOut ) { // eslint-disable-line max-len
	var xbuf;
	var obuf;
	var getX;
	var oset;
	var so1;
	var so2;
	var ds;
	var ix;
	var io;
	var ij;
	var M;
	var d;
	var v;
	var i;
	var j;
 
	// Cache references to array data:
	xbuf = x.data;
	obuf = out.data;
 
	// Cache references to element accessors:
	getX = x.accessors[ 0 ];
	oset = out.accessors[ 1 ];
 
	M = N - 1;
 
	// As a zero matrix is symmetric, when filling the output matrix with zeros, we can swap the strides so that the innermost loop always moves over contiguous memory, thus ensuring cache optimal traversal...
	if ( isRowMajor( [ strideOut1, strideOut2 ] ) ) {
		so1 = strideOut1;
		so2 = strideOut2;
	} else { // column-major
		so1 = strideOut2;
		so2 = strideOut1;
	}
	// Fill the matrix with zeros...
	io = offsetOut;
	for ( i = 0; i < M; i++ ) {
		ij = io;
		for ( j = 0; j < M; j++ ) {
			oset( obuf, ij, 0.0 );
			ij += so2;
		}
		io += so1;
	}
	// Cache the leading coefficient:
	v = getX( xbuf, offsetX );
 
	// Resolve the step size for moving along a matrix diagonal, skipping every other element:
	ds = 2 * ( strideOut1 + strideOut2 );
 
	// Set the first element to the negated and normalized second coefficient...
	ix = offsetX + strideX;
	oset( obuf, offsetOut, -getX( xbuf, ix ) / v );
 
	// Write the remaining negated and normalized coefficients, alternating between positions along the first super- and subdiagonals...
	io = offsetOut + strideOut2;
	d = 2 * strideOut1;
	for ( i = 1; i < M; i++ ) {
		ix += strideX;
		oset( obuf, io, -getX( xbuf, ix ) / v );
		io += d;
 
		// Toggle the step between the first super- and subdiagonals:
		d = ds - d;
	}
	// Write a one as the first element of the first subdiagonal...
	if ( M > 1 ) {
		oset( obuf, offsetOut+strideOut1, 1.0 );
	}
	// Write ones, alternating with zeros, along the second superdiagonal...
	io = offsetOut + ( 2*strideOut2 );
	for ( i = 2; i < M; i += 2 ) {
		oset( obuf, io, 1.0 );
		io += ds;
	}
	// Write ones, alternating with zeros, along the second subdiagonal...
	io = offsetOut + ( 3*strideOut1 ) + strideOut2;
	for ( i = 3; i < M; i += 2 ) {
		oset( obuf, io, 1.0 );
		io += ds;
	}
	return out;
}
 
 
// EXPORTS //
 
module.exports = gfiedlerCompanion;