Skip to content

Commit dc49006

Browse files
MeKaustubh07MeKaustubh07
committed
chore: update documentation
--- 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: na - task: lint_markdown_docs status: na - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: passed - 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: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed ---
1 parent 874d1e6 commit dc49006

3 files changed

Lines changed: 63 additions & 63 deletions

File tree

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

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11

22
{{alias}}( N, x, strideX )
3-
Computes the sum of the absolute values of each element in a
4-
double-precision complex floating-point vector.
3+
Computes the sum of the absolute values of the real and imaginary components
4+
of a double-precision complex floating-point vector.
55

6-
The `N` and `strideX` parameters determine which elements in `x` are used
7-
to compute the sum.
6+
The `N` and stride parameters determine which elements in the strided array
7+
are accessed at runtime.
88

99
Indexing is relative to the first index. To introduce an offset, use typed
1010
array views.
1111

12-
If `N` is less than or equal to `0`, the function returns `0`.
12+
If `N <= 0`, the function returns `0.0`.
1313

1414
Parameters
1515
----------
@@ -20,40 +20,40 @@
2020
Input array.
2121

2222
strideX: integer
23-
Index increment.
23+
Index increment for `x`.
2424

2525
Returns
2626
-------
27-
sum: number
28-
Sum of absolute values.
27+
out: number
28+
Result.
2929

3030
Examples
3131
--------
32-
// Standard usage:
33-
> var x = new {{alias:@stdlib/array/complex128}}( [ -2.0, 1.0, 3.0, -5.0 ]);
34-
> var s = {{alias}}( x.length, x, 1 )
35-
11.0
36-
37-
// Advanced indexing:
38-
> var x = new {{alias:@stdlib/array/complex128}}( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0 ] );
39-
> s = {{alias}}( 2, x, 2 )
40-
7.0
32+
// Standard Usage:
33+
> var x = new {{alias:@stdlib/array/complex128}}( [ 0.3, 0.1, 0.5, 0.0, 0.0, 0.5, 0.0, 0.2 ] );
34+
> var out = {{alias}}( 4, x, 1 )
35+
~1.6
36+
37+
// Using `N` and stride parameters:
38+
> x = new {{alias:@stdlib/array/complex128}}( [ 3.0, -4.0, 0.0, 0.0, 5.0, -6.0 ] );
39+
> out = {{alias}}( 2, x, 2 )
40+
18.0
4141

