Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
cb2fccf
feat: add blas/ext/base/gvander
headlessNode Mar 14, 2026
a862437
docs: apply suggestions from code review
headlessNode Mar 14, 2026
69c1162
refactor: apply suggestions from code review
headlessNode Mar 15, 2026
21d9643
refactor: apply suggestions from code review
headlessNode Mar 20, 2026
305052c
fix: apply suggestions from code review
headlessNode Mar 20, 2026
1ecf9e0
fix: apply suggestions from code review
headlessNode Mar 20, 2026
7780772
fix: apply suggestions from code review
headlessNode Mar 20, 2026
4ff7d56
refactor: apply suggestions from code review
headlessNode Mar 22, 2026
416bb2d
refactor: reduce assignment duplication
kgryte Apr 7, 2026
28c22a2
Apply suggestions from code review
kgryte Apr 7, 2026
d7ad94a
Apply suggestions from code review
kgryte Apr 7, 2026
229126b
Apply suggestions from code review
kgryte Apr 7, 2026
3341c3b
Apply suggestions from code review
kgryte Apr 7, 2026
9d15ffa
Merge branch 'develop' into gvander
headlessNode Apr 7, 2026
1cf43b0
fix: apply suggestions from code review
headlessNode Apr 7, 2026
d107953
fix: apply suggestion from code review
headlessNode Apr 7, 2026
7be8297
style: remove assignment duplication
kgryte Apr 10, 2026
47a6d6f
style: move comments
kgryte Apr 10, 2026
17a1310
refactor: reduce assignment duplication
kgryte Apr 10, 2026
1e64d34
refactor: remove unnecessary variable
kgryte Apr 10, 2026
9526ff2
refactor: reduce assignment duplication
kgryte Apr 10, 2026
1738a44
refactor: remove useless variable
kgryte Apr 10, 2026
31b862d
refactor: remove useless variable
kgryte Apr 10, 2026
e52e171
fix: remove assertion
kgryte Apr 10, 2026
90d98ba
fix: remove assertion
kgryte Apr 10, 2026
4bd7c0e
Apply suggestions from code review
kgryte Apr 10, 2026
1792251
Apply suggestions from code review
kgryte Apr 10, 2026
6ebd5ab
docs: add explainer and add example
kgryte Apr 10, 2026
83b4aef
docs: fix example
kgryte Apr 10, 2026
e8c67db
style: remove whitespace
kgryte Apr 10, 2026
ddd838c
style: add empty line
kgryte Apr 10, 2026
f048d60
docs: fix example
kgryte Apr 10, 2026
a2c557a
Apply suggestions from code review
kgryte Apr 10, 2026
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
216 changes: 216 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/gvander/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,216 @@
<!--

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

-->

# gvander

> Generate a Vandermonde matrix.

<section class="intro">

</section>

<!-- /.intro -->

<section class="usage">

## Usage

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

#### gvander( order, mode, M, N, x, strideX, out, ldo )

Generates a Vandermonde matrix.

```javascript
var x = [ 1.0, 2.0, 3.0 ];
var out = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];

gvander( 'row-major', 1, 3, 3, x, 1, out, 3 );
// out => [ 1.0, 1.0, 1.0, 1.0, 2.0, 4.0, 1.0, 3.0, 9.0 ]
```

The function has the following parameters:

- **order**: row-major (C-style) or column-major (Fortran-style) order.
- **mode**: mode. If `mode < 0`, the function generates decreasing powers. If `mode > 0`, the function generates increasing powers.
- **M**: number of rows in `out` and number of indexed elements in `x`.
- **N**: number of columns in `out`.
- **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
- **strideX**: stride length for `x`.
- **out**: output matrix.
- **ldo**: stride of the first dimension of `out` (a.k.a., leading dimension of the matrix `out`).

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 x0 = new Float64Array( [ 999.0, 1.0, 2.0, 3.0 ] );
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 x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
var out1 = new Float64Array( out0.buffer, out0.BYTES_PER_ELEMENT*1 ); // start at 2nd element

gvander( 'row-major', 1, 3, 3, x1, 1, out1, 3 );
// out0 => <Float64Array>[ 0.0, 1.0, 1.0, 1.0, 1.0, 2.0, 4.0, 1.0, 3.0, 9.0 ]
```

When the mode is positive, the matrix is generated such that

```text
[
1 x_0^1 x_0^2 ... x_0^(N-1)
1 x_1^1 x_1^2 ... x_1^(N-1)
...
]
```

with increasing powers along the rows.

When the mode is negative, the matrix is generated such that

```text
[
x_0^(N-1) ... x_0^2 x_0^1 1
x_1^(N-1) ... x_1^2 x_1^1 1
...
]
```

with decreasing powers along the rows.

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

#### gvander.ndarray( mode, M, N, x, strideX, offsetX, out, strideOut1, strideOut2, offsetOut )

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

Generates a Vandermonde matrix using alternative indexing semantics.

```javascript
var x = [ 1.0, 2.0, 3.0 ];
var out = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];

gvander.ndarray( 1, 3, 3, x, 1, 0, out, 3, 1, 0 );
// out => [ 1.0, 1.0, 1.0, 1.0, 2.0, 4.0, 1.0, 3.0, 9.0 ]
```

The function has the following additional parameters:

- **offsetX**: starting index for `x`.
- **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 input array starting from the second element:

```javascript
var x = [ 0.0, 1.0, 0.0, 2.0, 0.0, 3.0 ];
var out = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];

gvander.ndarray( 1, 3, 3, x, 2, 1, out, 3, 1, 0 );
// out => [ 1.0, 1.0, 1.0, 1.0, 2.0, 4.0, 1.0, 3.0, 9.0 ]
```

</section>

<!-- /.usage -->

<section class="notes">

## Notes

- If `M <= 0` or `N <= 0`, both functions return `out` unchanged.
- 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]).
- Depending on the environment, the typed versions ([`dvander`][@stdlib/blas/ext/base/dvander], [`svander`][@stdlib/blas/ext/base/svander], etc.) are likely to be significantly more performant.

</section>

<!-- /.notes -->

<section class="examples">

## Examples

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

```javascript
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var zeros = require( '@stdlib/array/zeros' );
var gvander = require( '@stdlib/blas/ext/base/gvander' );

var M = 3;
var N = 4;

var x = discreteUniform( M, 0, 10, {
'dtype': 'generic'
});
var out = zeros( M*N, 'generic' );
console.log( x );

gvander( 'row-major', -1, M, N, x, 1, out, N );
console.log( out );
```

</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

[@stdlib/blas/ext/base/dvander]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dvander

[@stdlib/blas/ext/base/svander]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/svander

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

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

</section>

<!-- /.links -->
106 changes: 106 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/gvander/benchmark/benchmark.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
/**
* @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 gvander = 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 x = uniform( len, -10, 10, 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++ ) {
x[ 0 ] += 0.1;
v = gvander( 'row-major', 1, len, len, x, 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