Skip to content

Commit c2cd4c1

Browse files
committed
Auto-generated commit
1 parent 11a0317 commit c2cd4c1

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222

2323
<details>
2424

25+
- [`c46348e`](https://github.com/stdlib-js/stdlib/commit/c46348e63572c385a5a10c111a0214c9bb28eeec) - **docs:** update copy _(by Athan Reines)_
2526
- [`b187382`](https://github.com/stdlib-js/stdlib/commit/b18738234e698259d919d7ffccc25e5a8ab68c70) - **feat:** add `blas/ext/base/dlinspace` _(by Athan Reines)_
2627

2728
</details>

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ The function has the following parameters:
8181
- **N**: number of indexed elements.
8282
- **start**: start of interval.
8383
- **stop**: end of interval.
84-
- **endpoint**: boolean indicating whether to include the `stop` value when writing values to the input array.
84+
- **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)`.
8585
- **x**: input [`Float64Array`][@stdlib/array/float64].
8686
- **strideX**: stride length.
8787

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

149149
## Notes
150150

151+
- 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)`.
151152
- If `N <= 0`, both functions return `x` unchanged.
152153

153154
</section>
@@ -220,7 +221,7 @@ The function accepts the following arguments:
220221
- **N**: `[in] CBLAS_INT` number of indexed elements.
221222
- **start**: `[in] double` start of interval.
222223
- **stop**: `[in] double` end of interval.
223-
- **endpoint**: `[in] bool` boolean indicating whether to include the `stop` value when writing values to the input array.
224+
- **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)`.
224225
- **X**: `[out] double*` input array.
225226
- **strideX**: `[in] CBLAS_INT` stride length.
226227
@@ -245,7 +246,7 @@ The function accepts the following arguments:
245246
- **N**: `[in] CBLAS_INT` number of indexed elements.
246247
- **start**: `[in] double` start of interval.
247248
- **stop**: `[in] double` end of interval.
248-
- **endpoint**: `[in] bool` boolean indicating whether to include the `stop` value when writing values to the input array.
249+
- **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)`.
249250
- **X**: `[out] double*` input array.
250251
- **strideX**: `[in] CBLAS_INT` stride length.
251252
- **offsetX**: `[in] CBLAS_INT` starting index.

0 commit comments

Comments
 (0)