Skip to content

Commit 51e5204

Browse files
committed
docs: update related packages sections
1 parent dddf657 commit 51e5204

File tree

3 files changed

+2
-134
lines changed

3 files changed

+2
-134
lines changed

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

Lines changed: 0 additions & 131 deletions
Original file line numberDiff line numberDiff line change
@@ -193,137 +193,6 @@ console.log( y );
193193

194194
* * *
195195

196-
<!-- C interface documentation. -->
197-
198-
<section class="c">
199-
200-
## C APIs
201-
202-
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
203-
204-
<section class="intro">
205-
206-
</section>
207-
208-
<!-- /.intro -->
209-
210-
<!-- C usage documentation. -->
211-
212-
<section class="usage">
213-
214-
### Usage
215-
216-
```c
217-
#include "stdlib/blas/ext/base/ssort2ins.h"
218-
```
219-
220-
#### stdlib_strided_ssort2ins( N, order, \*X, strideX, \*Y, strideY )
221-
222-
Simultaneously sorts two single-precision floating-point strided arrays based on the sort order of the first array using insertion sort.
223-
224-
```c
225-
float x[] = { 1.0f, -2.0f, 3.0f, -4.0f };
226-
float y[] = { 0.0f, 1.0f, 2.0f, 3.0f };
227-
228-
stdlib_strided_ssort2ins( 4, 1.0f, x, 1, y, 1 );
229-
```
230-
231-
The function accepts the following arguments:
232-
233-
- **N**: `[in] CBLAS_INT` number of indexed elements.
234-
- **order**: `[in] float` sort order. If `order < 0.0`, the input strided array `X` is sorted in **decreasing** order. If `order > 0.0`, the input strided array `X` is sorted in **increasing** order. If `order == 0.0`, the input strided arrays are left unchanged.
235-
- **X**: `[inout] float*` first input array.
236-
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
237-
- **Y**: `[inout] float*` second input array.
238-
- **strideY**: `[in] CBLAS_INT` stride length for `Y`.
239-
240-
```c
241-
stdlib_strided_ssort2ins( const CBLAS_INT N, const float order, float *X, const CBLAS_INT strideX, float *Y, const CBLAS_INT strideY );
242-
```
243-
244-
<!--lint disable maximum-heading-length-->
245-
246-
#### stdlib_strided_ssort2ins_ndarray( N, order, \*X, strideX, offsetX, \*Y, strideY, offsetY )
247-
248-
<!--lint enable maximum-heading-length-->
249-
250-
Simultaneously sorts two single-precision floating-point strided arrays based on the sort order of the first array using insertion sort and alternative indexing semantics.
251-
252-
```c
253-
float x[] = { 1.0f, -2.0f, 3.0f, -4.0f };
254-
float y[] = { 0.0f, 1.0f, 2.0f, 3.0f };
255-
256-
stdlib_strided_ssort2ins_ndarray( 4, 1.0f, x, 1, 0, y, 1, 0 );
257-
```
258-
259-
The function accepts the following arguments:
260-
261-
- **N**: `[in] CBLAS_INT` number of indexed elements.
262-
- **order**: `[in] float` sort order. If `order < 0.0`, the input strided array `X` is sorted in **decreasing** order. If `order > 0.0`, the input strided array `X` is sorted in **increasing** order. If `order == 0.0`, the input strided arrays are left unchanged.
263-
- **X**: `[inout] float*` first input array.
264-
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
265-
- **offsetX**: `[in] CBLAS_INT` starting index for `X`.
266-
- **Y**: `[inout] float*` second input array.
267-
- **strideY**: `[in] CBLAS_INT` stride length for `Y`.
268-
- **offsetY**: `[in] CBLAS_INT` starting index for `Y`.
269-
270-
```c
271-
stdlib_strided_ssort2ins_ndarray( const CBLAS_INT N, const float order, float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, float *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY );
272-
```
273-
274-
</section>
275-
276-
<!-- /.usage -->
277-
278-
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
279-
280-
<section class="notes">
281-
282-
</section>
283-
284-
<!-- /.notes -->
285-
286-
<!-- C API usage examples. -->
287-
288-
<section class="examples">
289-
290-
### Examples
291-
292-
```c
293-
#include "stdlib/blas/ext/base/ssort2ins.h"
294-
#include <stdio.h>
295-
296-
int main( void ) {
297-
// Create strided arrays:
298-
float x[] = { 1.0f, -2.0f, 3.0f, -4.0f, 5.0f, -6.0f, 7.0f, -8.0f };
299-
float y[] = { 0.0f, 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f };
300-
301-
// Specify the number of elements:
302-
int N = 8;
303-
304-
// Specify the strides:
305-
int strideX = 1;
306-
int strideY = 1;
307-
308-
// Sort the arrays:
309-
stdlib_strided_ssort2ins( N, 1.0f, x, strideX, y, strideY );
310-
311-
// Print the result:
312-
for ( int i = 0; i < 8; i++ ) {
313-
printf( "x[ %i ] = %f\n", i, x[ i ] );
314-
printf( "y[ %i ] = %f\n", i, y[ i ] );
315-
}
316-
}
317-
```
318-
319-
</section>
320-
321-
<!-- /.examples -->
322-
323-
</section>
324-
325-
<!-- /.c -->
326-
327196
## See Also
328197

