Skip to content

Commit 55186b2

Browse files
fix(readme): updated 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 e1a755b commit 55186b2

File tree

1 file changed

+93
-0
lines changed
  • lib/node_modules/@stdlib/stats/base/dists/rayleigh/skewness

1 file changed

+93
-0
lines changed

lib/node_modules/@stdlib/stats/base/dists/rayleigh/skewness/README.md

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,99 @@ for ( i = 0; i < 10; i++ ) {
116116

117117
<!-- /.examples -->
118118

119+
120+
<!-- C interface documentation. -->
121+
122+
* * *
123+
124+
<section class="c">
125+
126+
## C APIs
127+
128+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
129+
130+
<section class="intro">
131+
132+
</section>
133+
134+
<!-- /.intro -->
135+
136+
<!-- C usage documentation. -->
137+
138+
<section class="usage">
139+
140+
### Usage
141+
142+
```c
143+
#include "stdlib/stats/base/dists/rayleigh/skewness.h"
144+
```
145+
146+
#### stdlib_base_dists_rayleigh_skewness( sigma )
147+
148+
Evaluates the skewness for a Rayleigh distribution.
149+
150+
```c
151+
double out = stdlib_base_dists_rayleigh_skewness( 9.0 );
152+
// returns ~0.631
153+
```
154+
155+
The function accepts the following arguments:
156+
157+
- **sigma**: `[in] double` scale parameter.
158+
159+
```c
160+
double stdlib_base_dists_rayleigh_skewness( const double sigma );
161+
```
162+
163+
</section>
164+
165+
<!-- /.usage -->
166+
167+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
168+
169+
<section class="notes">
170+
171+
</section>
172+
173+
<!-- /.notes -->
174+
175+
<!-- C API usage examples. -->
176+
177+
<section class="examples">
178+
179+
### Examples
180+
181+
```c
182+
#include "stdlib/stats/base/dists/rayleigh/skewness.h"
183+
#include <stdlib.h>
184+
#include <stdio.h>
185+
186+
static double random_uniform( const double min, const double max ) {
187+
double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
188+
return min + ( v*(max-min) );
189+
}
190+
191+
int main( void ) {
192+
double sigma;
193+
double y;
194+
int i;
195+
196+
for ( i = 0; i < 25; i++ ) {
197+
sigma = random_uniform( 0.0, 10.0 );
198+
y = stdlib_base_dists_rayleigh_skewness( sigma );
199+
printf( "σ: %lf, f(x;σ): %lf\n", sigma, y );
200+
}
201+
}
202+
```
203+
204+
</section>
205+
206+
<!-- /.examples -->
207+
208+
</section>
209+
210+
<!-- /.c -->
211+
119212
<!-- 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. -->
120213

121214
<section class="references">

0 commit comments

Comments
 (0)