Skip to content

feat: add C implementation for blas/base/ssyr #2877

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

Merged
merged 25 commits into from
Feb 8, 2025
Merged
Show file tree
Hide file tree
Changes from 22 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
2f69df8
feat: add C implementation for ssyr
aman-095 Sep 7, 2024
8bd4728
chore: resolve lint error
aman-095 Sep 7, 2024
8b59069
bench: resolve lint errors
aman-095 Sep 7, 2024
85221db
chore: remove unnecessary comment
aman-095 Sep 7, 2024
084f0c9
Merge branch 'stdlib-js:develop' into ssyr-c
aman-095 Sep 7, 2024
35a385c
Merge branch 'stdlib-js:develop' into ssyr-c
aman-095 Sep 12, 2024
c2e97cb
refactor: update C implementation for ndarray usage
aman-095 Sep 12, 2024
7482f3f
Merge branch 'stdlib-js:develop' into ssyr-c
aman-095 Dec 18, 2024
c84506a
chore: resolve lint error
aman-095 Dec 28, 2024
96ba5b5
docs: update ndarray example in readme
aman-095 Dec 28, 2024
f454212
chore: use enum identifiers
aman-095 Dec 28, 2024
30f429a
chore: resolve lint error
aman-095 Dec 28, 2024
a370459
chore: add const before variable x
aman-095 Dec 28, 2024
5b225a9
chore: add enum identifiers
aman-095 Dec 28, 2024
1f2081b
chore: resolve lint error
aman-095 Dec 28, 2024
8c31ea6
chore: resolve lint error
aman-095 Dec 28, 2024
4ed5e53
chore: add enum identifiers in readme
aman-095 Dec 28, 2024
b209434
chore: update copyright years
stdlib-bot Jan 6, 2025
b71ca34
Merge remote-tracking branch 'upstream/develop' into ssyr-c
stdlib-bot Jan 6, 2025
492dade
Merge branch 'stdlib-js:develop' into ssyr-c
aman-095 Feb 7, 2025
c775b09
chore: apply review changes
aman-095 Feb 7, 2025
890406a
bench: remove unutilized function
aman-095 Feb 7, 2025
5cc2ddc
bench: remove include
kgryte Feb 8, 2025
e4b916e
bench: use built-in
kgryte Feb 8, 2025
340c83d
docs: update description
kgryte Feb 8, 2025
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
87 changes: 79 additions & 8 deletions lib/node_modules/@stdlib/blas/base/ssyr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

@license Apache-2.0

Copyright (c) 2024 The Stdlib Authors.
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.
Expand Down Expand Up @@ -183,21 +183,65 @@ 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
#include "stdlib/blas/base/shared.h"

float A[] = { 1.0f, 0.0f, 0.0f, 2.0f, 1.0f, 0.0f, 3.0f, 2.0f, 1.0f };
const float x[] = { 1.0f, 2.0f, 3.0f };

c_ssyr( CblasColMajor, CblasUpper, 3, 1.0f, x, 1, A, 3 );
```

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
void c_ssyr( const CBLAS_LAYOUT order, const CBLAS_UPLO uplo, const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX, float *A, const CBLAS_INT LDA )
```

TODO
#### c_ssyr_ndarray( uplo, N, alpha, \*X, strideX, offsetX, \*A, sa1, sa2, oa )

Performs the symmetric rank 1 operation `A = α*x*x^T + A` using alternative indexing semantics.

```c
#include "stdlib/blas/base/shared.h"

float A[] = { 1.0f, 2.0f, 3.0f, 0.0f, 1.0f, 2.0f, 0.0f, 0.0f, 1.0f };
const float x[] = { 1.0f, 2.0f, 3.0f };

c_ssyr_ndarray( CblasUpper, 3, 1.0f, x, 1, 0, A, 3, 1, 0 );
```

The function accepts the following arguments:

- **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`.
- **offsetX**: `[in] CBLAS_INT` starting index for `X`.
- **A**: `[inout] float*` input matrix.
- **sa1**: `[in] CBLAS_INT` stride of the first dimension of `A`.
- **sa2**: `[in] CBLAS_INT` stride of the second dimension of `A`.
- **oa**: `[in] CBLAS_INT` starting index for `A`.

```c
TODO
void c_ssyr_ndarray( const CBLAS_UPLO uplo, const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, float *A, const CBLAS_INT sa1, const CBLAS_INT sa2, const CBLAS_INT oa )
```

</section>
Expand All @@ -219,7 +263,34 @@ TODO
### Examples

```c
TODO
#include "stdlib/blas/base/ssyr.h"
#include "stdlib/blas/base/shared.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 };
const float x[] = { 1.0f, 2.0f, 3.0f };

// 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_ssyr( CblasColMajor, CblasUpper, 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 ] );
}

// Perform the symmetric rank 1 operation `A = α*x*x^T + A`:
c_ssyr_ndarray( CblasUpper, N, 1.0f, x, 1, 0, A, N, 1, 0 );

// Print the result:
for ( int i = 0; i < N*N; i++ ) {
printf( "A[ %i ] = %f\n", i, A[ i ] );
}
}
```

</section>
Expand Down
109 changes: 109 additions & 0 deletions lib/node_modules/@stdlib/blas/base/ssyr/benchmark/benchmark.native.js
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 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();
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 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();
Loading