329198
- <span class="package-name">[`@stdlib/blas/ext/base/dsort2ins`][@stdlib/blas/ext/base/dsort2ins]</span><span class="delimiter">: </span><span class="description">simultaneously sort two double-precision floating-point strided arrays based on the sort order of the first array using insertion sort.</span>

lib/node_modules/@stdlib/stats/base/dists/gumbel/quantile/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,6 @@ for ( i = 0; i < 100; i++ ) {
177177

178178
#### stdlib_base_dists_gumbel_quantile( p, mu, beta )
179179

180-
181180
Evaluates the [quantile-function][quantile-function] of a [gumbel-distribution][gumbel-distribution] with parameter probability `p`, location parameter `mu` and scale parameter `beta`.
182181

183182
```c

lib/node_modules/@stdlib/utils/some-own-by/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ bool = someOwnBy( obj, 5, threshold );
222222
- <span class="package-name">[`@stdlib/utils/any-own-by`][@stdlib/utils/any-own-by]</span><span class="delimiter">: </span><span class="description">test whether whether any 'own' property of a provided object satisfies a predicate function.</span>
223223
- <span class="package-name">[`@stdlib/object/every-own-by`][@stdlib/object/every-own-by]</span><span class="delimiter">: </span><span class="description">test whether all own properties of an object pass a test implemented by a predicate function.</span>
224224
- <span class="package-name">[`@stdlib/utils/some-by`][@stdlib/utils/some-by]</span><span class="delimiter">: </span><span class="description">test whether a collection contains at least `n` elements which pass a test implemented by a predicate function.</span>
225-
- <span class="package-name">[`@stdlib/utils/some-in-by`][@stdlib/utils/some-in-by]</span><span class="delimiter">: </span><span class="description">test whether an object contains at least n properties (own and inherited) which pass a test implemented by a predicate function.</span>
225+
- <span class="package-name">[`@stdlib/object/some-in-by`][@stdlib/object/some-in-by]</span><span class="delimiter">: </span><span class="description">test whether an object contains at least n properties (own and inherited) which pass a test implemented by a predicate function.</span>
226226

227227
</section>
228228

@@ -242,7 +242,7 @@ bool = someOwnBy( obj, 5, threshold );
242242

243243
[@stdlib/utils/some-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/some-by
244244

245-
[@stdlib/utils/some-in-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/some-in-by
245+
[@stdlib/object/some-in-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/some-in-by
246246

247247
<!-- </related-links> -->
248248

0 commit comments

Comments
 (0)