42-
// Using typed array views:
42+
// Using view offsets:
4343
> var x0 = new {{alias:@stdlib/array/complex128}}( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
4444
> var x1 = new {{alias:@stdlib/array/complex128}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
45-
> s = {{alias}}( 2, x1, 1 )
45+
> out = {{alias}}( 2, x1, 1 )
4646
18.0
4747

4848

4949
{{alias}}.ndarray( N, x, strideX, offsetX )
50-
Computes the sum of the absolute values of each element in a
51-
double-precision complex floating-point vector using alternative indexing
52-
semantics.
50+
Computes the sum of the absolute values of the real and imaginary components
51+
of a double-precision complex floating-point vector using alternative
52+
indexing semantics.
5353

5454
While typed array views mandate a view offset based on the underlying
55-
buffer, the `offsetX` parameter supports indexing semantics based on a
56-
starting index.
55+
buffer, the offset parameter supports indexing semantics based on a starting
56+
index.
5757

5858
Parameters
5959
----------
@@ -64,27 +64,27 @@
6464
Input array.
6565

6666
strideX: integer
67-
Index increment.
67+
Index increment for `x`.
6868

6969
offsetX: integer
70-
Starting index.
70+
Starting index of `x`.
7171

7272
Returns
7373
-------
74-
sum: number
75-
Sum of absolute values.
74+
out: number
75+
Result.
7676

7777
Examples
7878
--------
79-
// Standard usage:
80-
> var x = new {{alias:@stdlib/array/complex128}}( [ -2.0, 1.0, 3.0, -5.0 ] );
81-
> var s = {{alias}}.ndarray( x.length, x, 1, 0 )
82-
11.0
83-
84-
// Advanced indexing:
85-
> x = new {{alias:@stdlib/array/complex128}}( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0, 7.0, -8.0 ] );
86-
> s = {{alias}}.ndarray( 3, x, -1, x.length-1 )
87-
33.0
79+
// Standard Usage:
80+
> var x = new {{alias:@stdlib/array/complex128}}( [ 3.0, -4.0, 0.0, 0.0, 5.0, -6.0 ] );
81+
> var out = {{alias}}.ndarray( 2, x, 2, 0 )
82+
18.0
83+
84+
// Using an index offset:
85+
> x = new {{alias:@stdlib/array/complex128}}( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
86+
> out = {{alias}}.ndarray( 2, x, 1, 1 )
87+
18.0
8888

8989
See Also
9090
--------

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

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
* @license Apache-2.0
33
*
4-
* Copyright (c) 2025 The Stdlib Authors.
4+
* Copyright (c) 2026 The Stdlib Authors.
55
*
66
* Licensed under the Apache License, Version 2.0 (the "License");
77
* you may not use this file except in compliance with the License.
@@ -27,66 +27,66 @@ import { Complex128Array } from '@stdlib/types/array';
2727
*/
2828
interface Routine {
2929
/**
30-
* Computes the sum of the absolute values of each element in a double-precision complex floating-point vector.
30+
* Computes the sum of the absolute values of the real and imaginary components of a double-precision complex floating-point vector.
3131
*
3232
* @param N - number of indexed elements
3333
* @param x - input array
34-
* @param stride - stride length
35-
* @returns sum of absolute values
34+
* @param strideX - `x` stride length
35+
* @returns out
3636
*
3737
* @example
3838
* var Complex128Array = require( '@stdlib/array/complex128' );
3939
*
40-
* var x = new Complex128Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );
40+
* var x = new Complex128Array( [ 0.3, 0.1, 0.5, 0.0, 0.0, 0.5, 0.0, 0.2, 2.0, 3.0 ] );
4141
*
42-
* var sum = dzasum( x.length, x, 1 );
43-
* // returns 19.0
42+
* var out = dzasum( 5, x, 1 );
43+
* // returns ~6.6
4444
*/
45-
( N: number, x: Complex128Array, stride: number ): number;
45+
( N: number, x: Complex128Array, strideX: number ): number;
4646

4747
/**
48-
* Computes the sum of the absolute values of each element in a double-precision complex floating-point vector using alternative indexing semantics.
48+
* Computes the sum of the absolute values of the real and imaginary components of a double-precision complex floating-point vector using alternative indexing semantics.
4949
*
5050
* @param N - number of indexed elements
5151
* @param x - input array
52-
* @param stride - stride length
53-
* @param offsetX - starting index
54-
* @returns sum of absolute values
52+
* @param strideX - `x` stride length
53+
* @param offsetX - starting index for `x`
54+
* @returns out
5555
*
5656
* @example
5757
* var Complex128Array = require( '@stdlib/array/complex128' );
5858
*
59-
* var x = new Complex128Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );
59+
* var x = new Complex128Array( [ 0.3, 0.1, 0.5, 0.0, 0.0, 0.5, 0.0, 0.2, 2.0, 3.0 ] );
6060
*
61-
* var z = dzasum.ndarray( x.length, x, 1, 0 );
62-
* // returns 19.0
61+
* var out = dzasum.ndarray( 5, x, 1, 0 );
62+
* // returns ~6.6
6363
*/
64-
ndarray( N: number, x: Complex128Array, stride: number, offsetX: number ): number;
64+
ndarray( N: number, x: Complex128Array, strideX: number, offsetX: number ): number;
6565
}
6666

6767
/**
68-
* Computes the sum of the absolute values of each element in a double-precision complex floating-point vector.
68+
* Computes the sum of the absolute values of the real and imaginary components of a double-precision complex floating-point vector.
6969
*
7070
* @param N - number of indexed elements
7171
* @param x - input array
72-
* @param stride - stride length
73-
* @returns sum of absolute values
72+
* @param strideX - `x` stride length
73+
* @returns out
7474
*
7575
* @example
7676
* var Complex128Array = require( '@stdlib/array/complex128' );
7777
*
78-
* var x = new Complex128Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );
78+
* var x = new Complex128Array( [ 0.3, 0.1, 5.0, 8.0, 0.5, 0.0, 6.0, 9.0, 0.0, 0.5, 8.0, 3.0, 0.0, 0.2, 9.0, 4.0 ] );
7979
*
80-
* var sum = dzasum( x.length, x, 1 );
81-
* // returns 19.0
80+
* var out = dzasum( 4, x, 2 );
81+
* // returns ~1.6
8282
*
8383
* @example
8484
* var Complex128Array = require( '@stdlib/array/complex128' );
8585
*
86-
* var x = new Complex128Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );
86+
* var x = new Complex128Array( [ 0.3, 0.1, 5.0, 8.0, 0.5, 0.0, 6.0, 9.0, 0.0, 0.5, 8.0, 3.0, 0.0, 0.2, 9.0, 4.0 ] );
8787
*
88-
* var z = dzasum.ndarray( x.length, x, 1, 0 );
89-
* // returns 19.0
88+
* var out = dzasum.ndarray( 4, x, 2, 0 );
89+
* // returns ~1.6
9090
*/
9191
declare var dzasum: Routine;
9292

‎lib/node_modules/@stdlib/blas/base/dzasum/docs/types/test.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
* @license Apache-2.0
33
*
4-
* Copyright (c) 2025 The Stdlib Authors.
4+
* Copyright (c) 2026 The Stdlib Authors.
55
*
66
* Licensed under the Apache License, Version 2.0 (the "License");
77
* you may not use this file except in compliance with the License.

0 commit comments

Comments
 (0)