Skip to content

Commit c46348e

Browse files
committed
docs: update copy
--- 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: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent dd86a9a commit c46348e

File tree

1 file changed

+4
-3
lines changed
  • lib/node_modules/@stdlib/blas/ext/base/dlinspace

1 file changed

+4
-3
lines changed

lib/node_modules/@stdlib/blas/ext/base/dlinspace/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ The function has the following parameters:
4848
- **N**: number of indexed elements.
4949
- **start**: start of interval.
5050
- **stop**: end of interval.
51-
- **endpoint**: boolean indicating whether to include the `stop` value when writing values to the input array.
51+
- **endpoint**: boolean indicating whether to include the `stop` value when writing values to the input array. If `true`, the input array is filled with evenly spaced values over the closed interval `[start, stop]`. If `false`, the input array is filled with evenly spaced values over the half-open interval `[start, stop)`.
5252
- **x**: input [`Float64Array`][@stdlib/array/float64].
5353
- **strideX**: stride length.
5454

@@ -115,6 +115,7 @@ dlinspace.ndarray( 3, 1.0, 3.0, true, x, 1, x.length-3 );
115115

116116
## Notes
117117

118+
- Let `M` be the number of generated values (which is either `N` or `N+1` depending on whether `endpoint` is `true` or `false`, respectively). The spacing between values is thus given by `Δ = (stop-start)/(M-1)`.
118119
- If `N <= 0`, both functions return `x` unchanged.
119120

120121
</section>
@@ -187,7 +188,7 @@ The function accepts the following arguments:
187188
- **N**: `[in] CBLAS_INT` number of indexed elements.
188189
- **start**: `[in] double` start of interval.
189190
- **stop**: `[in] double` end of interval.
190-
- **endpoint**: `[in] bool` boolean indicating whether to include the `stop` value when writing values to the input array.
191+
- **endpoint**: `[in] bool` boolean indicating whether to include the `stop` value when writing values to the input array. If `true`, the input array is filled with evenly spaced values over the closed interval `[start, stop]`. If `false`, the input array is filled with evenly spaced values over the half-open interval `[start, stop)`.
191192
- **X**: `[out] double*` input array.
192193
- **strideX**: `[in] CBLAS_INT` stride length.
193194
@@ -212,7 +213,7 @@ The function accepts the following arguments:
212213
- **N**: `[in] CBLAS_INT` number of indexed elements.
213214
- **start**: `[in] double` start of interval.
214215
- **stop**: `[in] double` end of interval.
215-
- **endpoint**: `[in] bool` boolean indicating whether to include the `stop` value when writing values to the input array.
216+
- **endpoint**: `[in] bool` boolean indicating whether to include the `stop` value when writing values to the input array. If `true`, the input array is filled with evenly spaced values over the closed interval `[start, stop]`. If `false`, the input array is filled with evenly spaced values over the half-open interval `[start, stop)`.
216217
- **X**: `[out] double*` input array.
217218
- **strideX**: `[in] CBLAS_INT` stride length.
218219
- **offsetX**: `[in] CBLAS_INT` starting index.

0 commit comments

Comments
 (0)