From 1313db4d74c88cd6eca0f8e942c6d23bbc5e1ec9 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Fri, 31 Jul 2026 03:01:49 +0000 Subject: [PATCH 1/2] docs: update Markdown equation SVGs --- .../base/daxpby/docs/img/equation_axpby.svg | 20 +++++++++++++++++++ .../ext/base/dwapx/docs/img/equation_wapx.svg | 17 ++++++++++++++++ .../ext/base/dwax/docs/img/equation_wax.svg | 17 ++++++++++++++++ .../ext/base/dwxsa/docs/img/equation_wxsa.svg | 17 ++++++++++++++++ .../ext/base/dwxsy/docs/img/equation_wxsy.svg | 17 ++++++++++++++++ .../ext/base/dxdy/docs/img/equation_xdy.svg | 16 +++++++++++++++ .../ext/base/dxmy/docs/img/equation_xmy.svg | 16 +++++++++++++++ .../ext/base/dxpy/docs/img/equation_xpy.svg | 16 +++++++++++++++ .../ext/base/dxsy/docs/img/equation_xsy.svg | 16 +++++++++++++++ .../base/saxpby/docs/img/equation_axpby.svg | 20 +++++++++++++++++++ .../ext/base/swapx/docs/img/equation_wapx.svg | 17 ++++++++++++++++ .../ext/base/swax/docs/img/equation_wax.svg | 17 ++++++++++++++++ .../ext/base/swxmy/docs/img/equation_wxmy.svg | 17 ++++++++++++++++ .../ext/base/swxpy/docs/img/equation_wxpy.svg | 17 ++++++++++++++++ .../ext/base/swxsa/docs/img/equation_wxsa.svg | 17 ++++++++++++++++ .../ext/base/swxsy/docs/img/equation_wxsy.svg | 17 ++++++++++++++++ .../ext/base/sxdy/docs/img/equation_xdy.svg | 16 +++++++++++++++ .../ext/base/sxmy/docs/img/equation_xmy.svg | 16 +++++++++++++++ .../ext/base/sxpy/docs/img/equation_xpy.svg | 16 +++++++++++++++ .../ext/base/sxsy/docs/img/equation_xsy.svg | 16 +++++++++++++++ .../docs/img/equation_identity_function.svg | 14 ++++++------- .../docs/img/equation_identity_function.svg | 14 ++++++------- 22 files changed, 352 insertions(+), 14 deletions(-) create mode 100644 lib/node_modules/@stdlib/blas/ext/base/daxpby/docs/img/equation_axpby.svg create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dwapx/docs/img/equation_wapx.svg create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dwax/docs/img/equation_wax.svg create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dwxsa/docs/img/equation_wxsa.svg create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dwxsy/docs/img/equation_wxsy.svg create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dxdy/docs/img/equation_xdy.svg create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dxmy/docs/img/equation_xmy.svg create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dxpy/docs/img/equation_xpy.svg create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dxsy/docs/img/equation_xsy.svg create mode 100644 lib/node_modules/@stdlib/blas/ext/base/saxpby/docs/img/equation_axpby.svg create mode 100644 lib/node_modules/@stdlib/blas/ext/base/swapx/docs/img/equation_wapx.svg create mode 100644 lib/node_modules/@stdlib/blas/ext/base/swax/docs/img/equation_wax.svg create mode 100644 lib/node_modules/@stdlib/blas/ext/base/swxmy/docs/img/equation_wxmy.svg create mode 100644 lib/node_modules/@stdlib/blas/ext/base/swxpy/docs/img/equation_wxpy.svg create mode 100644 lib/node_modules/@stdlib/blas/ext/base/swxsa/docs/img/equation_wxsa.svg create mode 100644 lib/node_modules/@stdlib/blas/ext/base/swxsy/docs/img/equation_wxsy.svg create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sxdy/docs/img/equation_xdy.svg create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sxmy/docs/img/equation_xmy.svg create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sxpy/docs/img/equation_xpy.svg create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sxsy/docs/img/equation_xsy.svg diff --git a/lib/node_modules/@stdlib/blas/ext/base/daxpby/docs/img/equation_axpby.svg b/lib/node_modules/@stdlib/blas/ext/base/daxpby/docs/img/equation_axpby.svg new file mode 100644 index 000000000000..9d3ddd257fb2 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/daxpby/docs/img/equation_axpby.svg @@ -0,0 +1,20 @@ + +bold y equals alpha bold x plus beta bold y + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/blas/ext/base/dwapx/docs/img/equation_wapx.svg b/lib/node_modules/@stdlib/blas/ext/base/dwapx/docs/img/equation_wapx.svg new file mode 100644 index 000000000000..0c2c40a854f3 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dwapx/docs/img/equation_wapx.svg @@ -0,0 +1,17 @@ + +bold w equals bold x plus alpha + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/blas/ext/base/dwax/docs/img/equation_wax.svg b/lib/node_modules/@stdlib/blas/ext/base/dwax/docs/img/equation_wax.svg new file mode 100644 index 000000000000..98d9ad618b9a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dwax/docs/img/equation_wax.svg @@ -0,0 +1,17 @@ + +bold w equals alpha dot bold x + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/blas/ext/base/dwxsa/docs/img/equation_wxsa.svg b/lib/node_modules/@stdlib/blas/ext/base/dwxsa/docs/img/equation_wxsa.svg new file mode 100644 index 000000000000..7c2f9b86dc15 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dwxsa/docs/img/equation_wxsa.svg @@ -0,0 +1,17 @@ + +bold w equals bold x minus alpha + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/blas/ext/base/dwxsy/docs/img/equation_wxsy.svg b/lib/node_modules/@stdlib/blas/ext/base/dwxsy/docs/img/equation_wxsy.svg new file mode 100644 index 000000000000..e419100a588b --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dwxsy/docs/img/equation_wxsy.svg @@ -0,0 +1,17 @@ + +bold w equals bold x minus bold y + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/blas/ext/base/dxdy/docs/img/equation_xdy.svg b/lib/node_modules/@stdlib/blas/ext/base/dxdy/docs/img/equation_xdy.svg new file mode 100644 index 000000000000..1b0e60ad95cf --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dxdy/docs/img/equation_xdy.svg @@ -0,0 +1,16 @@ + +bold y equals bold x circled-division-slash bold y + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/blas/ext/base/dxmy/docs/img/equation_xmy.svg b/lib/node_modules/@stdlib/blas/ext/base/dxmy/docs/img/equation_xmy.svg new file mode 100644 index 000000000000..a0944451b229 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dxmy/docs/img/equation_xmy.svg @@ -0,0 +1,16 @@ + +bold y equals bold x circled-dot bold y + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/blas/ext/base/dxpy/docs/img/equation_xpy.svg b/lib/node_modules/@stdlib/blas/ext/base/dxpy/docs/img/equation_xpy.svg new file mode 100644 index 000000000000..a34da51849fd --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dxpy/docs/img/equation_xpy.svg @@ -0,0 +1,16 @@ + +bold y equals bold x plus bold y + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/blas/ext/base/dxsy/docs/img/equation_xsy.svg b/lib/node_modules/@stdlib/blas/ext/base/dxsy/docs/img/equation_xsy.svg new file mode 100644 index 000000000000..5cd910c218bb --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dxsy/docs/img/equation_xsy.svg @@ -0,0 +1,16 @@ + +bold y equals bold x minus bold y + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/blas/ext/base/saxpby/docs/img/equation_axpby.svg b/lib/node_modules/@stdlib/blas/ext/base/saxpby/docs/img/equation_axpby.svg new file mode 100644 index 000000000000..9d3ddd257fb2 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/saxpby/docs/img/equation_axpby.svg @@ -0,0 +1,20 @@ + +bold y equals alpha bold x plus beta bold y + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/blas/ext/base/swapx/docs/img/equation_wapx.svg b/lib/node_modules/@stdlib/blas/ext/base/swapx/docs/img/equation_wapx.svg new file mode 100644 index 000000000000..0c2c40a854f3 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/swapx/docs/img/equation_wapx.svg @@ -0,0 +1,17 @@ + +bold w equals bold x plus alpha + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/blas/ext/base/swax/docs/img/equation_wax.svg b/lib/node_modules/@stdlib/blas/ext/base/swax/docs/img/equation_wax.svg new file mode 100644 index 000000000000..98d9ad618b9a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/swax/docs/img/equation_wax.svg @@ -0,0 +1,17 @@ + +bold w equals alpha dot bold x + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/blas/ext/base/swxmy/docs/img/equation_wxmy.svg b/lib/node_modules/@stdlib/blas/ext/base/swxmy/docs/img/equation_wxmy.svg new file mode 100644 index 000000000000..7ff386008608 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/swxmy/docs/img/equation_wxmy.svg @@ -0,0 +1,17 @@ + +bold w equals bold x circled-dot bold y + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/blas/ext/base/swxpy/docs/img/equation_wxpy.svg b/lib/node_modules/@stdlib/blas/ext/base/swxpy/docs/img/equation_wxpy.svg new file mode 100644 index 000000000000..8303ce2c1877 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/swxpy/docs/img/equation_wxpy.svg @@ -0,0 +1,17 @@ + +bold w equals bold x plus bold y + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/blas/ext/base/swxsa/docs/img/equation_wxsa.svg b/lib/node_modules/@stdlib/blas/ext/base/swxsa/docs/img/equation_wxsa.svg new file mode 100644 index 000000000000..7c2f9b86dc15 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/swxsa/docs/img/equation_wxsa.svg @@ -0,0 +1,17 @@ + +bold w equals bold x minus alpha + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/blas/ext/base/swxsy/docs/img/equation_wxsy.svg b/lib/node_modules/@stdlib/blas/ext/base/swxsy/docs/img/equation_wxsy.svg new file mode 100644 index 000000000000..e419100a588b --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/swxsy/docs/img/equation_wxsy.svg @@ -0,0 +1,17 @@ + +bold w equals bold x minus bold y + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/blas/ext/base/sxdy/docs/img/equation_xdy.svg b/lib/node_modules/@stdlib/blas/ext/base/sxdy/docs/img/equation_xdy.svg new file mode 100644 index 000000000000..1b0e60ad95cf --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/sxdy/docs/img/equation_xdy.svg @@ -0,0 +1,16 @@ + +bold y equals bold x circled-division-slash bold y + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/blas/ext/base/sxmy/docs/img/equation_xmy.svg b/lib/node_modules/@stdlib/blas/ext/base/sxmy/docs/img/equation_xmy.svg new file mode 100644 index 000000000000..a0944451b229 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/sxmy/docs/img/equation_xmy.svg @@ -0,0 +1,16 @@ + +bold y equals bold x circled-dot bold y + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/blas/ext/base/sxpy/docs/img/equation_xpy.svg b/lib/node_modules/@stdlib/blas/ext/base/sxpy/docs/img/equation_xpy.svg new file mode 100644 index 000000000000..a34da51849fd --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/sxpy/docs/img/equation_xpy.svg @@ -0,0 +1,16 @@ + +bold y equals bold x plus bold y + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/blas/ext/base/sxsy/docs/img/equation_xsy.svg b/lib/node_modules/@stdlib/blas/ext/base/sxsy/docs/img/equation_xsy.svg new file mode 100644 index 000000000000..5cd910c218bb --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/sxsy/docs/img/equation_xsy.svg @@ -0,0 +1,16 @@ + +bold y equals bold x minus bold y + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/complex/float32/base/identity/docs/img/equation_identity_function.svg b/lib/node_modules/@stdlib/complex/float32/base/identity/docs/img/equation_identity_function.svg index 86516c97fe7a..9858d93c93b9 100644 --- a/lib/node_modules/@stdlib/complex/float32/base/identity/docs/img/equation_identity_function.svg +++ b/lib/node_modules/@stdlib/complex/float32/base/identity/docs/img/equation_identity_function.svg @@ -1,18 +1,18 @@ - -f left-parenthesis x right-parenthesis equals x + +f left-parenthesis z right-parenthesis equals z \ No newline at end of file diff --git a/lib/node_modules/@stdlib/complex/float64/base/identity/docs/img/equation_identity_function.svg b/lib/node_modules/@stdlib/complex/float64/base/identity/docs/img/equation_identity_function.svg index 86516c97fe7a..9858d93c93b9 100644 --- a/lib/node_modules/@stdlib/complex/float64/base/identity/docs/img/equation_identity_function.svg +++ b/lib/node_modules/@stdlib/complex/float64/base/identity/docs/img/equation_identity_function.svg @@ -1,18 +1,18 @@ - -f left-parenthesis x right-parenthesis equals x + +f left-parenthesis z right-parenthesis equals z \ No newline at end of file From befc2015d6e6d1b078b7f24ee5b497e248922fe2 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Fri, 31 Jul 2026 03:05:19 +0000 Subject: [PATCH 2/2] docs: update Markdown equation elements --- lib/node_modules/@stdlib/blas/ext/base/daxpby/README.md | 5 +++++ lib/node_modules/@stdlib/blas/ext/base/dwapx/README.md | 5 +++++ lib/node_modules/@stdlib/blas/ext/base/dwax/README.md | 5 +++++ lib/node_modules/@stdlib/blas/ext/base/dwxsa/README.md | 5 +++++ lib/node_modules/@stdlib/blas/ext/base/dwxsy/README.md | 5 +++++ lib/node_modules/@stdlib/blas/ext/base/dxdy/README.md | 5 +++++ lib/node_modules/@stdlib/blas/ext/base/dxmy/README.md | 5 +++++ lib/node_modules/@stdlib/blas/ext/base/dxpy/README.md | 5 +++++ lib/node_modules/@stdlib/blas/ext/base/dxsy/README.md | 5 +++++ lib/node_modules/@stdlib/blas/ext/base/saxpby/README.md | 5 +++++ lib/node_modules/@stdlib/blas/ext/base/swapx/README.md | 5 +++++ lib/node_modules/@stdlib/blas/ext/base/swax/README.md | 5 +++++ lib/node_modules/@stdlib/blas/ext/base/swxmy/README.md | 5 +++++ lib/node_modules/@stdlib/blas/ext/base/swxpy/README.md | 5 +++++ lib/node_modules/@stdlib/blas/ext/base/swxsa/README.md | 5 +++++ lib/node_modules/@stdlib/blas/ext/base/swxsy/README.md | 5 +++++ lib/node_modules/@stdlib/blas/ext/base/sxdy/README.md | 5 +++++ lib/node_modules/@stdlib/blas/ext/base/sxmy/README.md | 5 +++++ lib/node_modules/@stdlib/blas/ext/base/sxpy/README.md | 5 +++++ lib/node_modules/@stdlib/blas/ext/base/sxsy/README.md | 5 +++++ .../@stdlib/complex/float32/base/identity/README.md | 2 +- .../@stdlib/complex/float64/base/identity/README.md | 2 +- .../@stdlib/number/float32/base/identity/README.md | 2 +- .../@stdlib/number/int16/base/identity/README.md | 2 +- .../@stdlib/number/int32/base/identity/README.md | 2 +- lib/node_modules/@stdlib/number/int8/base/identity/README.md | 2 +- .../@stdlib/number/uint16/base/identity/README.md | 2 +- .../@stdlib/number/uint8/base/identity/README.md | 2 +- 28 files changed, 108 insertions(+), 8 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/daxpby/README.md b/lib/node_modules/@stdlib/blas/ext/base/daxpby/README.md index d07d178f9023..e1d7619d5f86 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/daxpby/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/daxpby/README.md @@ -32,6 +32,11 @@ This BLAS extension implements the operation \mathbf{y} = \alpha \mathbf{x} + \beta \mathbf{y} ``` + + This API is complementary to the package [`@stdlib/blas/base/daxpy`][@stdlib/blas/base/daxpy] and is a common BLAS extension in libraries such as Intel MKL, OpenBLAS, and others. diff --git a/lib/node_modules/@stdlib/blas/ext/base/dwapx/README.md b/lib/node_modules/@stdlib/blas/ext/base/dwapx/README.md index b08f7670296d..8d1d910eb59b 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dwapx/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/dwapx/README.md @@ -32,6 +32,11 @@ This BLAS extension implements the operation \mathbf{w} = \mathbf{x} + \alpha ``` + + This API is complementary to the package [`@stdlib/blas/ext/base/dapx`][@stdlib/blas/ext/base/dapx], which performs an in-place update. diff --git a/lib/node_modules/@stdlib/blas/ext/base/dwax/README.md b/lib/node_modules/@stdlib/blas/ext/base/dwax/README.md index 5d74a0008ff0..febd791299b9 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dwax/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/dwax/README.md @@ -32,6 +32,11 @@ This BLAS extension implements the operation \mathbf{w} = \alpha \cdot \mathbf{x} ``` + + This API is complementary to the package [`@stdlib/blas/base/dscal`][@stdlib/blas/base/dscal], which performs an in-place update. diff --git a/lib/node_modules/@stdlib/blas/ext/base/dwxsa/README.md b/lib/node_modules/@stdlib/blas/ext/base/dwxsa/README.md index e240f44429bf..b829b810ec73 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dwxsa/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/dwxsa/README.md @@ -32,6 +32,11 @@ This BLAS extension implements the operation \mathbf{w} = \mathbf{x} - \alpha ``` + + This API is complementary to the package [`@stdlib/blas/ext/base/dxsa`][@stdlib/blas/ext/base/dxsa], which performs an in-place update. diff --git a/lib/node_modules/@stdlib/blas/ext/base/dwxsy/README.md b/lib/node_modules/@stdlib/blas/ext/base/dwxsy/README.md index 70dddae5e0ad..0fa069fd47e2 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dwxsy/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/dwxsy/README.md @@ -32,6 +32,11 @@ This BLAS extension implements the operation \mathbf{w} = \mathbf{x} - \mathbf{y} ``` + + diff --git a/lib/node_modules/@stdlib/blas/ext/base/dxdy/README.md b/lib/node_modules/@stdlib/blas/ext/base/dxdy/README.md index 840ed6019eb4..899fa03b53a9 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dxdy/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/dxdy/README.md @@ -32,6 +32,11 @@ This BLAS extension implements the operation \mathbf{y} = \mathbf{x} \oslash \mathbf{y} ``` + + where `⊘` denotes the [Hadamard division][hadamard-division]. diff --git a/lib/node_modules/@stdlib/blas/ext/base/dxmy/README.md b/lib/node_modules/@stdlib/blas/ext/base/dxmy/README.md index 95152032359a..001881265a10 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dxmy/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/dxmy/README.md @@ -32,6 +32,11 @@ This BLAS extension implements the operation \mathbf{y} = \mathbf{x} \odot \mathbf{y} ``` + + where `⊙` denotes the [Hadamard product][hadamard-product]. diff --git a/lib/node_modules/@stdlib/blas/ext/base/dxpy/README.md b/lib/node_modules/@stdlib/blas/ext/base/dxpy/README.md index 8a7e926aff13..26b0cbb22222 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dxpy/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/dxpy/README.md @@ -32,6 +32,11 @@ This BLAS extension implements the operation \mathbf{y} = \mathbf{x} + \mathbf{y} ``` + + This API is a specialized version of the package [`@stdlib/blas/ext/base/daxpby`][@stdlib/blas/ext/base/daxpby] with `α = 1` and `β = 1` and performs element-wise addition between two vectors. diff --git a/lib/node_modules/@stdlib/blas/ext/base/dxsy/README.md b/lib/node_modules/@stdlib/blas/ext/base/dxsy/README.md index e855b8df79b5..44b424b92775 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dxsy/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/dxsy/README.md @@ -32,6 +32,11 @@ This BLAS extension implements the operation \mathbf{y} = \mathbf{x} - \mathbf{y} ``` + + This API is a specialized version of the package [`@stdlib/blas/ext/base/daxpby`][@stdlib/blas/ext/base/daxpby] with `α = 1` and `β = -1` and performs element-wise subtraction between two vectors. diff --git a/lib/node_modules/@stdlib/blas/ext/base/saxpby/README.md b/lib/node_modules/@stdlib/blas/ext/base/saxpby/README.md index b87704f13ff5..df15b2728f4d 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/saxpby/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/saxpby/README.md @@ -32,6 +32,11 @@ This BLAS extension implements the operation \mathbf{y} = \alpha \mathbf{x} + \beta \mathbf{y} ``` + + This API is complementary to the package [`@stdlib/blas/base/saxpy`][@stdlib/blas/base/saxpy] and is a common BLAS extension in libraries such as Intel MKL, OpenBLAS, and others. diff --git a/lib/node_modules/@stdlib/blas/ext/base/swapx/README.md b/lib/node_modules/@stdlib/blas/ext/base/swapx/README.md index c9e6c46d09e4..ce2d04d2d94e 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/swapx/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/swapx/README.md @@ -32,6 +32,11 @@ This BLAS extension implements the operation \mathbf{w} = \mathbf{x} + \alpha ``` + + This API is complementary to the package [`@stdlib/blas/ext/base/sapx`][@stdlib/blas/ext/base/sapx], which performs an in-place update. diff --git a/lib/node_modules/@stdlib/blas/ext/base/swax/README.md b/lib/node_modules/@stdlib/blas/ext/base/swax/README.md index b89f73077fef..2b9d424def45 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/swax/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/swax/README.md @@ -32,6 +32,11 @@ This BLAS extension implements the operation \mathbf{w} = \alpha \cdot \mathbf{x} ``` + + This API is complementary to the package [`@stdlib/blas/base/sscal`][@stdlib/blas/base/sscal], which performs an in-place update. diff --git a/lib/node_modules/@stdlib/blas/ext/base/swxmy/README.md b/lib/node_modules/@stdlib/blas/ext/base/swxmy/README.md index 05c8eda58bd5..61ecd8e83f21 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/swxmy/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/swxmy/README.md @@ -32,6 +32,11 @@ This BLAS extension implements the operation \mathbf{w} = \mathbf{x} \odot \mathbf{y} ``` + + where `⊙` denotes the [Hadamard product][hadamard-product]. diff --git a/lib/node_modules/@stdlib/blas/ext/base/swxpy/README.md b/lib/node_modules/@stdlib/blas/ext/base/swxpy/README.md index a8b7c878f7a5..00ce56ca9eaa 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/swxpy/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/swxpy/README.md @@ -32,6 +32,11 @@ This BLAS extension implements the operation \mathbf{w} = \mathbf{x} + \mathbf{y} ``` + + diff --git a/lib/node_modules/@stdlib/blas/ext/base/swxsa/README.md b/lib/node_modules/@stdlib/blas/ext/base/swxsa/README.md index 587903af64aa..57b20010ebcc 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/swxsa/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/swxsa/README.md @@ -32,6 +32,11 @@ This BLAS extension implements the operation \mathbf{w} = \mathbf{x} - \alpha ``` + + This API is complementary to the package [`@stdlib/blas/ext/base/sxsa`][@stdlib/blas/ext/base/sxsa], which performs an in-place update. diff --git a/lib/node_modules/@stdlib/blas/ext/base/swxsy/README.md b/lib/node_modules/@stdlib/blas/ext/base/swxsy/README.md index 0ca9546e4398..b750c88d668f 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/swxsy/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/swxsy/README.md @@ -32,6 +32,11 @@ This BLAS extension implements the operation \mathbf{w} = \mathbf{x} - \mathbf{y} ``` + + diff --git a/lib/node_modules/@stdlib/blas/ext/base/sxdy/README.md b/lib/node_modules/@stdlib/blas/ext/base/sxdy/README.md index 8ad2026d88ee..edb74335bbfb 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sxdy/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/sxdy/README.md @@ -32,6 +32,11 @@ This BLAS extension implements the operation \mathbf{y} = \mathbf{x} \oslash \mathbf{y} ``` + + where `⊘` denotes the [Hadamard division][hadamard-division]. diff --git a/lib/node_modules/@stdlib/blas/ext/base/sxmy/README.md b/lib/node_modules/@stdlib/blas/ext/base/sxmy/README.md index bb66be0b4ce9..aa448f8d91f1 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sxmy/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/sxmy/README.md @@ -32,6 +32,11 @@ This BLAS extension implements the operation \mathbf{y} = \mathbf{x} \odot \mathbf{y} ``` + + where `⊙` denotes the [Hadamard product][hadamard-product]. diff --git a/lib/node_modules/@stdlib/blas/ext/base/sxpy/README.md b/lib/node_modules/@stdlib/blas/ext/base/sxpy/README.md index b17ac92b3d73..fa6410f241cf 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sxpy/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/sxpy/README.md @@ -32,6 +32,11 @@ This BLAS extension implements the operation \mathbf{y} = \mathbf{x} + \mathbf{y} ``` + + This API is a specialized version of the package [`@stdlib/blas/ext/base/saxpby`][@stdlib/blas/ext/base/saxpby] with `α = 1` and `β = 1` and performs element-wise addition between two vectors. diff --git a/lib/node_modules/@stdlib/blas/ext/base/sxsy/README.md b/lib/node_modules/@stdlib/blas/ext/base/sxsy/README.md index fdc5170f936c..b75161b26532 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sxsy/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/sxsy/README.md @@ -32,6 +32,11 @@ This BLAS extension implements the operation \mathbf{y} = \mathbf{x} - \mathbf{y} ``` + + This API is a specialized version of the package [`@stdlib/blas/ext/base/saxpby`][@stdlib/blas/ext/base/saxpby] with `α = 1` and `β = -1` and performs element-wise subtraction between two vectors. diff --git a/lib/node_modules/@stdlib/complex/float32/base/identity/README.md b/lib/node_modules/@stdlib/complex/float32/base/identity/README.md index df675142bdc0..9ab5e3beab71 100644 --- a/lib/node_modules/@stdlib/complex/float32/base/identity/README.md +++ b/lib/node_modules/@stdlib/complex/float32/base/identity/README.md @@ -33,7 +33,7 @@ f(z) = z ``` diff --git a/lib/node_modules/@stdlib/complex/float64/base/identity/README.md b/lib/node_modules/@stdlib/complex/float64/base/identity/README.md index c771b533321d..790b37682ed7 100644 --- a/lib/node_modules/@stdlib/complex/float64/base/identity/README.md +++ b/lib/node_modules/@stdlib/complex/float64/base/identity/README.md @@ -33,7 +33,7 @@ f(z) = z ``` diff --git a/lib/node_modules/@stdlib/number/float32/base/identity/README.md b/lib/node_modules/@stdlib/number/float32/base/identity/README.md index 4f275a300b80..2112a4ebc4d2 100644 --- a/lib/node_modules/@stdlib/number/float32/base/identity/README.md +++ b/lib/node_modules/@stdlib/number/float32/base/identity/README.md @@ -33,7 +33,7 @@ f(x) = x ``` diff --git a/lib/node_modules/@stdlib/number/int16/base/identity/README.md b/lib/node_modules/@stdlib/number/int16/base/identity/README.md index 2c62796dfec3..e3be42c4cc9e 100644 --- a/lib/node_modules/@stdlib/number/int16/base/identity/README.md +++ b/lib/node_modules/@stdlib/number/int16/base/identity/README.md @@ -33,7 +33,7 @@ f(x) = x ``` diff --git a/lib/node_modules/@stdlib/number/int32/base/identity/README.md b/lib/node_modules/@stdlib/number/int32/base/identity/README.md index 03f2beaaeb11..4a30d169dd47 100644 --- a/lib/node_modules/@stdlib/number/int32/base/identity/README.md +++ b/lib/node_modules/@stdlib/number/int32/base/identity/README.md @@ -33,7 +33,7 @@ f(x) = x ``` diff --git a/lib/node_modules/@stdlib/number/int8/base/identity/README.md b/lib/node_modules/@stdlib/number/int8/base/identity/README.md index 23d3b2ff391e..b1364526a0e0 100644 --- a/lib/node_modules/@stdlib/number/int8/base/identity/README.md +++ b/lib/node_modules/@stdlib/number/int8/base/identity/README.md @@ -33,7 +33,7 @@ f(x) = x ``` diff --git a/lib/node_modules/@stdlib/number/uint16/base/identity/README.md b/lib/node_modules/@stdlib/number/uint16/base/identity/README.md index 371e77141820..17363b2b1274 100644 --- a/lib/node_modules/@stdlib/number/uint16/base/identity/README.md +++ b/lib/node_modules/@stdlib/number/uint16/base/identity/README.md @@ -33,7 +33,7 @@ f(x) = x ``` diff --git a/lib/node_modules/@stdlib/number/uint8/base/identity/README.md b/lib/node_modules/@stdlib/number/uint8/base/identity/README.md index db390fc627c7..5356be87bbb2 100644 --- a/lib/node_modules/@stdlib/number/uint8/base/identity/README.md +++ b/lib/node_modules/@stdlib/number/uint8/base/identity/README.md @@ -33,7 +33,7 @@ f(x) = x ```