Skip to content

Commit 550cf7e

Browse files
committed
docs: add struct to docs
--- 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 ---
1 parent ade7845 commit 550cf7e

File tree

1 file changed

+85
-0
lines changed
  • lib/node_modules/@stdlib/stats/base/ztest/one-sample/results/float32

1 file changed

+85
-0
lines changed

lib/node_modules/@stdlib/stats/base/ztest/one-sample/results/float32/README.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -292,6 +292,91 @@ console.log( str );
292292

293293
<!-- /.examples -->
294294

295+
<!-- C interface documentation. -->
296+
297+
* * *
298+
299+
<section class="c">
300+
301+
## C APIs
302+
303+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
304+
305+
<section class="intro">
306+
307+
</section>
308+
309+
<!-- /.intro -->
310+
311+
<!-- C usage documentation. -->
312+
313+
<section class="usage">
314+
315+
### Usage
316+
317+
```c
318+
#include "stdlib/stats/base/ztest/one-sample/results/float32.h"
319+
```
320+
321+
#### stdlib_stats_ztest_one_sample_float32_results
322+
323+
Structure for holding single-precision floating-point test results.
324+
325+
```c
326+
#include <stdbool.h>
327+
#include <stdint.h>
328+
329+
struct stdlib_stats_ztest_one_sample_float32_results {
330+
// Boolean indicating whether the null hypothesis was rejected:
331+
bool rejected;
332+
333+
// Alternative hypothesis:
334+
int8_t alternative;
335+
336+
// Significance level:
337+
float alpha;
338+
339+
// p-value:
340+
float pValue;
341+
342+
// Test statistic:
343+
float statistic;
344+
345+
// Confidence interval:
346+
float ci[ 2 ];
347+
348+
// Mean value under the null hypothesis:
349+
float nullValue;
350+
351+
// Standard error of the mean:
352+
float sd;
353+
};
354+
```
355+
356+
</section>
357+
358+
<!-- /.usage -->
359+
360+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
361+
362+
<section class="notes">
363+
364+
</section>
365+
366+
<!-- /.notes -->
367+
368+
<!-- C API usage examples. -->
369+
370+
<section class="examples">
371+
372+
</section>
373+
374+
<!-- /.examples -->
375+
376+
</section>
377+
378+
<!-- /.c -->
379+
295380
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
296381

297382
<section class="references">

0 commit comments

Comments
 (0)