Skip to content

Commit 770aed0

Browse files
committed
docs: update README.md
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: passed - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na ---
1 parent 403c04b commit 770aed0

File tree

1 file changed

+133
-30
lines changed
  • lib/node_modules/@stdlib/stats/base/smaxabs

1 file changed

+133
-30
lines changed

lib/node_modules/@stdlib/stats/base/smaxabs/README.md

Lines changed: 133 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -36,36 +36,33 @@ limitations under the License.
3636
var smaxabs = require( '@stdlib/stats/base/smaxabs' );
3737
```
3838

39-
#### smaxabs( N, x, stride )
39+
#### smaxabs( N, x, strideX )
4040

4141
Computes the maximum absolute value of a single-precision floating-point strided array `x`.
4242

4343
```javascript
4444
var Float32Array = require( '@stdlib/array/float32' );
4545

4646
var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
47-
var N = x.length;
4847

49-
var v = smaxabs( N, x, 1 );
48+
var v = smaxabs( x.length, x, 1 );
5049
// returns 2.0
5150
```
5251

5352
The function has the following parameters:
5453

5554
- **N**: number of indexed elements.
5655
- **x**: input [`Float32Array`][@stdlib/array/float32].
57-
- **stride**: index increment for `x`.
56+
- **strideX**: stride length.
5857

59-
The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the maximum absolute value of every other element in `x`,
58+
The `N` and stride parameters determine which elements in `x` are accessed at runtime. For example, to compute the maximum absolute value of every other element in `x`,
6059

6160
```javascript
6261
var Float32Array = require( '@stdlib/array/float32' );
63-
var floor = require( '@stdlib/math/base/special/floor' );
6462

6563
var x = new Float32Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] );
66-
var N = floor( x.length / 2 );
6764

68-
var v = smaxabs( N, x, 2 );
65+
var v = smaxabs( 4, x, 2 );
6966
// returns 4.0
7067
```
7168

@@ -75,45 +72,39 @@ Note that indexing is relative to the first index. To introduce an offset, use [
7572

7673
```javascript
7774
var Float32Array = require( '@stdlib/array/float32' );
78-
var floor = require( '@stdlib/math/base/special/floor' );
7975

8076
var x0 = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
8177
var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
8278

83-
var N = floor( x0.length / 2 );
84-
85-
var v = smaxabs( N, x1, 2 );
79+
var v = smaxabs( 4, x1, 2 );
8680
// returns 4.0
8781
```
8882

89-
#### smaxabs.ndarray( N, x, stride, offset )
83+
#### smaxabs.ndarray( N, x, strideX, offsetX )
9084

9185
Computes the maximum absolute value of a single-precision floating-point strided array using alternative indexing semantics.
9286

9387
```javascript
9488
var Float32Array = require( '@stdlib/array/float32' );
9589

9690
var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
97-
var N = x.length;
9891

99-
var v = smaxabs.ndarray( N, x, 1, 0 );
92+
var v = smaxabs.ndarray( x.length, x, 1, 0 );
10093
// returns 2.0
10194
```
10295

10396
The function has the following additional parameters:
10497

105-
- **offset**: starting index for `x`.
98+
- **offsetX**: starting index for `x`.
10699

107-
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the `offset` parameter supports indexing semantics based on a starting index. For example, to calculate the maximum absolute value for every other value in `x` starting from the second value
100+
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to calculate the maximum absolute value for every other element in `x` starting from the second element
108101

109102
```javascript
110103
var Float32Array = require( '@stdlib/array/float32' );
111-
var floor = require( '@stdlib/math/base/special/floor' );
112104

113105
var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
114-
var N = floor( x.length / 2 );
115106

