-
-
Notifications
You must be signed in to change notification settings - Fork 814
feat: add C implementation for blas/base/dspr
#6580
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
ShabiShett07
wants to merge
2
commits into
stdlib-js:develop
Choose a base branch
from
ShabiShett07:feature/dspr
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 all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
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 | ||||
---|---|---|---|---|---|---|
|
@@ -183,21 +183,63 @@ console.log( AP ); | |||||
### Usage | ||||||
|
||||||
```c | ||||||
TODO | ||||||
#include "stdlib/blas/base/dspr.h" | ||||||
``` | ||||||
|
||||||
#### TODO | ||||||
#### c_dspr( order, uplo, N, alpha, \*X, strideX, \*AP ) | ||||||
|
||||||
TODO. | ||||||
Performs the symmetric rank 1 operation `A = α*x*x^T + A` where `α` is a scalar, `x` is an `N` element vector, and `A` is an `N` by `N` symmetric matrix supplied in packed form. | ||||||
|
||||||
```c | ||||||
#include "stdlib/blas/base/shared.h" | ||||||
|
||||||
double AP[] = { 1.0, 2.0, 3.0, 1.0, 2.0, 1.0 }; | ||||||
const double x[] = { 1.0, 2.0, 3.0 }; | ||||||
|
||||||
c_dspr( CblasColMajor, CblasUpper, 3, 1.0, x, 1, AP ); | ||||||
``` | ||||||
|
||||||
The function accepts the following arguments: | ||||||
|
||||||
- **order**: `[in] CBLAS_LAYOUT` storage layout. | ||||||
- **uplo**: `[in] CBLAS_UPLO` specifies whether the upper or lower triangular part of the symmetric matrix `A` should be referenced. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
- **N**: `[in] CBLAS_INT` number of elements along each dimension of `A`. | ||||||
- **alpha**: `[in] double` scalar. | ||||||
- **X**: `[in] double*` input vector. | ||||||
- **strideX**: `[in] CBLAS_INT` stride length for `X`. | ||||||
- **AP**: `[inout] double*` packed form of a symmetric matrix `A`. | ||||||
|
||||||
```c | ||||||
TODO | ||||||
void c_dspr( const CBLAS_LAYOUT order, const CBLAS_UPLO uplo, const CBLAS_INT N, const double alpha, const double *X, const CBLAS_INT strideX, double *AP ) | ||||||
``` | ||||||
|
||||||
TODO | ||||||
#### c_dspr_ndarray( order, uplo, N, alpha, \*X, strideX, \*AP, strideAP, offsetAP ) | ||||||
|
||||||
Performs the symmetric rank 1 operation `A = α*x*x^T + A` where `α` is a scalar, `x` is an `N` element vector, and `A` is an `N` by `N` symmetric matrix supplied in packed form using alternative indexing semantics. | ||||||
|
||||||
```c | ||||||
#include "stdlib/blas/base/shared.h" | ||||||
|
||||||
double AP[] = { 1.0, 2.0, 3.0, 1.0, 2.0, 1.0 }; | ||||||
const double x[] = { 1.0, 2.0, 3.0 }; | ||||||
|
||||||
c_dspr_ndarray( CblasColMajor, CblasUpper, 3, 1.0, x, 1, AP, 1, 0 ); | ||||||
``` | ||||||
|
||||||
The function accepts the following arguments: | ||||||
|
||||||
- **order**: `[in] CBLAS_LAYOUT` storage layout. | ||||||
- **uplo**: `[in] CBLAS_UPLO` specifies whether the upper or lower triangular part of the symmetric matrix `A` should be referenced. | ||||||
- **N**: `[in] CBLAS_INT` number of elements along each dimension of `A`. | ||||||
- **alpha**: `[in] double` scalar. | ||||||
- **X**: `[in] double*` input vector. | ||||||
- **strideX**: `[in] CBLAS_INT` stride length for `X`. | ||||||
- **AP**: `[inout] double*` packed form of a symmetric matrix `A`. | ||||||
- **strideAP**: `[in] CBLAS_INT` stride length for `AP`. | ||||||
- **offsetAP**: `[in] CBLAS_INT` starting index for `AP`. | ||||||
|
||||||
```c | ||||||
TODO | ||||||
void c_dspr_ndarray( const CBLAS_LAYOUT order, const CBLAS_UPLO uplo, const CBLAS_INT N, const double alpha, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, double *AP, const CBLAS_INT strideAP, const CBLAS_INT offsetAP ) | ||||||
``` | ||||||
|
||||||
</section> | ||||||
|
@@ -219,7 +261,34 @@ TODO | |||||
### Examples | ||||||
|
||||||
```c | ||||||
TODO | ||||||
#include "stdlib/blas/base/dspr.h" | ||||||
#include "stdlib/blas/base/shared.h" | ||||||
#include <stdio.h> | ||||||
|
||||||
int main( void ) { | ||||||
// Create strided arrays: | ||||||
double AP[] = { 1.0, 2.0, 3.0, 1.0, 2.0, 1.0 }; | ||||||
const double x[] = { 1.0, 2.0, 3.0 }; | ||||||
|
||||||
// Specify the number of elements along each dimension of `A`: | ||||||
const int N = 3; | ||||||
|
||||||
// Perform the symmetric rank 1 operation `A = α*x*x^T + A`: | ||||||
c_dspr( CblasRowMajor, CblasUpper, N, 1.0, x, 1, AP ); | ||||||
|
||||||
// Print the result: | ||||||
for ( int i = 0; i < N*(N+1)/2; i++ ) { | ||||||
printf( "AP[ %i ] = %f\n", i, AP[ i ] ); | ||||||
} | ||||||
|
||||||
// Perform the symmetric rank 1 operation `A = α*x*x^T + A` using alternative indexing semantics: | ||||||
c_dspr_ndarray( CblasRowMajor, CblasUpper, N, 1.0, x, 1, 0, AP, 1, 0 ); | ||||||
|
||||||
// Print the result: | ||||||
for ( int i = 0; i < N*(N+1)/2; i++ ) { | ||||||
printf( "AP[ %i ] = %f\n", i, AP[ i ] ); | ||||||
} | ||||||
} | ||||||
``` | ||||||
|
||||||
</section> | ||||||
|
109 changes: 109 additions & 0 deletions
109
lib/node_modules/@stdlib/blas/base/dspr/benchmark/benchmark.native.js
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,109 @@ | ||
/** | ||
* @license Apache-2.0 | ||
* | ||
* Copyright (c) 2025 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 resolve = require( 'path' ).resolve; | ||
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 floor = require( '@stdlib/math/base/special/floor' ); | ||
var tryRequire = require( '@stdlib/utils/try-require' ); | ||
var pkg = require( './../package.json' ).name; | ||
|
||
|
||
// VARIABLES // | ||
|
||
var dspr = tryRequire( resolve( __dirname, './../lib/dspr.native.js' ) ); | ||
var opts = { | ||
'skip': ( dspr instanceof Error ) | ||
}; | ||
var options = { | ||
'dtype': 'float64' | ||
}; | ||
|
||
|
||
// FUNCTIONS // | ||
|
||
/** | ||
* Creates a benchmark function. | ||
* | ||
* @private | ||
* @param {PositiveInteger} N - number of elements along each dimension | ||
* @returns {Function} benchmark function | ||
*/ | ||
function createBenchmark( N ) { | ||
var AP = uniform( N * ( N + 1 ) / 2, -10.0, 10.0, options ); | ||
var x = uniform( N, -10.0, 10.0, options ); | ||
return benchmark; | ||
|
||
/** | ||
* Benchmark function. | ||
* | ||
* @private | ||
* @param {Benchmark} b - benchmark instance | ||
*/ | ||
function benchmark( b ) { | ||
var z; | ||
var i; | ||
|
||
b.tic(); | ||
for ( i = 0; i < b.iterations; i++ ) { | ||
z = dspr( 'row-major', 'upper', N, 1.0, x, 1, AP ); | ||
if ( isnan( z[ i%z.length ] ) ) { | ||
b.fail( 'should not return NaN' ); | ||
} | ||
} | ||
b.toc(); | ||
if ( isnan( z[ i%z.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 = 6; // 10^max | ||
|
||
for ( i = min; i <= max; i++ ) { | ||
len = floor( pow( pow( 10, i ), 1.0/2.0 ) ); | ||
f = createBenchmark( len ); | ||
bench( pkg+'::native:size='+( len * ( len + 1 ) / 2 ), opts, f ); | ||
} | ||
} | ||
|
||
main(); |
109 changes: 109 additions & 0 deletions
109
lib/node_modules/@stdlib/blas/base/dspr/benchmark/benchmark.ndarray.native.js
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,109 @@ | ||
/** | ||
* @license Apache-2.0 | ||
* | ||
* Copyright (c) 2025 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 resolve = require( 'path' ).resolve; | ||
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 floor = require( '@stdlib/math/base/special/floor' ); | ||
var tryRequire = require( '@stdlib/utils/try-require' ); | ||
var pkg = require( './../package.json' ).name; | ||
|
||
|
||
// VARIABLES // | ||
|
||
var dspr = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); | ||
var opts = { | ||
'skip': ( dspr instanceof Error ) | ||
}; | ||
var options = { | ||
'dtype': 'float64' | ||
}; | ||
|
||
|
||
// FUNCTIONS // | ||
|
||
/** | ||
* Creates a benchmark function. | ||
* | ||
* @private | ||
* @param {PositiveInteger} N - number of elements along each dimension | ||
* @returns {Function} benchmark function | ||
*/ | ||
function createBenchmark( N ) { | ||
var AP = uniform( N * ( N + 1 ) / 2, -10.0, 10.0, options ); | ||
var x = uniform( N, -10.0, 10.0, options ); | ||
return benchmark; | ||
|
||
/** | ||
* Benchmark function. | ||
* | ||
* @private | ||
* @param {Benchmark} b - benchmark instance | ||
*/ | ||
function benchmark( b ) { | ||
var z; | ||
var i; | ||
|
||
b.tic(); | ||
for ( i = 0; i < b.iterations; i++ ) { | ||
z = dspr( 'row-major', 'upper', N, 1.0, x, 1, 0, AP, 1, 0 ); | ||
if ( isnan( z[ i%z.length ] ) ) { | ||
b.fail( 'should not return NaN' ); | ||
} | ||
} | ||
b.toc(); | ||
if ( isnan( z[ i%z.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 = 6; // 10^max | ||
|
||
for ( i = min; i <= max; i++ ) { | ||
len = floor( pow( pow( 10, i ), 1.0/2.0 ) ); | ||
f = createBenchmark( len ); | ||
bench( pkg+'::native:ndarray:size='+( len * ( len + 1 ) / 2 ), opts, f ); | ||
} | ||
} | ||
|
||
main(); |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be row-major?