Skip to content

Commit 68da621

Browse files
authored
docs: update signatures
Signed-off-by: Athan <kgryte@gmail.com>
1 parent 7c084ef commit 68da621

1 file changed

Lines changed: 28 additions & 28 deletions

File tree

  • lib/node_modules/@stdlib/blas/ext/base/ddiff

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

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ console.log( 'Output: ', out );
233233

234234
<!-- lint disable maximum-heading-length -->
235235

236-
#### stdlib_strided_ddiff( N, k, \*X, strideX, N1, \*prepend, strideP, N2, \*append, strideA, \*out, strideOut, \*workspace, strideW )
236+
#### stdlib_strided_ddiff( N, k, \*X, strideX, N1, \*Prepend, strideP, N2, \*Append, strideA, \*Out, strideOut, \*Workspace, strideW )
237237

238238
Calculates the k-th discrete forward difference of a double-precision floating-point strided array.
239239

@@ -253,24 +253,24 @@ The function accepts the following arguments:
253253
- **k**: `[in] CBLAS_INT` number of times to recursively compute differences.
254254
- **X**: `[in] double*` input array.
255255
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
256-
- **N1**: `[in] CBLAS_INT` number of indexed elements for `prepend`.
257-
- **prepend**: `[in] double*` array containing values to prepend prior to computing differences.
258-
- **strideP**: `[in] CBLAS_INT` stride length for `prepend`.
259-
- **N2**: `[in] CBLAS_INT` number of indexed elements for `append`.
260-
- **append**: `[in] double*` array containing values to append prior to computing differences.
261-
- **strideA**: `[in] CBLAS_INT` stride length for `append`.
262-
- **out**: `[inout] double*` output array. Must have `N + N1 + N2 - k` elements.
263-
- **strideOut**: `[in] CBLAS_INT` stride length for `out`.
264-
- **workspace**: `[inout] double*` workspace array. Must have `N + N1 + N2 - 1` elements.
265-
- **strideW**: `[in] CBLAS_INT` stride length for `workspace`.
256+
- **N1**: `[in] CBLAS_INT` number of indexed elements for `Prepend`.
257+
- **Prepend**: `[in] double*` array containing values to prepend prior to computing differences.
258+
- **strideP**: `[in] CBLAS_INT` stride length for `Prepend`.
259+
- **N2**: `[in] CBLAS_INT` number of indexed elements for `Append`.
260+
- **Append**: `[in] double*` array containing values to append prior to computing differences.
261+
- **strideA**: `[in] CBLAS_INT` stride length for `Append`.
262+
- **Out**: `[inout] double*` output array. Must have `N + N1 + N2 - k` elements.
263+
- **strideOut**: `[in] CBLAS_INT` stride length for `Out`.
264+
- **Workspace**: `[inout] double*` workspace array. Must have `N + N1 + N2 - 1` elements.
265+
- **strideW**: `[in] CBLAS_INT` stride length for `Workspace`.
266266
267267
```c
268-
void stdlib_strided_ddiff( const CBLAS_INT N, const CBLAS_INT k, const double *X, const CBLAS_INT strideX, const CBLAS_INT N1, const double *prepend, const CBLAS_INT strideP, const CBLAS_INT N2, const double *append, const CBLAS_INT strideA, double *out, const CBLAS_INT strideOut, double *workspace, const CBLAS_INT strideW );
268+
void stdlib_strided_ddiff( const CBLAS_INT N, const CBLAS_INT k, const double *X, const CBLAS_INT strideX, const CBLAS_INT N1, const double *Prepend, const CBLAS_INT strideP, const CBLAS_INT N2, const double *Append, const CBLAS_INT strideA, double *Out, const CBLAS_INT strideOut, double *Workspace, const CBLAS_INT strideW );
269269
```
270270

271271
<!-- lint disable maximum-heading-length -->
272272

273-
#### stdlib_strided_ddiff_ndarray( N, k, \*X, strideX, offsetX, N1, \*prepend, strideP, offsetP, N2, \*append, strideA, offsetA, \*out, strideOut, offsetOut, \*workspace, strideW, offsetW )
273+
#### stdlib_strided_ddiff_ndarray( N, k, \*X, strideX, offsetX, N1, \*Prepend, strideP, offsetP, N2, \*Append, strideA, offsetA, \*Out, strideOut, offsetOut, \*Workspace, strideW, offsetW )
274274

