You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: lib/node_modules/@stdlib/blas/ext/base/drrss/README.md
+33-41Lines changed: 33 additions & 41 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,19 +20,22 @@ limitations under the License.
20
20
21
21
# drrss
22
22
23
-
> Calculate the square root of the [residual sum of squares][residualsum of squares] of two double-precision floating-point vectors.
23
+
> Calculate the square root of the [residual sum of squares][wikipedia-residual-sum-of-squares] of two double-precision floating-point strided arrays.
24
24
25
25
<sectionclass="intro">
26
26
27
-
The square root of the [residual sum of squares][residualsum of squares] is defined as
27
+
The square root of the [residual sum of squares][wikipedia-residual-sum-of-squares] is defined as
28
28
29
29
<!-- <equation class="equation" label="eq:sqrt_of_residual_sum_of_squares" align="center" raw="d = \sqrt{\sum_{i=0}^{N-1} (y_i - x_i)^2}" alt="Equation for the square root of residual sum of squares."> -->
@@ -66,11 +69,11 @@ The function has the following parameters:
66
69
67
70
-**N**: number of indexed elements.
68
71
-**x**: first input [`Float64Array`][@stdlib/array/float64].
69
-
-**strideX**: index increment for `x`.
72
+
-**strideX**: stride length for `x`.
70
73
-**y**: second input [`Float64Array`][@stdlib/array/float64].
71
-
-**strideY**: index increment for `y`.
74
+
-**strideY**: stride length for `y`.
72
75
73
-
The `N`, `strideX`and `strideY` parameters determine which elements in `x` and `y`are accessed at runtime. For example, to compute the [residual sum of squares][residualsum of squares] of every other element in `x` and `y`
76
+
The `N`and stride parameters determine which elements in strided arrays are accessed at runtime. For example, to compute the [residual sum of squares][wikipedia-residual-sum-of-squares] of every other element in `x` and `y`
@@ -104,7 +106,7 @@ If `N` is less than or equal to `0`, the function returns `0`.
104
106
105
107
#### drrss.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )
106
108
107
-
Computes the square root of the [residual sum of squares][residualsum of squares] of two double-precision floating-point vectors using alternative indexing semantics.
109
+
Computes the square root of the [residual sum of squares][wikipedia-residual-sum-of-squares] of two double-precision floating-point strided arrays using alternative indexing semantics.
@@ -121,7 +123,7 @@ The function has the following additional parameters:
121
123
-**offsetX**: starting index for `x`.
122
124
-**offsetY**: starting index for `y`.
123
125
124
-
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 calculate the [residual sum of squares][residualsum of squares] for every other value in `x` and `y` starting from the second value
126
+
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, to calculate the square root of the [residual sum of squares][wikipedia-residual-sum-of-squares] for every other element in `x` and `y` starting from the second element
#### stdlib_blas_ext_base_drrss_ndarray( N, \*X, strideX, offsetX, \*Y, strideY, offsetY )
231
+
#### stdlib_strided_drrss_ndarray( N, \*X, strideX, offsetX, \*Y, strideY, offsetY )
230
232
231
233
<!--lint enable maximum-heading-length-->
232
234
233
-
Computes the square root of the residual sum of squares of two double-precision floating-point vectors using alternative indexing semantics.
235
+
Computes the square root of the [residual sum of squares][wikipedia-residual-sum-of-squares] of two double-precision floating-point strided arrays using alternative indexing semantics.
0 commit comments