Skip to content

Commit 2e6b01c

Browse files
committed
docs: update descriptions in blas/ext/base/dwxmy for consistency
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown_pkg_readmes status: passed - task: lint_markdown_docs status: na - task: lint_markdown status: na - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: passed - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed ---
1 parent cd13567 commit 2e6b01c

16 files changed

Lines changed: 36 additions & 32 deletions

File tree

‎lib/node_modules/@stdlib/blas/ext/base/dwxmy/README.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# dwxmy
2222

23-
> Perform the element-wise operation `w = x * y` for double-precision floating-point strided arrays.
23+
> Multiply elements of a double-precision floating-point strided array `x` by the corresponding elements of a double-precision floating-point strided array `y` and assign the results to elements in a double-precision floating-point strided array `w`.
2424
2525
<section class="intro">
2626

@@ -50,7 +50,7 @@ var dwxmy = require( '@stdlib/blas/ext/base/dwxmy' );
5050

5151
#### dwxmy( N, x, strideX, y, strideY, w, strideW )
5252

53-
Performs the element-wise operation `w = x * y` for double-precision floating-point strided arrays.
53+
Multiplies elements of a double-precision floating-point strided array `x` by the corresponding elements of a double-precision floating-point strided array `y` and assigns the results to elements in a double-precision floating-point strided array `w`.
5454

5555
```javascript
5656
var Float64Array = require( '@stdlib/array/float64' );
@@ -111,7 +111,7 @@ dwxmy( 3, x1, 1, y1, 1, w1, 1 );
111111

112112
<!-- lint enable maximum-heading-length -->
113113

114-
Performs the element-wise operation `w = x * y` for double-precision floating-point strided arrays using alternative indexing semantics.
114+
Multiplies elements of a double-precision floating-point strided array `x` by the corresponding elements of a double-precision floating-point strided array `y` and assigns the results to elements in a double-precision floating-point strided array `w` using alternative indexing semantics.
115115

116116
```javascript
117117
var Float64Array = require( '@stdlib/array/float64' );
@@ -218,7 +218,7 @@ console.log( w );
218218

219219
#### stdlib_strided_dwxmy( N, \*X, strideX, \*Y, strideY, \*W, strideW )
220220

221-
Performs the element-wise operation `W = X * Y` for double-precision floating-point strided arrays.
221+
Multiplies elements of a double-precision floating-point strided array `X` by the corresponding elements of a double-precision floating-point strided array `Y` and assigns the results to elements in a double-precision floating-point strided array `W`.
222222

