1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
<!--
@license Apache-2.0
Copyright (c) 2018 The Stdlib Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
# Mode
> [Logistic][logistic-distribution] distribution [mode][mode].
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
<section class="intro">
The [mode][mode] for a [logistic][logistic-distribution] random variable with location `μ` and scale `s > 0` is
<!-- <equation class="equation" label="eq:logistic_mode" align="center" raw="\operatorname{mode}\left( X \right) = \mu" alt="Mode for a logistic distribution."> -->
<div class="equation" align="center" data-raw-text="\operatorname{mode}\left( X \right) = \mu" data-equation="eq:logistic_mode">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@51534079fef45e990850102147e8945fb023d1d0/lib/node_modules/@stdlib/stats/base/dists/logistic/mode/docs/img/equation_logistic_mode.svg" alt="Mode for a logistic distribution.">
<br>
</div>
<!-- </equation> -->
</section>
<!-- /.intro -->
<!-- Package usage documentation. -->
<section class="usage">
## Usage
```javascript
var mode = require( '@stdlib/stats/base/dists/logistic/mode' );
```
#### mode( mu, s )
Returns the [mode][mode] for a [logistic][logistic-distribution] distribution with location parameter `mu` and scale parameter `s`.
```javascript
var y = mode( 2.0, 1.0 );
// returns 2.0
y = mode( 0.0, 1.0 );
// returns 0.0
y = mode( -1.0, 4.0 );
// returns -1.0
```
If provided `NaN` as any argument, the function returns `NaN`.
```javascript
var y = mode( NaN, 1.0 );
// returns NaN
y = mode( 0.0, NaN );
// returns NaN
```
If provided `s <= 0`, the function returns `NaN`.
```javascript
var y = mode( 0.0, 0.0 );
// returns NaN
y = mode( 0.0, -1.0 );
// returns NaN
```
</section>
<!-- /.usage -->
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
<section class="notes">
</section>
<!-- /.notes -->
<!-- Package usage examples. -->
<section class="examples">
## Examples
<!-- eslint no-undef: "error" -->
```javascript
var randu = require( '@stdlib/random/base/randu' );
var mode = require( '@stdlib/stats/base/dists/logistic/mode' );
var mu;
var s;
var y;
var i;
for ( i = 0; i < 10; i++ ) {
mu = ( randu()*10.0 ) - 5.0;
s = randu() * 20.0;
y = mode( mu, s );
console.log( 'µ: %d, s: %d, mode(X;µ,s): %d', mu.toFixed( 4 ), s.toFixed( 4 ), y.toFixed( 4 ) );
}
```
</section>
<!-- /.examples -->
<!-- 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. -->
<section class="references">
</section>
<!-- /.references -->
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
<section class="links">
[logistic-distribution]: https://en.wikipedia.org/wiki/Logistic_distribution
[mode]: https://en.wikipedia.org/wiki/Mode_%28statistics%29
</section>
<!-- /.links -->
|
