Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
203 changes: 203 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/gleslie/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,203 @@
<!--

@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.

-->

# gleslie

> Generate a Leslie matrix.

<section class="intro">

</section>

<!-- /.intro -->

<section class="usage">

## Usage

```javascript
var gleslie = require( '@stdlib/blas/ext/base/gleslie' );
```

#### gleslie( order, N, f, strideF, s, strideS, out, ldo )

Generates a Leslie matrix.

```javascript
var f = [ 1.0, 2.0, 3.0 ];
var s = [ 0.4, 0.5 ];
var out = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];

gleslie( 'row-major', 3, f, 1, s, 1, out, 3 );
// out => [ 1.0, 2.0, 3.0, 0.4, 0.0, 0.0, 0.0, 0.5, 0.0 ]
```

The function has the following parameters:

- **order**: row-major (C-style) or column-major (Fortran-style) order.
- **N**: number of fecundity coefficients (i.e., the number of rows and columns of the output matrix).
- **f**: fecundity coefficients ([`Array`][mdn-array] or [`typed array`][mdn-typed-array]).
- **strideF**: stride length for `f`.
- **s**: survival coefficients ([`Array`][mdn-array] or [`typed array`][mdn-typed-array]). Must have at least `N-1` indexed elements.
- **strideS**: stride length for `s`.
- **out**: output matrix.
- **ldo**: stride between successive contiguous vectors of the matrix `out` (a.k.a., leading dimension of the matrix `out`). Must be greater than or equal to `max(1,N)`.

Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.

<!-- eslint-disable stdlib/capitalized-comments, max-len -->

```javascript
var Float64Array = require( '@stdlib/array/float64' );

// Initial arrays:
var f0 = new Float64Array( [ 999.0, 1.0, 2.0, 3.0 ] );
var s0 = new Float64Array( [ 999.0, 0.4, 0.5 ] );
var out0 = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );

// Create offset views:
var f1 = new Float64Array( f0.buffer, f0.BYTES_PER_ELEMENT*1 );
var s1 = new Float64Array( s0.buffer, s0.BYTES_PER_ELEMENT*1 );
var out1 = new Float64Array( out0.buffer, out0.BYTES_PER_ELEMENT*1 );

gleslie( 'row-major', 3, f1, 1, s1, 1, out1, 3 );
// out0 => <Float64Array>[ 0.0, 1.0, 2.0, 3.0, 0.4, 0.0, 0.0, 0.0, 0.5, 0.0 ]
```

<!-- lint disable maximum-heading-length -->

#### gleslie.ndarray( N, f, strideF, offsetF, s, strideS, offsetS, out, strideOut1, strideOut2, offsetOut )

<!-- lint enable maximum-heading-length -->

Generates a Leslie matrix using alternative indexing semantics.

```javascript
var f = [ 1.0, 2.0, 3.0 ];
var s = [ 0.4, 0.5 ];
var out = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];

gleslie.ndarray( 3, f, 1, 0, s, 1, 0, out, 3, 1, 0 );
// out => [ 1.0, 2.0, 3.0, 0.4, 0.0, 0.0, 0.0, 0.5, 0.0 ]
```

The function has the following additional parameters:

- **offsetF**: starting index for `f`.
- **offsetS**: starting index for `s`.
- **strideOut1**: stride length for the first dimension of `out`.
- **strideOut2**: stride length for the second dimension of `out`.
- **offsetOut**: starting index for `out`.

While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, offset parameters support indexing semantics based on starting indices. For example, to use every other element from the fecundity array starting from the second element:

```javascript
var f = [ 0.0, 1.0, 0.0, 2.0, 0.0, 3.0 ];
var s = [ 0.0, 0.4, 0.0, 0.5 ];
var out = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];

gleslie.ndarray( 3, f, 2, 1, s, 2, 1, out, 3, 1, 0 );
// out => [ 1.0, 2.0, 3.0, 0.4, 0.0, 0.0, 0.0, 0.5, 0.0 ]
```

</section>

<!-- /.usage -->

<section class="notes">

## Notes

- If `N <= 0`, both functions return `out` unchanged.
- The output matrix is zero except for the first row, which contains the fecundity coefficients `f`, and the first sub-diagonal, which contains the survival coefficients `s`.
- Both functions support array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array/base/accessor`][@stdlib/array/base/accessor]).

</section>

<!-- /.notes -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var ndarray2array = require( '@stdlib/ndarray/base/to-array' );
var uniform = require( '@stdlib/random/array/uniform' );
var shape2strides = require( '@stdlib/ndarray/base/shape2strides' );
var zeros = require( '@stdlib/array/zeros' );
var gleslie = require( '@stdlib/blas/ext/base/gleslie' );

var N = 4;
var order = 'row-major';
var shape = [ N, N ];
var strides = shape2strides( shape, order );

var opts = {
'dtype': 'generic'
};
var f = uniform( N, 0.0, 10.0, opts );
console.log( 'f:', f );

var s = uniform( N - 1, 0.0, 1.0, opts );
console.log( 's:', s );

var out = zeros( N*N, 'generic' );

gleslie( order, N, f, 1, s, 1, out, N );
console.log( ndarray2array( out, shape, strides, 0, order ) );
```

</section>

<!-- /.examples -->

<section class="references">

</section>

<!-- /.references -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

</section>

<!-- /.related -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

[mdn-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array

[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray

[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor

<!-- <related-links> -->

<!-- </related-links> -->

</section>

<!-- /.links -->
107 changes: 107 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/gleslie/benchmark/benchmark.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
/**
* @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 bench = require( '@stdlib/bench' );
var uniform = require( '@stdlib/random/array/uniform' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var pow = require( '@stdlib/math/base/special/pow' );
var zeros = require( '@stdlib/array/zeros' );
var format = require( '@stdlib/string/format' );
var pkg = require( './../package.json' ).name;
var gleslie = require( './../lib/main.js' );


// VARIABLES //

var options = {
'dtype': 'generic'
};


// FUNCTIONS //

/**
* Creates a benchmark function.
*
* @private
* @param {PositiveInteger} len - array length
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var out = zeros( len * len, options.dtype );
var f = uniform( len, 0.0, 10.0, options );
var s = uniform( len - 1, 0.0, 1.0, options );
return benchmark;

/**
* Benchmark function.
*
* @private
* @param {Benchmark} b - benchmark instance
*/
function benchmark( b ) {
var v;
var i;

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
f[ 0 ] += 0.1;
v = gleslie( 'row-major', len, f, 1, s, 1, out, len );
if ( isnan( v[ i%v.length ] ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();
if ( isnan( v[ i%v.length ] ) ) {
b.fail( 'should not return NaN' );
}
b.pass( 'benchmark finished' );
b.end();
}
}


// MAIN //

/**
* Main execution sequence.
*
* @private
*/
function main() {
var len;
var min;
var max;
var f;
var i;

min = 1; // 10^min
max = 3; // 10^max

for ( i = min; i <= max; i++ ) {
len = pow( 10, i );
f = createBenchmark( len );
bench( format( '%s:len=%d', pkg, len ), f );
}
}

main();
Loading
Loading