Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
99 changes: 91 additions & 8 deletions lib/node_modules/@stdlib/blas/base/dspmv/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) 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.
Expand Down Expand Up @@ -190,21 +190,72 @@ console.log( y );
### Usage

```c
TODO
#include "stdlib/blas/base/dspmv.h"
```

#### TODO
#### c_dspmv( order, uplo, N, alpha, \*AP, \*X, strideX, beta, \*Y, strideY )

TODO.
Performs the matrix-vector operation `y = α*A*x + β*y` where `α` and `β` are scalars, `x` and `y` are `N` element vectors, and `A` is an `N` by `N` symmetric matrix supplied in packed form `AP`.

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

const double AP[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 };
const double x[] = { 1.0, 1.0, 1.0 };
double y[] = { 1.0, 1.0, 1.0 };

c_dspmv( CblasColMajor, CblasLower, 3, 1.0, AP, x, 1, 1.0, y, 1 );
```
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` is supplied.
- **N**: `[in] CBLAS_INT` number of elements along each dimension of `A`.
- **alpha**: `[in] double` scalar constant.
- **AP**: `[in] double*` packed form of a symmetric matrix `A`.
- **X**: `[in] double*` first input vector.
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
- **beta**: `[in] double` scalar constant.
- **Y**: `[inout] double*` second input vector.
- **strideY**: `[in] CBLAS_INT` stride length for `Y`.
```c
TODO
void c_dspmv( const CBLAS_LAYOUT order, const CBLAS_UPLO uplo, const CBLAS_INT N, const double alpha, const double *AP, const double *X, const CBLAS_INT strideX, const double beta, double *Y, const CBLAS_INT strideY )
```

#### c_dspmv_ndarray( order, uplo, N, alpha, \*AP, oap, \*X, sx, ox, beta, \*Y, sy, oy )

Performs the matrix-vector operation `y = α*A*x + β*y` using alternative indexing semantics and where `α` and `β` are scalars, `x` and `y` are `N` element vectors, and `A` is an `N` by `N` symmetric matrix supplied in packed form `AP`.

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

const double AP[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 };
const double x[] = { 1.0, 1.0, 1.0 };
double y[] = { 1.0, 1.0, 1.0 };

c_dspmv_ndarray( CblasColMajor, CblasLower, 3, 1.0, AP, 0, x, 1, 0, 1.0, y, 1, 0 );
```
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` is supplied.
- **N**: `[in] CBLAS_INT` number of elements along each dimension of `A`.
- **alpha**: `[in] double` scalar.
- **AP**: `[in] double*` packed form of a symmetric matrix `A`.
- **oap**: `[in] CBLAS_INT` starting index for `AP`.
- **X**: `[in] double*` first input vector.
- **sx**: `[in] CBLAS_INT` stride length for `X`.
- **ox**: `[in] CBLAS_INT` starting index for `X`.
- **beta**: `[in] double` scalar.
- **Y**: `[inout] double*` second input vector.
- **sy**: `[in] CBLAS_INT` stride length for `Y`.
- **oy**: `[in] CBLAS_INT` starting index for `Y`.
```c
TODO
void c_dspmv_ndarray( const CBLAS_LAYOUT order, const CBLAS_UPLO uplo, const CBLAS_INT N, const double alpha, const double *AP, const CBLAS_INT offsetAP, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const double beta, double *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY )
```

</section>
Expand All @@ -226,7 +277,39 @@ TODO
### Examples

```c
TODO
#include "stdlib/blas/base/dspmv.h"
#include "stdlib/blas/base/shared.h"
#include <stdio.h>

int main( void ) {
// Define `AP`, a packed form of a symmetric matrix `A`:
const double AP[ 3*(3+1)/2 ] = {
1.0, 2.0, 3.0, 4.0, 5.0, 6.0
};

// Define `x` and `y` vectors:
const double x[ 3 ] = { 1.0, 1.0, 1.0 };
double y[ 3 ] = { 1.0, 1.0, 1.0 };

// Specify the number of elements along each dimension of `A`:
const int N = 3;

// Perform the matrix-vector operation `y = α*A*x + β*y`:
c_dspmv( CblasColMajor, CblasLower, N, 1.0, AP, x, 1, 1.0, y, 1 );

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

// Perform the matrix-vector operation `y = α*A*x + β*y` using alternative indexing semantics:
c_dspmv_ndarray( CblasColMajor, CblasLower, N, 1.0, AP, 0, x, 1, 0, 1.0, y, 1, 0 );

// Print the result:
for ( int i = 0; i < N; i++ ) {
printf( "y[ %i ] = %lf\n", i, y[ i ] );
}
}
```
</section>
Expand Down
111 changes: 111 additions & 0 deletions lib/node_modules/@stdlib/blas/base/dspmv/benchmark/benchmark.native.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
/**
* @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.
*/

'use strict';

// MODULES //

var resolve = require( 'path' ).resolve;
var bench = require( '@stdlib/bench' );
var uniform = require( '@stdlib/random/array/uniform' );
var format = require( '@stdlib/string/format' );
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 dspmv = tryRequire( resolve( __dirname, './../lib/dspmv.native.js' ) );
var opts = {
'skip': ( dspmv instanceof Error )
};
var options = {
'dtype': 'float64'
};


// FUNCTIONS //

/**
* Creates a benchmark function.
*
* @private
* @param {PositiveInteger} len - array length
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var AP = uniform( len * ( len + 1 ) / 2, -10.0, 10.0, options );
var x = uniform( len, -10.0, 10.0, options );
var y = uniform( len, -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 = dspmv( 'row-major', 'upper', len, 1.0, AP, x, 1, 1.0, y, 1 );
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( format( '%s::native:size=%d', pkg, len * ( len + 1 ) / 2 ), opts, f );
}
}

main();
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
/**
* @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.
*/

'use strict';

// MODULES //

var resolve = require( 'path' ).resolve;
var bench = require( '@stdlib/bench' );
var uniform = require( '@stdlib/random/array/uniform' );
var format = require( '@stdlib/string/format' );
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 dspmv = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) );
var opts = {
'skip': ( dspmv instanceof Error )
};
var options = {
'dtype': 'float64'
};


// FUNCTIONS //

/**
* Creates a benchmark function.
*
* @private
* @param {PositiveInteger} len - array length
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var AP = uniform( len * ( len + 1 ) / 2, -10.0, 10.0, options );
var x = uniform( len, -10.0, 10.0, options );
var y = uniform( len, -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 = dspmv( 'row-major', 'upper', len, 1.0, AP, 0, x, 1, 0, 1.0, y, 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( format( '%s:ndarray:size=%d', pkg, len * ( len + 1 ) / 2 ), opts, f );
}
}

main();
Loading