-
-
Notifications
You must be signed in to change notification settings - Fork 475
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
feat: add C implementation for blas/base/ssyr
#2877
Open
aman-095
wants to merge
7
commits into
stdlib-js:develop
Choose a base branch
from
aman-095:ssyr-c
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
7 commits
Select commit
Hold shift + click to select a range
2f69df8
feat: add C implementation for ssyr
aman-095 8bd4728
chore: resolve lint error
aman-095 8b59069
bench: resolve lint errors
aman-095 85221db
chore: remove unnecessary comment
aman-095 084f0c9
Merge branch 'stdlib-js:develop' into ssyr-c
aman-095 35a385c
Merge branch 'stdlib-js:develop' into ssyr-c
aman-095 c2e97cb
refactor: update C implementation for ndarray usage
aman-095 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 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,33 @@ console.log( A ); | |||||
### Usage | ||||||
|
||||||
```c | ||||||
TODO | ||||||
#include "stdlib/blas/base/ssyr.h" | ||||||
``` | ||||||
|
||||||
#### TODO | ||||||
#### c_ssyr( order, uplo, N, alpha, \*X, strideX, \*A, LDA ) | ||||||
|
||||||
TODO. | ||||||
Performs the symmetric rank 1 operation `A = α*x*x^T + A` | ||||||
|
||||||
```c | ||||||
TODO | ||||||
float A[] = { 1.0f, 0.0f, 0.0f, 2.0f, 1.0f, 0.0f, 3.0f, 2.0f, 1.0f }; | ||||||
float x[] = { 1.0f, 2.0f, 3.0f }; | ||||||
|
||||||
c_ssyr( 102, 121, 3, 1.0f, x, 1, A, 3 ); | ||||||
``` | ||||||
|
||||||
TODO | ||||||
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] float` scalar. | ||||||
- **X**: `[in] float*` input array. | ||||||
- **strideX**: `[in] CBLAS_INT` index increment for `X`. | ||||||
- **A**: `[inout] float*` input matrix. | ||||||
- **LDA**: `[in] CBLAS_INT` stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`). | ||||||
|
||||||
```c | ||||||
TODO | ||||||
void c_ssyr( const CBLAS_LAYOUT order, const CBLAS_UPLO uplo, const CBLAS_INT N, const float alpha, float *X, const CBLAS_INT strideX, float *A, const CBLAS_INT LDA ) | ||||||
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
|
||||||
``` | ||||||
|
||||||
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. @aman-095 Looks like we still need to add the ndarray API docs, correct? |
||||||
</section> | ||||||
|
@@ -219,7 +231,25 @@ TODO | |||||
### Examples | ||||||
|
||||||
```c | ||||||
TODO | ||||||
#include "stdlib/blas/base/ssyr.h" | ||||||
#include <stdio.h> | ||||||
|
||||||
int main( void ) { | ||||||
// Create strided arrays: | ||||||
float A[] = { 1.0f, 0.0f, 0.0f, 2.0f, 1.0f, 0.0f, 3.0f, 2.0f, 1.0f }; | ||||||
float x[] = { 1.0f, 2.0f, 3.0f }; | ||||||
|
||||||
// Specify the number of elements: | ||||||
const int N = 3; | ||||||
|
||||||
// Perform the symmetric rank 1 operation `A = α*x*x^T + A`: | ||||||
c_ssyr( 102, 121, N, 1.0f, x, 1, A, N ); | ||||||
|
||||||
// Print the result: | ||||||
for ( int i = 0; i < N*N; i++ ) { | ||||||
printf( "A[ %i ] = %f\n", i, A[ i ] ); | ||||||
} | ||||||
} | ||||||
``` | ||||||
|
||||||
</section> | ||||||
|
109 changes: 109 additions & 0 deletions
109
lib/node_modules/@stdlib/blas/base/ssyr/benchmark/benchmark.native.js
This file contains 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) 2024 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 isnanf = require( '@stdlib/math/base/assert/is-nanf' ); | ||
var ones = require( '@stdlib/array/ones' ); | ||
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 ssyr = tryRequire( resolve( __dirname, './../lib/ssyr.native.js' ) ); | ||
var opts = { | ||
'skip': ( ssyr instanceof Error ) | ||
}; | ||
var options = { | ||
'dtype': 'float32' | ||
}; | ||
|
||
|
||
// FUNCTIONS // | ||
|
||
/** | ||
* Creates a benchmark function. | ||
* | ||
* @private | ||
* @param {PositiveInteger} N - number of elements along each dimension | ||
* @returns {Function} benchmark function | ||
*/ | ||
function createBenchmark( N ) { | ||
var x = ones( N, options.dtype ); | ||
var A = ones( N*N, options.dtype ); | ||
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 = ssyr( 'row-major', 'upper', N, 1.0, x, 1, A, N ); | ||
if ( isnanf( z[ i%z.length ] ) ) { | ||
b.fail( 'should not return NaN' ); | ||
} | ||
} | ||
b.toc(); | ||
if ( isnanf( z[ i%z.length ] ) ) { | ||
b.fail( 'should not return NaN' ); | ||
} | ||
b.pass( 'benchmark finished' ); | ||
b.end(); | ||
} | ||
} | ||
|
||
|
||
// MAIN // | ||
|
||
/** | ||
* Main execution sequence. | ||
* | ||
* @private | ||
*/ | ||
function main() { | ||
var min; | ||
var max; | ||
var N; | ||
var f; | ||
var i; | ||
|
||
min = 1; // 10^min | ||
max = 6; // 10^max | ||
|
||
for ( i = min; i <= max; i++ ) { | ||
N = floor( pow( pow( 10, i ), 1.0/2.0 ) ); | ||
f = createBenchmark( N ); | ||
bench( pkg+'::native:size='+(N*N), opts, f ); | ||
} | ||
} | ||
|
||
main(); |
109 changes: 109 additions & 0 deletions
109
lib/node_modules/@stdlib/blas/base/ssyr/benchmark/benchmark.ndarray.native.js
This file contains 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) 2024 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 isnanf = require( '@stdlib/math/base/assert/is-nanf' ); | ||
var ones = require( '@stdlib/array/ones' ); | ||
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 ssyr = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); | ||
var opts = { | ||
'skip': ( ssyr instanceof Error ) | ||
}; | ||
var options = { | ||
'dtype': 'float32' | ||
}; | ||
|
||
|
||
// FUNCTIONS // | ||
|
||
/** | ||
* Creates a benchmark function. | ||
* | ||
* @private | ||
* @param {PositiveInteger} N - number of elements along each dimension | ||
* @returns {Function} benchmark function | ||
*/ | ||
function createBenchmark( N ) { | ||
var x = ones( N, options.dtype ); | ||
var A = ones( N*N, options.dtype ); | ||
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 = ssyr( 'upper', N, 1.0, x, 1, 0, A, N, 1, 0 ); | ||
if ( isnanf( z[ i%z.length ] ) ) { | ||
b.fail( 'should not return NaN' ); | ||
} | ||
} | ||
b.toc(); | ||
if ( isnanf( z[ i%z.length ] ) ) { | ||
b.fail( 'should not return NaN' ); | ||
} | ||
b.pass( 'benchmark finished' ); | ||
b.end(); | ||
} | ||
} | ||
|
||
|
||
// MAIN // | ||
|
||
/** | ||
* Main execution sequence. | ||
* | ||
* @private | ||
*/ | ||
function main() { | ||
var min; | ||
var max; | ||
var N; | ||
var f; | ||
var i; | ||
|
||
min = 1; // 10^min | ||
max = 6; // 10^max | ||
|
||
for ( i = min; i <= max; i++ ) { | ||
N = floor( pow( pow( 10, i ), 1.0/2.0 ) ); | ||
f = createBenchmark( N ); | ||
bench( pkg+'::native:ndarray:size='+(N*N), opts, f ); | ||
} | ||
} | ||
|
||
main(); |
Oops, something went wrong.
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.
Do not hardcode enum values. Use enum identifiers. The values are subject to change. Enums should be treated as opaque constants.