223223
```c
224224
const double x[] = { 1.0, 2.0, 3.0, 4.0 };
@@ -248,7 +248,7 @@ void stdlib_strided_dwxmy( const CBLAS_INT N, const double *X, const CBLAS_INT s
248248

249249
<!-- lint enable maximum-heading-length -->
250250

251-
Performs the element-wise operation `W = X * Y` for double-precision floating-point strided arrays using alternative indexing semantics.
251+
Multiplies elements of a double-precision floating-point strided array `X` by the corresponding elements of a double-precision floating-point strided array `Y` and assigns the results to elements in a double-precision floating-point strided array `W` using alternative indexing semantics.
252252

253253
```c
254254
const double x[] = { 1.0, 2.0, 3.0, 4.0 };
@@ -311,7 +311,7 @@ int main( void ) {
311311
const int strideY = 1;
312312
const int strideW = 1;
313313

314-
// Perform the element-wise operation `w = x * y`:
314+
// Multiply elements of `x` by the corresponding elements of `y` and assign the results to elements in `w`:
315315
stdlib_strided_dwxmy( N, x, strideX, y, strideY, w, strideW );
316316

317317
// Print the result:

‎lib/node_modules/@stdlib/blas/ext/base/dwxmy/docs/repl.txt‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11

22
{{alias}}( N, x, strideX, y, strideY, w, strideW )
3-
Performs the element-wise operation `w = x * y` for double-precision
4-
floating-point strided arrays.
3+
Multiplies elements of a double-precision floating-point strided array `x`
4+
by the corresponding elements of a double-precision floating-point strided
5+
array `y` and assigns the results to elements in a double-precision
6+
floating-point strided array `w`.
57

68
The `N` and stride parameters determine which elements in the strided
79
arrays are accessed at runtime.
@@ -79,8 +81,10 @@
7981

8082

8183
{{alias}}.ndarray( N, x,strideX,offsetX, y,strideY,offsetY, w,strideW,offsetW )
82-
Performs the element-wise operation `w = x * y` for double-precision
83-
floating-point strided arrays using alternative indexing semantics.
84+
Multiplies elements of a double-precision floating-point strided array `x`
85+
by the corresponding elements of a double-precision floating-point strided
86+
array `y` and assigns the results to elements in a double-precision
87+
floating-point strided array `w` using alternative indexing semantics.
8488

8589
While typed array views mandate a view offset based on the underlying
8690
buffer, the offset parameters support indexing semantics based on

‎lib/node_modules/@stdlib/blas/ext/base/dwxmy/docs/types/index.d.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
*/
2424
interface Routine {
2525
/**
26-
* Performs the element-wise operation `w = x * y` for double-precision floating-point strided arrays.
26+
* Multiplies elements of a double-precision floating-point strided array `x` by the corresponding elements of a double-precision floating-point strided array `y` and assigns the results to elements in a double-precision floating-point strided array `w`.
2727
*
2828
* @param N - number of indexed elements
2929
* @param x - first input array
@@ -47,7 +47,7 @@ interface Routine {
4747
( N: number, x: Float64Array, strideX: number, y: Float64Array, strideY: number, w: Float64Array, strideW: number ): Float64Array;
4848

4949
/**
50-
* Performs the element-wise operation `w = x * y` for double-precision floating-point strided arrays using alternative indexing semantics.
50+
* Multiplies elements of a double-precision floating-point strided array `x` by the corresponding elements of a double-precision floating-point strided array `y` and assigns the results to elements in a double-precision floating-point strided array `w` using alternative indexing semantics.
5151
*
5252
* @param N - number of indexed elements
5353
* @param x - first input array
@@ -75,7 +75,7 @@ interface Routine {
7575
}
7676

7777
/**
78-
* Performs the element-wise operation `w = x * y` for double-precision floating-point strided arrays.
78+
* Multiplies elements of a double-precision floating-point strided array `x` by the corresponding elements of a double-precision floating-point strided array `y` and assigns the results to elements in a double-precision floating-point strided array `w`.
7979
*
8080
* @param N - number of indexed elements
8181
* @param x - first input array

‎lib/node_modules/@stdlib/blas/ext/base/dwxmy/examples/c/example.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ int main( void ) {
3333
const int strideY = 1;
3434
const int strideW = 1;
3535

36-
// Perform the element-wise operation `w = x * y`:
36+
// Multiply elements of `x` by the corresponding elements of `y` and assign the results to elements in `w`:
3737
stdlib_strided_dwxmy( N, x, strideX, y, strideY, w, strideW );
3838

3939
// Print the result:

‎lib/node_modules/@stdlib/blas/ext/base/dwxmy/include/stdlib/blas/ext/base/dwxmy.h‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ extern "C" {
2929
#endif
3030

3131
/**
32-
* Performs the element-wise operation `W = X * Y` for double-precision floating-point strided arrays.
32+
* Multiplies elements of a double-precision floating-point strided array `X` by the corresponding elements of a double-precision floating-point strided array `Y` and assigns the results to elements in a double-precision floating-point strided array `W`.
3333
*/
3434
void API_SUFFIX(stdlib_strided_dwxmy)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const double *Y, const CBLAS_INT strideY, double *W, const CBLAS_INT strideW );
3535

3636
/**
37-
* Performs the element-wise operation `W = X * Y` for double-precision floating-point strided arrays using alternative indexing semantics.
37+
* Multiplies elements of a double-precision floating-point strided array `X` by the corresponding elements of a double-precision floating-point strided array `Y` and assigns the results to elements in a double-precision floating-point strided array `W` using alternative indexing semantics.
3838
*/
3939
void API_SUFFIX(stdlib_strided_dwxmy_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const double *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY, double *W, const CBLAS_INT strideW, const CBLAS_INT offsetW );
4040

‎lib/node_modules/@stdlib/blas/ext/base/dwxmy/lib/dwxmy.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ var ndarray = require( './ndarray.js' );
2727
// MAIN //
2828

2929
/**
30-
* Performs the element-wise operation `w = x * y` for double-precision floating-point strided arrays.
30+
* Multiplies elements of a double-precision floating-point strided array `x` by the corresponding elements of a double-precision floating-point strided array `y` and assigns the results to elements in a double-precision floating-point strided array `w`.
3131
*
3232
* @param {PositiveInteger} N - number of indexed elements
3333
* @param {Float64Array} x - first input array

‎lib/node_modules/@stdlib/blas/ext/base/dwxmy/lib/dwxmy.native.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' );
2626
// MAIN //
2727

2828
/**
29-
* Performs the element-wise operation `w = x * y` for double-precision floating-point strided arrays.
29+
* Multiplies elements of a double-precision floating-point strided array `x` by the corresponding elements of a double-precision floating-point strided array `y` and assigns the results to elements in a double-precision floating-point strided array `w`.
3030
*
3131
* @param {PositiveInteger} N - number of indexed elements
3232
* @param {Float64Array} x - first input array

‎lib/node_modules/@stdlib/blas/ext/base/dwxmy/lib/index.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
'use strict';
2020

2121
/**
22-
* Perform the element-wise operation `w = x * y` for double-precision floating-point strided arrays.
22+
* Multiply elements of a double-precision floating-point strided array `x` by the corresponding elements of a double-precision floating-point strided array `y` and assign the results to elements in a double-precision floating-point strided array `w`.
2323
*
2424
* @module @stdlib/blas/ext/base/dwxmy
2525
*

‎lib/node_modules/@stdlib/blas/ext/base/dwxmy/lib/ndarray.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ var M = 5;
2626
// MAIN //
2727

2828
/**
29-
* Performs the element-wise operation `w = x * y` for double-precision floating-point strided arrays using alternative indexing semantics.
29+
* Multiplies elements of a double-precision floating-point strided array `x` by the corresponding elements of a double-precision floating-point strided array `y` and assigns the results to elements in a double-precision floating-point strided array `w` using alternative indexing semantics.
3030
*
3131
* @param {PositiveInteger} N - number of indexed elements
3232
* @param {Float64Array} x - first input array

‎lib/node_modules/@stdlib/blas/ext/base/dwxmy/lib/ndarray.native.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' );
2626
// MAIN //
2727

2828
/**
29-
* Performs the element-wise operation `w = x * y` for double-precision floating-point strided arrays using alternative indexing semantics.
29+
* Multiplies elements of a double-precision floating-point strided array `x` by the corresponding elements of a double-precision floating-point strided array `y` and assigns the results to elements in a double-precision floating-point strided array `w` using alternative indexing semantics.
3030
*
3131
* @param {PositiveInteger} N - number of indexed elements
3232
* @param {Float64Array} x - first input array

0 commit comments

Comments
 (0)