Skip to content

Commit 9b60a5e

Browse files
authored
Apply suggestions from code review
Signed-off-by: Athan <kgryte@gmail.com>
1 parent 9fa6bc9 commit 9b60a5e

File tree

1 file changed

+3
-26
lines changed
  • lib/node_modules/@stdlib/stats/strided/mskmidrange

1 file changed

+3
-26
lines changed

lib/node_modules/@stdlib/stats/strided/mskmidrange/README.md

Lines changed: 3 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ var mskmidrange = require( '@stdlib/stats/strided/mskmidrange' );
4040

4141
#### mskmidrange( N, x, strideX, mask, strideMask )
4242

43-
Computes the [mid-range][mid-range] of a strided array `x` according to a `mask`.
43+
Computes the [mid-range][mid-range] of a strided array according to a mask.
4444

4545
```javascript
4646
var x = [ 1.0, -2.0, 4.0, 2.0 ];
@@ -88,7 +88,7 @@ var v = mskmidrange( 4, x1, 2, mask1, 2 );
8888

8989
#### mskmidrange.ndarray( N, x, strideX, offsetX, mask, strideMask, offsetMask )
9090

91-
Computes the [mid-range][mid-range] of a strided array according to a `mask` and using alternative indexing semantics.
91+
Computes the [mid-range][mid-range] of a strided array according to a mask and using alternative indexing semantics.
9292

9393
```javascript
9494
var x = [ 1.0, -2.0, 4.0, 2.0 ];
@@ -103,7 +103,7 @@ The function has the following additional parameters:
103103
- **offsetX**: starting index for `x`.
104104
- **offsetMask**: starting index for `mask`.
105105

106-
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 [mid-range][mid-range] of every other value in `x` starting from the second value
106+
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 [mid-range][mid-range] of every other value in `x` starting from the second value
107107

108108
```javascript
109109
var x = [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, 5.0, 6.0 ];
@@ -162,17 +162,6 @@ console.log( v );
162162

163163
<section class="related">
164164

165-
* * *
166-
167-
## See Also
168-
169-
- <span class="package-name">[`@stdlib/stats/strided/dmskmidrange`][@stdlib/stats/strided/dmskmidrange]</span><span class="delimiter">: </span><span class="description">calculate the mid-range of a double-precision floating-point strided array according to a mask.</span>
170-
- <span class="package-name">[`@stdlib/stats/strided/midrange`][@stdlib/stats/strided/midrange]</span><span class="delimiter">: </span><span class="description">calculate the mid-range of a strided array.</span>
171-
- <span class="package-name">[`@stdlib/stats/strided/mskmax`][@stdlib/stats/strided/mskmax]</span><span class="delimiter">: </span><span class="description">calculate the maximum value of a strided array according to a mask.</span>
172-
- <span class="package-name">[`@stdlib/stats/strided/mskmin`][@stdlib/stats/strided/mskmin]</span><span class="delimiter">: </span><span class="description">calculate the minimum value of a strided array according to a mask.</span>
173-
- <span class="package-name">[`@stdlib/stats/strided/nanmidrange`][@stdlib/stats/strided/nanmidrange]</span><span class="delimiter">: </span><span class="description">calculate the mid-range of a strided array, ignoring NaN values.</span>
174-
- <span class="package-name">[`@stdlib/stats/strided/smskmidrange`][@stdlib/stats/strided/smskmidrange]</span><span class="delimiter">: </span><span class="description">calculate the mid-range of a single-precision floating-point strided array according to a mask.</span>
175-
176165
</section>
177166

178167
<!-- /.related -->
@@ -189,22 +178,10 @@ console.log( v );
189178

190179
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
191180

192-
<!-- <related-links> -->
193-
194181
[@stdlib/stats/strided/dmskmidrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dmskmidrange
195182

196-
[@stdlib/stats/strided/midrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/midrange
197-
198-
[@stdlib/stats/strided/mskmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/mskmax
199-
200-
[@stdlib/stats/strided/mskmin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/mskmin
201-
202-
[@stdlib/stats/strided/nanmidrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/nanmidrange
203-
204183
[@stdlib/stats/strided/smskmidrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/smskmidrange
205184

206-
<!-- </related-links> -->
207-
208185
</section>
209186

210187
<!-- /.links -->

0 commit comments

Comments
 (0)