feat: add blas/ext/base/dvander

lib/node_modules/@stdlib/blas/ext/base/dvander/README.md

@@ -0,0 +1,351 @@
+<!--
+
+@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.
+
+-->
+
+# dvander
+
+> Generate a double-precision floating-point Vandermonde matrix.
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var dvander = require( '@stdlib/blas/ext/base/dvander' );
+```
+
+#### dvander( order, mode, M, N, x, strideX, out, ldo )
+
+Generates a double-precision floating-point Vandermonde matrix.
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+
+var x = new Float64Array( [ 1.0, 2.0, 3.0 ] );
+var out = new Float64Array( 9 );
+
+dvander( 'row-major', -1, 3, 3, x, 1, out, 3 );
+// out => <Float64Array>[ 1.0, 1.0, 1.0, 4.0, 2.0, 1.0, 9.0, 3.0, 1.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`.
+-   **N**: number of columns in `out`.
+-   **x**: input [`Float64Array`][@stdlib/array/float64].
+-   **strideX**: stride length for `x`.
+-   **out**: output matrix stored in linear memory as a [`Float64Array`][@stdlib/array/float64].
+-   **ldo**: stride between successive contiguous vectors of the matrix `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( 10 );
+
+// 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
+
+dvander( '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 -->
+
+#### dvander.ndarray( mode, M, N, x, strideX, offsetX, out, strideOut1, strideOut2, offsetOut )
+
+<!-- lint enable maximum-heading-length -->
+
+Generates a double-precision floating-point Vandermonde matrix using alternative indexing semantics.
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+
+var x = new Float64Array( [ 1.0, 2.0, 3.0 ] );
+var out = new Float64Array( 9 );
+
+dvander.ndarray( -1, 3, 3, x, 1, 0, out, 3, 1, 0 );
+// out => <Float64Array>[ 1.0, 1.0, 1.0, 4.0, 2.0, 1.0, 9.0, 3.0, 1.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 Float64Array = require( '@stdlib/array/float64' );
+
+var x = new Float64Array( [ 0.0, 1.0, 0.0, 2.0, 0.0, 3.0 ] );
+var out = new Float64Array( 9 );
+
+dvander.ndarray( 1, 3, 3, x, 2, 1, out, 3, 1, 0 );
+// out => <Float64Array>[ 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 the output matrix unchanged.
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var Float64Array = require( '@stdlib/array/float64' );
+var dvander = require( '@stdlib/blas/ext/base/dvander' );
+
+var M = 3;
+var N = 4;
+
+var x = discreteUniform( M, 0, 10, {
+    'dtype': 'float64'
+});
+var out = new Float64Array( M*N );
+
+dvander( 'row-major', -1, M, N, x, 1, out, N );
+console.log( out );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- C interface documentation. -->
+
+* * *
+
+<section class="c">
+
+## C APIs
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- C usage documentation. -->
+
+<section class="usage">
+
+### Usage
+
+```c
+#include "stdlib/blas/ext/base/dvander.h"
+```
+
+#### stdlib_strided_dvander( order, mode, M, N, \*X, strideX, \*Out, LDO )
+
+Generates a double-precision floating-point Vandermonde matrix.
+
+```c
+#include "stdlib/blas/base/shared.h"
+
+const double x[ 3 ] = { 1.0, 2.0, 3.0 };
+double Out[ 3*3 ] = { 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 };
+
+stdlib_strided_dvander( CblasRowMajor, -1.0, 3, 3, x, 1, Out, 3 );
+```
+
+The function accepts the following arguments:
+
+-   **order**: `[in] CBLAS_LAYOUT` storage layout.
+-   **mode**: `[in] double` mode. If `mode < 0`, the function generates decreasing powers. If `mode > 0`, the function generates increasing powers.
+-   **M**: `[in] CBLAS_INT` number of rows in `Out`.
+-   **N**: `[in] CBLAS_INT` number of columns in `Out`.
+-   **X**: `[in] double*` input array.
+-   **strideX**: `[in] CBLAS_INT` stride length for `X`.
+-   **Out**: `[out] double*` output matrix.
+-   **LDO**: `[in] CBLAS_INT` stride between successive contiguous vectors of the matrix `Out` (a.k.a., leading dimension of the matrix `Out`).
+
+```c
+void API_SUFFIX(stdlib_strided_dvander)( const CBLAS_LAYOUT order, const double mode, const CBLAS_INT M, const CBLAS_INT N, const double *X, const CBLAS_INT strideX, double *Out, const CBLAS_INT LDO );
+```
+
+<!-- lint disable maximum-heading-length -->
+
+#### stdlib_strided_dvander_ndarray( mode, M, N, \*X, strideX, offsetX, \*Out, strideOut1, strideOut2, offsetOut )
+
+<!-- lint enable maximum-heading-length -->
+
+Generates a double-precision floating-point Vandermonde matrix using alternative indexing semantics.
+
+```c
+#include "stdlib/blas/base/shared.h"
+
+const double x[ 3 ] = { 1.0, 2.0, 3.0 };
+double Out[ 3*3 ] = { 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 };
+
+stdlib_strided_dvander_ndarray( -1.0, 3, 3, x, 1, 0, Out, 3, 1, 0 );
+```
+
+The function accepts the following arguments:
+
+-   **mode**: `[in] double` mode. If `mode < 0`, the function generates decreasing powers. If `mode > 0`, the function generates increasing powers.
+-   **M**: `[in] CBLAS_INT` number of rows in `Out`.
+-   **N**: `[in] CBLAS_INT` number of columns in `Out`.
+-   **X**: `[in] double*` input array.
+-   **strideX**: `[in] CBLAS_INT` stride length for `X`.
+-   **offsetX**: `[in] CBLAS_INT` starting index for `X`.
+-   **Out**: `[out] double*` output matrix.
+-   **strideOut1**: `[in] CBLAS_INT` stride length for the first dimension of `Out`.
+-   **strideOut2**: `[in] CBLAS_INT` stride length for the second dimension of `Out`.
+-   **offsetOut**: `[in] CBLAS_INT` starting index for `Out`.
+
+```c
+void API_SUFFIX(stdlib_strided_dvander_ndarray)( const double mode, const CBLAS_INT M, const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, double *Out, const CBLAS_INT strideOut1, const CBLAS_INT strideOut2, const CBLAS_INT offsetOut );
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- C API usage examples. -->
+
+<section class="examples">
+
+### Examples
+
+```c
+#include "stdlib/blas/ext/base/dvander.h"
+#include "stdlib/blas/base/shared.h"
+#include <stdio.h>
+
+int main( void ) {
+    // Define the input array:
+    const double x[ 3 ] = { 1.0, 2.0, 3.0 };
+
+    // Define a 3x3 output array stored in row-major order:
+    double Out[ 3*3 ] = { 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 };
+
+    // Specify the number of rows and columns:
+    const int M = 3;
+    const int N = 3;
+
+    // Perform operation:
+    stdlib_strided_dvander( CblasRowMajor, -1.0, M, N, x, 1, Out, N );
+
+    // Print the result:
+    for ( int i = 0; i < M; i++ ) {
+        for ( int j = 0; j < N; j++ ) {
+            printf( "Out[%i,%i] = %lf\n", i, j, Out[ (i*N)+j ] );
+        }
+    }
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
+<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">
+
+[@stdlib/array/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float64
+
+[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
+
+</section>
+
+<!-- /.links -->