-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
feat: add blas/ext/base/svander
#10926
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
headlessNode
wants to merge
14
commits into
stdlib-js:develop
Choose a base branch
from
headlessNode:svander
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 8 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
627c455
feat: add blas/ext/base/svander
headlessNode 32f1f37
fix: apply suggestions from code review
headlessNode 57f6471
docs: apply suggestions from code review
headlessNode a92f4fb
docs: apply suggestions from code review
headlessNode 5389eb5
refactor: apply suggestions from code review
headlessNode 3efcfbf
refactor: apply suggestions from code review
headlessNode 4484786
docs: apply suggestion from code review
headlessNode 6979b8b
docs: apply suggestion from code review
headlessNode 862f746
docs: apply suggestion from code review
headlessNode 455e483
fix: apply suggestions from code review
headlessNode 8a281fd
refactor: apply suggestions from code review
headlessNode 014e2a8
Merge branch 'develop' into svander
headlessNode d1c59df
fix: apply suggestions from code review
headlessNode 0d69904
Merge branch 'develop' into svander
headlessNode File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
312 changes: 312 additions & 0 deletions
312
lib/node_modules/@stdlib/blas/ext/base/svander/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,312 @@ | ||
| <!-- | ||
|
|
||
| @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. | ||
|
|
||
| --> | ||
|
|
||
| # svander | ||
|
|
||
| > Generate a single-precision floating-point Vandermonde matrix. | ||
|
|
||
| <section class="intro"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.intro --> | ||
|
|
||
| <section class="usage"> | ||
|
|
||
| ## Usage | ||
|
|
||
| ```javascript | ||
| var svander = require( '@stdlib/blas/ext/base/svander' ); | ||
| ``` | ||
|
|
||
| #### svander( order, mode, M, N, x, strideX, out, ldo ) | ||
|
|
||
| Generates a single-precision floating-point Vandermonde matrix. | ||
|
|
||
| ```javascript | ||
| var Float32Array = require( '@stdlib/array/float32' ); | ||
|
|
||
| var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); | ||
| var out = new Float32Array( 9 ); | ||
|
|
||
| svander( 'row-major', -1, 3, 3, x, 1, out, 3 ); | ||
| // out => <Float32Array>[ 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` and number of indexed elements in `x`. | ||
| - **N**: number of columns in `out`. | ||
| - **x**: input [`Float32Array`][@stdlib/array/float32]. | ||
| - **strideX**: stride length for `x`. | ||
| - **out**: output matrix stored in linear memory as a [`Float32Array`][@stdlib/array/float32]. | ||
| - **ldo**: stride of the first dimension of `out` (a.k.a., leading dimension of the matrix `out`). | ||
|
|
||
| <!-- lint disable maximum-heading-length --> | ||
|
|
||
| #### svander.ndarray( mode, M, N, x, strideX, offsetX, out, strideOut1, strideOut2, offsetOut ) | ||
|
|
||
| <!-- lint enable maximum-heading-length --> | ||
|
|
||
| Generates a single-precision floating-point Vandermonde matrix using alternative indexing semantics. | ||
|
|
||
| ```javascript | ||
| var Float32Array = require( '@stdlib/array/float32' ); | ||
|
|
||
| var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); | ||
| var out = new Float32Array( 9 ); | ||
|
|
||
| svander.ndarray( -1, 3, 3, x, 1, 0, out, 3, 1, 0 ); | ||
| // out => <Float32Array>[ 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, the offset parameters support indexing semantics based on starting indices. For example, | ||
|
|
||
| ```javascript | ||
| var Float32Array = require( '@stdlib/array/float32' ); | ||
|
|
||
| var x = new Float32Array( [ 0.0, 1.0, 2.0, 3.0 ] ); | ||
| var out = new Float32Array( 9 ); | ||
|
|
||
| svander.ndarray( -1, 3, 3, x, 1, 1, out, 3, 1, 0 ); | ||
| // out => <Float32Array>[ 1.0, 1.0, 1.0, 4.0, 2.0, 1.0, 9.0, 3.0, 1.0 ] | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.usage --> | ||
|
|
||
| <section class="notes"> | ||
|
|
||
| ## Notes | ||
|
|
||
| - If `M <= 0` or `N <= 0`, both functions return `out` unchanged. | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.notes --> | ||
|
|
||
| <section class="examples"> | ||
|
|
||
| ## Examples | ||
|
|
||
| <!-- eslint no-undef: "error" --> | ||
|
|
||
| ```javascript | ||
| var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); | ||
| var Float32Array = require( '@stdlib/array/float32' ); | ||
| var svander = require( '@stdlib/blas/ext/base/svander' ); | ||
|
|
||
| var M = 3; | ||
| var N = 4; | ||
|
|
||
| var x = discreteUniform( M, 0, 10, { | ||
| 'dtype': 'float32' | ||
| }); | ||
| var out = new Float32Array( M*N ); | ||
|
|
||
| svander( 'row-major', -1, M, N, x, 1, out, N ); | ||
| console.log( out ); | ||
|
|
||
| out = new Float32Array( M*N ); | ||
| svander.ndarray( -1, M, N, x, 1, 0, out, N, 1, 0 ); | ||
| 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/svander.h" | ||
| ``` | ||
|
|
||
| #### stdlib_strided_svander( order, mode, M, N, \*X, strideX, \*Out, LDO ) | ||
|
|
||
| Generates a single-precision floating-point Vandermonde matrix. | ||
|
|
||
| ```c | ||
| #include "stdlib/blas/base/shared.h" | ||
|
|
||
| const float x[ 3 ] = { 1.0f, 2.0f, 3.0f }; | ||
| float Out[ 3*3 ] = { 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f }; | ||
|
|
||
| stdlib_strided_svander( CblasRowMajor, -1.0f, 3, 3, x, 1, Out, 3 ); | ||
| ``` | ||
|
|
||
| The function accepts the following arguments: | ||
|
|
||
| - **order**: `[in] CBLAS_LAYOUT` storage layout. | ||
| - **mode**: `[in] float` 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` and number of indexed elements in `X`. | ||
| - **N**: `[in] CBLAS_INT` number of columns in `Out`. | ||
| - **X**: `[in] float*` input array. | ||
| - **strideX**: `[in] CBLAS_INT` stride length for `X`. | ||
| - **Out**: `[out] float*` output matrix. | ||
| - **LDO**: `[in] CBLAS_INT` stride of the first dimension of `Out` (a.k.a., leading dimension of the matrix `Out`). | ||
|
|
||
| ```c | ||
| void API_SUFFIX(stdlib_strided_svander)( const CBLAS_LAYOUT order, const float mode, const CBLAS_INT M, const CBLAS_INT N, const float *X, const CBLAS_INT strideX, float *Out, const CBLAS_INT LDO ); | ||
| ``` | ||
|
|
||
| <!-- lint disable maximum-heading-length --> | ||
|
|
||
| #### stdlib_strided_svander_ndarray( mode, M, N, \*X, strideX, offsetX, \*Out, strideOut1, strideOut2, offsetOut ) | ||
|
|
||
| <!-- lint enable maximum-heading-length --> | ||
|
|
||
| Generates a single-precision floating-point Vandermonde matrix using alternative indexing semantics. | ||
|
|
||
| ```c | ||
| #include "stdlib/blas/base/shared.h" | ||
|
|
||
| const float x[ 3 ] = { 1.0f, 2.0f, 3.0f }; | ||
| float Out[ 3*3 ] = { 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f }; | ||
|
|
||
| stdlib_strided_svander_ndarray( -1.0f, 3, 3, x, 1, 0, Out, 3, 1, 0 ); | ||
| ``` | ||
|
|
||
| The function accepts the following arguments: | ||
|
|
||
| - **mode**: `[in] float` 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` and number of indexed elements in `X`. | ||
| - **N**: `[in] CBLAS_INT` number of columns in `Out`. | ||
| - **X**: `[in] float*` input array. | ||
| - **strideX**: `[in] CBLAS_INT` stride length for `X`. | ||
| - **offsetX**: `[in] CBLAS_INT` starting index for `X`. | ||
| - **Out**: `[out] float*` 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_svander_ndarray)( const float mode, const CBLAS_INT M, const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, float *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/svander.h" | ||
| #include "stdlib/blas/base/shared.h" | ||
| #include <stdio.h> | ||
|
|
||
| int main( void ) { | ||
| // Define the input array: | ||
| const float x[ 3 ] = { 1.0f, 2.0f, 3.0f }; | ||
|
|
||
| // Define a 3x3 output array stored in row-major order: | ||
| float Out[ 3*3 ] = { 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f }; | ||
|
|
||
| // Specify the number of rows and columns: | ||
| const int M = 3; | ||
| const int N = 3; | ||
|
|
||
| // Perform operation: | ||
| stdlib_strided_svander( CblasRowMajor, -1.0f, 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] = %f\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/float32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float32 | ||
|
|
||
| [mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.links --> | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.