Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
@stdlib-bot
stdlib-bot committed Aug 3, 2024
1 parent 6a23dca commit cb44ca9
Show file tree
Hide file tree
Showing 53 changed files with 4,066 additions and 30 deletions.
34 changes: 33 additions & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<section class="release" id="unreleased">

## Unreleased (2024-08-01)
## Unreleased (2024-08-03)

<section class="packages">

Expand Down Expand Up @@ -508,6 +508,28 @@

<!-- /.package -->

<section class="package" id="blas-base-dgemv-unreleased">

#### [@stdlib/blas/base/dgemv](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/dgemv)

<details>

<section class="features">

##### Features

- [`1a0368b`](https://github.com/stdlib-js/stdlib/commit/1a0368b9aa6733bb153cd09ad91fc27200180027) - add `blas/base/dgemv` [(#2654)](https://github.com/stdlib-js/stdlib/pull/2654)

</section>

<!-- /.features -->

</details>

</section>

<!-- /.package -->

<section class="package" id="blas-base-dger-unreleased">

#### [@stdlib/blas/base/dger](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/dger)
Expand Down Expand Up @@ -2871,6 +2893,16 @@ A total of 35 people contributed to this release. Thank you to the following con

<details>

- [`2b123f6`](https://github.com/stdlib-js/stdlib/commit/2b123f66af0c8d053d0d7d0dc6fae718fc182bb3) - **style:** fix missing spaces _(by Athan Reines)_
- [`4f98407`](https://github.com/stdlib-js/stdlib/commit/4f98407129de0fdc6a3731e984ea9fb51101225f) - **style:** fix missing spaces _(by Athan Reines)_
- [`0be3828`](https://github.com/stdlib-js/stdlib/commit/0be382865d07a948545f6e6e6c1da14740c2d8fb) - **test:** fix test fixture _(by Athan Reines)_
- [`8018ce3`](https://github.com/stdlib-js/stdlib/commit/8018ce3ba4efdf454633393970949dd868c532fc) - **test:** fix test fixture _(by Athan Reines)_
- [`6c3bfbd`](https://github.com/stdlib-js/stdlib/commit/6c3bfbdcbb11a33737c24d413e661e59c4746f01) - **docs:** update description _(by Athan Reines)_
- [`3f617f6`](https://github.com/stdlib-js/stdlib/commit/3f617f6258fd1ed2e68a305a42621672e988a1c3) - **docs:** fix source comment [(#2735)](https://github.com/stdlib-js/stdlib/pull/2735) _(by Aman Bhansali)_
- [`1a0368b`](https://github.com/stdlib-js/stdlib/commit/1a0368b9aa6733bb153cd09ad91fc27200180027) - **feat:** add `blas/base/dgemv` [(#2654)](https://github.com/stdlib-js/stdlib/pull/2654) _(by Aman Bhansali, Athan Reines)_
- [`283fb86`](https://github.com/stdlib-js/stdlib/commit/283fb861b91c55276e3a38b080c2983265db3b76) - **test:** update descriptions _(by Athan Reines)_
- [`bebfa1d`](https://github.com/stdlib-js/stdlib/commit/bebfa1dea0c0303b185ff2123243616f440c5b71) - **docs:** fix text wrapping _(by Athan Reines)_
- [`e22f5a9`](https://github.com/stdlib-js/stdlib/commit/e22f5a978215da36f0987aa667829fbc566f4e9c) - **style:** fix lint errors _(by Athan Reines)_
- [`868c9aa`](https://github.com/stdlib-js/stdlib/commit/868c9aa323e5c49a00ecaa944ce90d968c80f6de) - **docs:** update ToC _(by Athan Reines)_
- [`f1128aa`](https://github.com/stdlib-js/stdlib/commit/f1128aa2432497a7297ad1cc733de562f44169d5) - **feat:** add `zaxpy`, `zdrot`, and `zscal` to namespace _(by Athan Reines)_
- [`10640df`](https://github.com/stdlib-js/stdlib/commit/10640dfff29bff48cc339c31c0fe98ab5a5d2ff3) - **feat:** add `sspmv`, `ssymv`, `ssyr`, `ssyr2`, and `strmv` to namespace _(by Athan Reines)_
Expand Down
2 changes: 1 addition & 1 deletion base/caxpy/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Scales values from `cx` by `ca` and adds the result to `cy`.

```javascript
var Complex64Array = require( '@stdlib/array/complex64' );
var Complex64 = require('@stdlib/complex/float32/ctor');
var Complex64 = require( '@stdlib/complex/float32/ctor' );
var realf = require( '@stdlib/complex/float32/real' );
var imagf = require( '@stdlib/complex/float32/imag' );

Expand Down
268 changes: 268 additions & 0 deletions base/dgemv/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,268 @@
<!--
@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.
-->

# dgemv

> Perform one of the matrix-vector operations `y = α*A*x + β*y` or `y = α*A**T*x + β*y`.
<section class = "usage">

## Usage

```javascript
var dgemv = require( '@stdlib/blas/base/dgemv' );
```

#### dgemv( ord, trans, M, N, α, A, LDA, x, sx, β, y, sy )

Performs one of the matrix-vector operations `y = α*A*x + β*y` or `y = α*A**T*x + β*y`, where `α` and `β` are scalars, `x` and `y` are vectors, and `A` is an `M` by `N` matrix.

```javascript
var Float64Array = require( '@stdlib/array/float64' );

var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
var x = new Float64Array( [ 1.0, 1.0, 1.0 ] );
var y = new Float64Array( [ 1.0, 1.0 ] );

dgemv( 'row-major', 'no-transpose', 2, 3, 1.0, A, 3, x, 1, 1.0, y, 1 );
// y => <Float64Array>[ 7.0, 16.0 ]
```

The function has the following parameters:

- **ord**: storage layout.
- **trans**: specifies whether `A` should be transposed, conjugate-transposed, or not transposed.
- **M**: number of rows in the matrix `A`.
- **N**: number of columns in the matrix `A`.
- **α**: scalar constant.
- **A**: input matrix stored in linear memory as a [`Float64Array`][mdn-float64array].
- **lda**: stride of the first dimension of `A` (leading dimension of `A`).
- **x**: input [`Float64Array`][mdn-float64array].
- **sx**: index increment for `x`.
- **β**: scalar constant.
- **y**: output [`Float64Array`][mdn-float64array].
- **sy**: index increment for `y`.

The stride parameters determine how operations are performed. For example, to iterate over every other element in `x` and `y`,

```javascript
var Float64Array = require( '@stdlib/array/float64' );

var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
var x = new Float64Array( [ 1.0, 0.0, 1.0, 0.0 ] );
var y = new Float64Array( [ 1.0, 0.0, 1.0, 0.0 ] );

dgemv( 'row-major', 'no-transpose', 2, 2, 1.0, A, 2, x, 2, 1.0, y, 2 );
// y => <Float64Array>[ 4.0, 0.0, 8.0, 0.0 ]
```

Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.

<!-- eslint-disable stdlib/capitalized-comments -->

```javascript
var Float64Array = require( '@stdlib/array/float64' );

// Initial arrays...
var x0 = new Float64Array( [ 0.0, 1.0, 1.0 ] );
var y0 = new Float64Array( [ 0.0, 1.0, 1.0 ] );
var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );

// Create offset views...
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
var y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*1 ); // start at 2nd element

dgemv( 'row-major', 'no-transpose', 2, 2, 1.0, A, 2, x1, -1, 1.0, y1, -1 );
// y0 => <Float64Array>[ 0.0, 8.0, 4.0 ]
```

#### dgemv.ndarray( trans, M, N, α, A, sa1, sa2, oa, x, sx, ox, β, y, sy, oy )

Performs one of the matrix-vector operations `y = α*A*x + β*y` or `y = α*A**T*x + β*y`, using alternative indexing semantics and where `α` and `β` are scalars, `x` and `y` are vectors, and `A` is an `M` by `N` matrix.

```javascript
var Float64Array = require( '@stdlib/array/float64' );

var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
var x = new Float64Array( [ 1.0, 1.0, 1.0 ] );
var y = new Float64Array( [ 1.0, 1.0 ] );

dgemv.ndarray( 'no-transpose', 2, 3, 1.0, A, 3, 1, 0, x, 1, 0, 1.0, y, 1, 0 );
// y => <Float64Array>[ 7.0, 16.0 ]
```

The function has the following additional parameters:

- **sa1**: stride of the first dimension of `A`.
- **sa2**: stride of the second dimension of `A`.
- **oa**: starting index for `A`.
- **ox**: starting index for `x`.
- **oy**: starting index for `y`.

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 Float64Array = require( '@stdlib/array/float64' );

var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
var x = new Float64Array( [ 0.0, 1.0, 2.0, 3.0 ] );
var y = new Float64Array( [ 7.0, 8.0, 9.0, 10.0 ] );

dgemv.ndarray( 'no-transpose', 2, 3, 1.0, A, 3, 1, 0, x, 1, 1, 1.0, y, -2, 2 );
// y => <Float64Array>[ 39, 8, 23, 10 ]
```

</section>

<!-- /.usage -->

<section class="notes">

## Notes

- `dgemv()` corresponds to the [BLAS][blas] level 2 function [`dgemv`][blas-dgemv].

</section>

<!-- /.notes -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var dgemv = require( '@stdlib/blas/base/dgemv' );

var opts = {
'dtype': 'float64'
};

var M = 3;
var N = 3;

var A = discreteUniform( M*N, 0, 255, opts );
var x = discreteUniform( N, 0, 255, opts );
var y = discreteUniform( M, 0, 255, opts );

dgemv( 'row-major', 'no-transpose', M, N, 1.0, A, N, x, -1, 1.0, y, -1 );
console.log( y );

```

</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/base/dgemv.h"
```

#### TODO

TODO.

```c
TODO
```

TODO

```c
TODO
```

</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
TODO
```

</section>

<!-- /.examples -->

</section>

<!-- /.c -->

<!-- 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">

[blas]: http://www.netlib.org/blas

[blas-dgemv]: https://www.netlib.org/lapack/explore-html/d7/dda/group__gemv_ga4ac1b675072d18f902db8a310784d802.html#ga4ac1b675072d18f902db8a310784d802

[mdn-float64array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float64Array

[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray

</section>

<!-- /.links -->
Loading

0 comments on commit cb44ca9

Please sign in to comment.