Skip to content

Commit fd27143

Browse files
committed
refactor docs/
1 parent 25b2056 commit fd27143

File tree

2 files changed

+16
-20
lines changed

2 files changed

+16
-20
lines changed

lib/node_modules/@stdlib/blas/base/sdot/docs/repl.txt

+9-13
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
{{alias}}( N, x, strideX, y, strideY )
33
Computes the dot product of two single-precision floating-point vectors.
44

5-
The `N`, `strideX`, and `strideY` parameters determine which elements in `x`
6-
and `y` are accessed at runtime.
5+
The `N` and stride parameters determine which elements in the
6+
strided arrays are accessed at runtime.
77

88
Indexing is relative to the first index. To introduce an offset, use a typed
99
array view.
@@ -30,7 +30,7 @@
3030
Returns
3131
-------
3232
dot: float
33-
The dot product of `x` and `y`.
33+
Output array.
3434

3535
Examples
3636
--------
@@ -43,25 +43,23 @@
4343
// Strides:
4444
> x = new {{alias:@stdlib/array/float32}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
4545
> y = new {{alias:@stdlib/array/float32}}( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
46-
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
47-
> dot = {{alias}}( N, x, 2, y, -1 )
46+
> dot = {{alias}}( 3, x, 2, y, -1 )
4847
9.0
4948

5049
// Using view offsets:
5150
> x = new {{alias:@stdlib/array/float32}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
5251
> y = new {{alias:@stdlib/array/float32}}( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
5352
> var x1 = new {{alias:@stdlib/array/float32}}( x.buffer, x.BYTES_PER_ELEMENT*1 );
5453
> var y1 = new {{alias:@stdlib/array/float32}}( y.buffer, y.BYTES_PER_ELEMENT*3 );
55-
> N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
56-
> dot = {{alias}}( N, x1, -2, y1, 1 )
54+
> dot = {{alias}}( 3, x1, -2, y1, 1 )
5755
128.0
5856

5957
{{alias}}.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )
6058
Computes the dot product of two single-precision floating-point vectors
6159
using alternative indexing semantics.
6260

6361
While typed array views mandate a view offset based on the underlying
64-
buffer, the `offsetX` and `offsetY` parameters support indexing based on a
62+
buffer, the offset parameters support indexing based on a
6563
starting index.
6664

6765
Parameters
@@ -90,7 +88,7 @@
9088
Returns
9189
-------
9290
dot: float
93-
The dot product of `x` and `y`.
91+
Output array.
9492

9593
Examples
9694
--------
@@ -103,15 +101,13 @@
103101
// Strides:
104102
> x = new {{alias:@stdlib/array/float32}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
105103
> y = new {{alias:@stdlib/array/float32}}( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
106-
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
107-
> dot = {{alias}}.ndarray( N, x, 2, 0, y, 2, 0 )
104+
> dot = {{alias}}.ndarray( 3, x, 2, 0, y, 2, 0 )
108105
9.0
109106

110107
// Using offset indices:
111108
> x = new {{alias:@stdlib/array/float32}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
112109
> y = new {{alias:@stdlib/array/float32}}( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
113-
> N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
114-
> dot = {{alias}}.ndarray( N, x, -2, x.length-1, y, 1, 3 )
110+
> dot = {{alias}}.ndarray( 3, x, -2, x.length-1, y, 1, 3 )
115111
128.0
116112

117113
See Also

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

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
* @license Apache-2.0
33
*
4-
* Copyright (c) 2020 The Stdlib Authors.
4+
* Copyright (c) 2023 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.
@@ -25,12 +25,12 @@ interface Routine {
2525
/**
2626
* Computes the dot product of two single-precision floating-point vectors.
2727
*
28-
* @param N - number of values over which to compute the dot product
28+
* @param N - number of values
2929
* @param x - first input array
3030
* @param strideX - `x` stride length
3131
* @param y - second input array
3232
* @param strideY - `y` stride length
33-
* @returns dot product of `x` and `y`
33+
* @returns output array
3434
*
3535
* @example
3636
* var Float32Array = require( `@stdlib/array/float32` );
@@ -46,14 +46,14 @@ interface Routine {
4646
/**
4747
* Computes the dot product of `x` and `y` using alternative indexing semantics.
4848
*
49-
* @param N - number of values over which to compute the dot product
49+
* @param N - number of values
5050
* @param x - first input array
5151
* @param strideX - `x` stride length
5252
* @param offsetX - starting index for `x`
5353
* @param y - second input array
5454
* @param strideY - `y` stride length
5555
* @param offsetY - starting index for `y`
56-
* @returns dot product of `x` and `y`
56+
* @returns output array
5757
*
5858
* @example
5959
* var Float32Array = require( `@stdlib/array/float32` );
@@ -70,12 +70,12 @@ interface Routine {
7070
/**
7171
* Computes the dot product of `x` and `y`.
7272
*
73-
* @param N - number of values over which to compute the dot product
73+
* @param N - number of values
7474
* @param x - first input array
7575
* @param strideX - `x` stride length
7676
* @param y - second input array
7777
* @param strideY - `y` stride length
78-
* @returns dot product of `x` and `y`
78+
* @returns output array
7979
*
8080
* @example
8181
* var Float32Array = require( `@stdlib/array/float32` );

0 commit comments

Comments
 (0)