Skip to content

Commit 76e7271

Browse files
committed
docs: update README for cosine mean function with correct usage and parameters
1 parent 3c0f381 commit 76e7271

File tree

1 file changed

+8
-8
lines changed
  • lib/node_modules/@stdlib/stats/base/dists/cosine/mean

1 file changed

+8
-8
lines changed

lib/node_modules/@stdlib/stats/base/dists/cosine/mean/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -154,25 +154,25 @@ for ( i = 0; i < 10; i++ ) {
154154
### Usage
155155

156156
```c
157-
#include "stdlib/stats/base/dists/arcsine/variance.h"
157+
#include "stdlib/stats/base/dists/cosine/mean.h"
158158
```
159159

160-
#### stdlib_base_dists_arcsine_variance( a, b )
160+
#### stdlib_base_dists_cosine_mean( a, b )
161161

162-
Returns the variance of an arcsine distribution.
162+
Returns the mean of an cosine distribution.
163163

164164
```c
165-
double out = stdlib_base_dists_arcsine_variance( 0.0, 1.0 );
166-
// returns ~0.125
165+
double out = stdlib_base_dists_cosine_mean( 2.0, 1.0 );
166+
// returns 2.0
167167
```
168168

169169
The function accepts the following arguments:
170170

171-
- **a**: `[in] double` minimum support.
172-
- **b**: `[in] double` maximum support.
171+
- **mu**: `[in] double` location parameter.
172+
- **s**: `[in] double` scale parameter.
173173

174174
```c
175-
double stdlib_base_dists_arcsine_variance( const double a, const double b );
175+
double stdlib_base_dists_cosine_mean( const double mu, const double s );
176176
```
177177
178178
</section>

0 commit comments

Comments
 (0)