116-
var v = smaxabs.ndarray( N, x, 2, 1 );
107+
var v = smaxabs.ndarray( 4, x, 2, 1 );
117108
// returns 4.0
118109
```
119110

@@ -138,18 +129,13 @@ var v = smaxabs.ndarray( N, x, 2, 1 );
138129
<!-- eslint no-undef: "error" -->
139130

140131
```javascript
141-
var randu = require( '@stdlib/random/base/randu' );
142-
var round = require( '@stdlib/math/base/special/round' );
143-
var Float32Array = require( '@stdlib/array/float32' );
144-
var smaxabs = require( '@stdlib/stats/base/smaxabs' );
132+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
145133

146-
var x;
147-
var i;
134+
var smaxabs = require( '@stdlib/stats/base/smaxabs' );
148135

149-
x = new Float32Array( 10 );
150-
for ( i = 0; i < x.length; i++ ) {
151-
x[ i ] = round( (randu()*100.0) - 50.0 );
152-
}
136+
var x = discreteUniform( 10, -50, 50, {
137+
'dtype': 'float32'
138+
});
153139
console.log( x );
154140

155141
var v = smaxabs( x.length, x, 1 );
@@ -160,6 +146,123 @@ console.log( v );
160146

161147
<!-- /.examples -->
162148

149+
<!-- C interface documentation. -->
150+
151+
* * *
152+
153+
<section class="c">
154+
155+
## C APIs
156+
157+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
158+
159+
<section class="intro">
160+
161+
</section>
162+
163+
<!-- /.intro -->
164+
165+
<!-- C usage documentation. -->
166+
167+
<section class="usage">
168+
169+
### Usage
170+
171+
```c
172+
#include "stdlib/stats/base/smaxabs.h"
173+
```
174+
175+
#### stdlib_strided_smaxabs( N, \*X, strideX )
176+
177+
Computes the maximum absolute value of a single-precision floating-point strided array.
178+
179+
```c
180+
const float x[] = { 1.0f, -2.0f, 3.0f, -4.0f };
181+
182+
float v = stdlib_strided_smaxabs( 4, x, 1 );
183+
// returns 4.0f
184+
```
185+
186+
The function accepts the following arguments:
187+
188+
- **N**: `[in] CBLAS_INT` number of indexed elements.
189+
- **X**: `[in] float*` input array.
190+
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
191+
192+
```c
193+
float stdlib_strided_smaxabs( const CBLAS_INT N, const float *X, const CBLAS_INT strideX );
194+
```
195+
196+
#### stdlib_strided_smaxabs_ndarray( N, \*X, strideX, offsetX )
197+
198+
Computes the maximum absolute value of a single-precision floating-point strided array using alternative indexing semantics.
199+
200+
```c
201+
const float x[] = { 1.0f, -2.0f, 3.0f, -4.0f };
202+
203+
float v = stdlib_strided_smaxabs_ndarray( 4, x, 1, 0 );
204+
// returns 4.0f
205+
```
206+
207+
The function accepts the following arguments:
208+
209+
- **N**: `[in] CBLAS_INT` number of indexed elements.
210+
- **X**: `[in] float*` input array.
211+
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
212+
- **offsetX**: `[in] CBLAS_INT` starting index for `X`.
213+
214+
```c
215+
float stdlib_strided_smaxabs_ndarray( const CBLAS_INT N, const float *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/stats/base/smaxabs.h"
238+
#include <stdio.h>
239+
240+
int main( void ) {
241+
// Create a strided array:
242+
const float x[] = { 1.0f, -2.0f, -3.0f, 4.0f, -5.0f, -6.0f, 7.0f, 8.0f };
243+
244+
// Specify the number of elements:
245+
const int N = 4;
246+
247+
// Specify the stride length:
248+
const int strideX = 2;
249+
250+
// Compute the maximum absolute value:
251+
float v = stdlib_strided_smaxabs( N, x, strideX );
252+
253+
// Print the result:
254+
printf( "maxabs: %f\n", v );
255+
}
256+
```
257+
258+
</section>
259+
260+
<!-- /.examples -->
261+
262+
</section>
263+
264+
<!-- /.c -->
265+
163266
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
164267
165268
<section class="related">

0 commit comments

Comments
 (0)