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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
<!--
@license Apache-2.0
Copyright (c) 2020 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.
-->
# dmediansorted
> Calculate the median value of a sorted double-precision floating-point strided array.
<section class="intro">
</section>
<!-- /.intro -->
<section class="usage">
## Usage
```javascript
var dmediansorted = require( '@stdlib/stats/base/dmediansorted' );
```
#### dmediansorted( N, x, stride )
Computes the median value of a sorted double-precision floating-point strided array `x`.
```javascript
var Float64Array = require( '@stdlib/array/float64' );
var x = new Float64Array( [ 1.0, 2.0, 3.0 ] );
var v = dmediansorted( x.length, x, 1 );
// returns 2.0
x = new Float64Array( [ 3.0, 2.0, 1.0 ] );
v = dmediansorted( x.length, x, 1 );
// returns 2.0
```
The function has the following parameters:
- **N**: number of indexed elements.
- **x**: sorted input [`Float64Array`][@stdlib/array/float64].
- **stride**: index increment for `x`.
The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the median value of every other element in `x`,
```javascript
var Float64Array = require( '@stdlib/array/float64' );
var floor = require( '@stdlib/math/base/special/floor' );
var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, 3.0, 3.0, 4.0, 2.0 ] );
var N = floor( x.length / 2 );
var v = dmediansorted( N, x, 2 );
// returns 2.5
```
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
<!-- eslint-disable stdlib/capitalized-comments -->
```javascript
var Float64Array = require( '@stdlib/array/float64' );
var floor = require( '@stdlib/math/base/special/floor' );
var x0 = new Float64Array( [ 2.0, 1.0, 2.0, 2.0, -2.0, 2.0, 3.0, 4.0 ] );
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
var N = floor( x0.length / 2 );
var v = dmediansorted( N, x1, 2 );
// returns 2.0
```
#### dmediansorted.ndarray( N, x, stride, offset )
Computes the median value of a sorted double-precision floating-point strided array using alternative indexing semantics.
```javascript
var Float64Array = require( '@stdlib/array/float64' );
var x = new Float64Array( [ 1.0, 2.0, 3.0 ] );
var N = x.length;
var v = dmediansorted.ndarray( N, x, 1, 0 );
// returns 2.0
```
The function has the following additional parameters:
- **offset**: starting index for `x`.
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 median value for every other value in `x` starting from the second value
```javascript
var Float64Array = require( '@stdlib/array/float64' );
var floor = require( '@stdlib/math/base/special/floor' );
var x = new Float64Array( [ 2.0, 1.0, 2.0, 2.0, -2.0, 2.0, 3.0, 4.0 ] );
var N = floor( x.length / 2 );
var v = dmediansorted.ndarray( N, x, 2, 1 );
// returns 2.0
```
</section>
<!-- /.usage -->
<section class="notes">
## Notes
- If `N <= 0`, both functions return `NaN`.
- The input strided array must be sorted in either **strictly** ascending or descending order.
</section>
<!-- /.notes -->
<section class="examples">
## Examples
<!-- eslint no-undef: "error" -->
```javascript
var Float64Array = require( '@stdlib/array/float64' );
var dmediansorted = require( '@stdlib/stats/base/dmediansorted' );
var x;
var i;
x = new Float64Array( 10 );
for ( i = 0; i < x.length; i++ ) {
x[ i ] = i - 5.0;
}
console.log( x );
var v = dmediansorted( x.length, x, 1 );
console.log( v );
```
</section>
<!-- /.examples -->
<section class="links">
[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
</section>
<!-- /.links -->
|
