Skip to content

Commit 5a3cb83

Browse files
committed
chore: update markdown
--- 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 status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 2a604f9 commit 5a3cb83

File tree

1 file changed

+13
-13
lines changed
  • lib/node_modules/@stdlib/blas/base/dzasum

1 file changed

+13
-13
lines changed

lib/node_modules/@stdlib/blas/base/dzasum/README.md

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

2121
# dzasum
2222

23-
> Compute the sum of the [absolute values][@stdlib/blas/base/dcab1] of each element in a double-precision [complex][@stdlib/complex/float64/ctor] floating-point vector.
23+
> Computes the sum of the [absolute values][@stdlib/blas/base/dcabs1] of each element.
2424
2525
<section class="intro">
2626

@@ -51,9 +51,9 @@ dzasum is defined as
5151
var dzasum = require( '@stdlib/blas/base/dzasum' );
5252
```
5353

54-
#### dzasum( N, x, stride )
54+
#### dzasum( N, x, strideX )
5555

56-
Compute the sum of the [absolute values][@stdlib/blas/base/dcab1] of each element in a double-precision [complex][@stdlib/complex/float64/ctor] floating-point vector.
56+
Compute the sum of the [absolute values][@stdlib/blas/base/dcabs1] of each element in a double-precision [complex][@stdlib/complex/float64/ctor] floating-point vector.
5757

5858
```javascript
5959
var Complex128Array = require( '@stdlib/array/complex128' );
@@ -68,9 +68,9 @@ The function has the following parameters:
6868

6969
- **N**: number of indexed elements.
7070
- **x**: input [`Complex128Array`][complex128array].
71-
- **stride**: index increment.
71+
- **strideX**: stride length for `x`.
7272

73-
The `N` and `stride` parameters determine which elements in `x` are used to compute the sum. For example, to sum every other value,
73+
The `N` and `strideX` parameters determine which elements in `x` are used to compute the sum. For example, to sum every other value,
7474

7575
```javascript
7676
var Complex128Array = require( '@stdlib/array/complex128' );
@@ -97,11 +97,9 @@ var sum = dzasum( 2, x1, 2 );
9797
// returns 22.0
9898
```
9999

100-
If `N` is less than or equal to `0`, the function returns `0`.
100+
#### dzasum.ndarray( N, x, strideX, offsetX )
101101

102-
#### dzasum.ndarray( N, x, stride, offset )
103-
104-
Compute the sum of the [absolute values][@stdlib/blas/base/dcab1] of each element in a double-precision [complex][@stdlib/complex/float64/ctor] floating-point vector using alternative indexing semantics.
102+
Compute the sum of the [absolute values][@stdlib/blas/base/dcabs1] of each element in a double-precision [complex][@stdlib/complex/float64/ctor] floating-point vector using alternative indexing semantics.
105103

106104
```javascript
107105
var Complex128Array = require( '@stdlib/array/complex128' );
@@ -114,9 +112,9 @@ var sum = dzasum.ndarray( x.length, x, 1, 0 );
114112

115113
The function has the following additional parameters:
116114

117-
- **offset**: starting index.
115+
- **offsetX**: starting index.
118116

119-
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the `offset` parameter supports indexing semantics based on a starting index. For example, to sum the last three elements,
117+
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the `offsetX` parameter supports indexing semantics based on a starting index. For example, to sum the last three elements,
120118

121119
```javascript
122120
var Complex128Array = require( '@stdlib/array/complex128' );
@@ -140,7 +138,7 @@ sum = dzasum.ndarray( 3, x, -1, x.length-1 );
140138
## Notes
141139

142140
- If `N <= 0`, the sum is `0`.
143-
- `dzasum()` corresponds to the [BLAS][blas] level 1 function dzasum.
141+
- `dzasum()` corresponds to the [BLAS][blas] level 1 function [`dzasum`][blas-dzasum].
144142

145143
</section>
146144

@@ -190,7 +188,9 @@ console.log( out );
190188

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

193-
[@stdlib/blas/base/dcab1]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/dcab1
191+
[blas-dzasum]: https://www.netlib.org/lapack/explore-html-3.6.1/de/da4/group__double__blas__level1_ga60d5c8001b317c929778670a15013eb4.html
192+
193+
[@stdlib/blas/base/dcabs1]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/dcabs1
194194

195195
[complex128array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/complex128
196196

0 commit comments

Comments
 (0)