275275
Calculates the k-th discrete forward difference of a double-precision floating-point strided array using alternative indexing semantics.
276276

@@ -291,23 +291,23 @@ The function accepts the following arguments:
291291
- **X**: `[in] double*` input array.
292292
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
293293
- **offsetX**: `[in] CBLAS_INT` starting index for `X`.
294-
- **N1**: `[in] CBLAS_INT` number of indexed elements for `prepend`.
295-
- **prepend**: `[in] double*` array containing values to prepend prior to computing differences.
296-
- **strideP**: `[in] CBLAS_INT` stride length for `prepend`.
297-
- **offsetP**: `[in] CBLAS_INT` starting index for `prepend`.
298-
- **N2**: `[in] CBLAS_INT` number of indexed elements for `append`.
299-
- **append**: `[in] double*` array containing values to append prior to computing differences.
300-
- **strideA**: `[in] CBLAS_INT` stride length for `append`.
301-
- **offsetA**: `[in] CBLAS_INT` starting index for `append`.
302-
- **out**: `[inout] double*` output array. Must have `N + N1 + N2 - k` elements.
303-
- **strideOut**: `[in] CBLAS_INT` stride length for `out`.
304-
- **offsetOut**: `[in] CBLAS_INT` starting index for `out`.
305-
- **workspace**: `[inout] double*` workspace array. Must have `N + N1 + N2 - 1` elements.
306-
- **strideW**: `[in] CBLAS_INT` stride length for `workspace`.
307-
- **offsetW**: `[in] CBLAS_INT` starting index for `workspace`.
294+
- **N1**: `[in] CBLAS_INT` number of indexed elements for `Prepend`.
295+
- **Prepend**: `[in] double*` array containing values to prepend prior to computing differences.
296+
- **strideP**: `[in] CBLAS_INT` stride length for `Prepend`.
297+
- **offsetP**: `[in] CBLAS_INT` starting index for `Prepend`.
298+
- **N2**: `[in] CBLAS_INT` number of indexed elements for `Append`.
299+
- **Append**: `[in] double*` array containing values to append prior to computing differences.
300+
- **strideA**: `[in] CBLAS_INT` stride length for `Append`.
301+
- **offsetA**: `[in] CBLAS_INT` starting index for `Append`.
302+
- **Out**: `[inout] double*` output array. Must have `N + N1 + N2 - k` elements.
303+
- **strideOut**: `[in] CBLAS_INT` stride length for `Out`.
304+
- **offsetOut**: `[in] CBLAS_INT` starting index for `Out`.
305+
- **Workspace**: `[inout] double*` workspace array. Must have `N + N1 + N2 - 1` elements.
306+
- **strideW**: `[in] CBLAS_INT` stride length for `Workspace`.
307+
- **offsetW**: `[in] CBLAS_INT` starting index for `Workspace`.
308308
309309
```c
310-
void stdlib_strided_ddiff_ndarray( const CBLAS_INT N, const CBLAS_INT k, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const CBLAS_INT N1, const double *prepend, const CBLAS_INT strideP, const CBLAS_INT offsetP, const CBLAS_INT N2, const double *append, const CBLAS_INT strideA, const CBLAS_INT offsetA, double *out, const CBLAS_INT strideOut, const CBLAS_INT offsetOut, double *workspace, const CBLAS_INT strideW, const CBLAS_INT offsetW );
310+
void stdlib_strided_ddiff_ndarray( const CBLAS_INT N, const CBLAS_INT k, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const CBLAS_INT N1, const double *Prepend, const CBLAS_INT strideP, const CBLAS_INT offsetP, const CBLAS_INT N2, const double *Append, const CBLAS_INT strideA, const CBLAS_INT offsetA, double *Out, const CBLAS_INT strideOut, const CBLAS_INT offsetOut, double *Workspace, const CBLAS_INT strideW, const CBLAS_INT offsetW );
311311
```
312312

313313
</section>

0 commit comments

Comments
 (0)