Skip to content

Commit f2e8b56

Browse files
committed
docs: update related packages sections
1 parent 911e179 commit f2e8b56

File tree

3 files changed

+5
-113
lines changed

3 files changed

+5
-113
lines changed

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

Lines changed: 0 additions & 111 deletions
Original file line numberDiff line numberDiff line change
@@ -154,117 +154,6 @@ console.log( x );
154154

155155
* * *
156156

157-
</section>
158-
159-
<!-- /.intro -->
160-
161-
<!-- C usage documentation. -->
162-
163-
<section class="usage">
164-
165-
### Usage
166-
167-
```c
168-
#include "stdlib/blas/ext/base/dsortins.h"
169-
```
170-
171-
#### stdlib_strided_dsortins( N, order, \*X, strideX )
172-
173-
Sorts a double-precision floating-point strided array using insertion sort.
174-
175-
```c
176-
double x[] = { 1.0, -2.0, 3.0, -4.0 };
177-
178-
stdlib_strided_dsortins( 2, -1.0, x, 1 );
179-
```
180-
181-
The function accepts the following arguments:
182-
183-
- **N**: `[in] CBLAS_INT` number of indexed elements.
184-
- **order**: `[in] double` sort order. If `order < 0.0`, the input strided array is sorted in **decreasing** order. If `order > 0.0`, the input strided array is sorted in **increasing** order. If `order == 0.0`, the input strided array is left unchanged.
185-
- **X**: `[inout] double*` input array.
186-
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
187-
188-
```c
189-
stdlib_strided_dsortins( const CBLAS_INT N, const double order, double *X, const CBLAS_INT strideX );
190-
```
191-
192-
<!--lint disable maximum-heading-length-->
193-
194-
#### stdlib_strided_dsortins_ndarray( N, order, \*X, strideX, offsetX )
195-
196-
<!--lint enable maximum-heading-length-->
197-
198-
Sorts a double-precision floating-point strided array using insertion sort and alternative indexing semantics.
199-
200-
```c
201-
double x[] = { 1.0, -2.0, 3.0, -4.0 };
202-
203-
stdlib_strided_dsortins_ndarray( 4, 1.0, x, 1, 0 );
204-
```
205-
206-
The function accepts the following arguments:
207-
208-
- **N**: `[in] CBLAS_INT` number of indexed elements.
209-
- **order**: `[in] double` sort order. If `order < 0.0`, the input strided array is sorted in **decreasing** order. If `order > 0.0`, the input strided array is sorted in **increasing** order. If `order == 0.0`, the input strided array is left unchanged.
210-
- **X**: `[inout] double*` input array.
211-
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
212-
- **offsetX**: `[in] CBLAS_INT` starting index for `X`.
213-
214-
```c
215-
stdlib_strided_dsortins_ndarray( const CBLAS_INT N, const double order, double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX );
216-
```
217-
218-
</section>
219-
220-
<!-- /.usage -->
221-
222-
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
223-
224-
<section class="notes">
225-
226-
</section>
227-
228-
<!-- /.notes -->
229-
230-
<!-- C API usage examples. -->
231-
232-
<section class="examples">
233-
234-
### Examples
235-
236-
```c
237-
#include "stdlib/blas/ext/base/dsortins.h"
238-
#include <stdio.h>
239-
240-
int main( void ) {
241-
// Create a strided array:
242-
double x[] = { 1.0, -2.0, 3.0, -4.0, 5.0, -6.0, 7.0, -8.0 };
243-
244-
// Specify the number of elements:
245-
int N = 8;
246-
247-
// Specify a stride:
248-
int strideX = 1;
249-
250-
// Sort the array:
251-
stdlib_strided_dsortins( N, 1.0, x, strideX );
252-
253-
// Print the result:
254-
for ( int i = 0; i < 8; i++ ) {
255-
printf( "x[ %i ] = %lf\n", i, x[ i ] );
256-
}
257-
}
258-
```
259-
260-
</section>
261-
262-
<!-- /.examples -->
263-
264-
</section>
265-
266-
<!-- /.c -->
267-
268157
## See Also
269158

270159
- <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/blas/ext/base/gapxsumkbn/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -160,9 +160,9 @@ console.log( v );
160160
## See Also
161161

162162
- <span class="package-name">[`@stdlib/blas/ext/base/dapxsumkbn`][@stdlib/blas/ext/base/dapxsumkbn]</span><span class="delimiter">: </span><span class="description">add a constant to each double-precision floating-point strided array element and compute the sum using an improved Kahan–Babuška algorithm.</span>
163-
- <span class="package-name">[`@stdlib/blas/ext/base/gapxsum`][@stdlib/blas/ext/base/gapxsum]</span><span class="delimiter">: </span><span class="description">add a constant to each strided array element and compute the sum.</span>
163+
- <span class="package-name">[`@stdlib/blas/ext/base/gapxsum`][@stdlib/blas/ext/base/gapxsum]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each strided array element and compute the sum.</span>
164164
- <span class="package-name">[`@stdlib/blas/ext/base/gsumkbn`][@stdlib/blas/ext/base/gsumkbn]</span><span class="delimiter">: </span><span class="description">calculate the sum of strided array elements using an improved Kahan–Babuška algorithm.</span>
165-
- <span class="package-name">[`@stdlib/blas/ext/base/sapxsumkbn`][@stdlib/blas/ext/base/sapxsumkbn]</span><span class="delimiter">: </span><span class="description">add a constant to each single-precision floating-point strided array element and compute the sum using an improved Kahan–Babuška algorithm.</span>
165+
- <span class="package-name">[`@stdlib/blas/ext/base/sapxsumkbn`][@stdlib/blas/ext/base/sapxsumkbn]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each single-precision floating-point strided array element and compute the sum using an improved Kahan–Babuška algorithm.</span>
166166

167167
</section>
168168

lib/node_modules/@stdlib/math/base/special/deg2radf/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,7 @@ int main( void ) {
168168
## See Also
169169

170170
- <span class="package-name">[`@stdlib/math/base/special/deg2rad`][@stdlib/math/base/special/deg2rad]</span><span class="delimiter">: </span><span class="description">convert an angle from degrees to radians.</span>
171+
- <span class="package-name">[`@stdlib/math/base/special/rad2degf`][@stdlib/math/base/special/rad2degf]</span><span class="delimiter">: </span><span class="description">convert an angle from radians to degrees (single-precision).</span>
171172

172173
</section>
173174

@@ -181,6 +182,8 @@ int main( void ) {
181182

182183
[@stdlib/math/base/special/deg2rad]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/deg2rad
183184

185+
[@stdlib/math/base/special/rad2degf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/rad2degf
186+
184187
<!-- </related-links> -->
185188

186189
</section>

0 commit comments

Comments
 (0)