@stdlib/stats-base-ndarray-smeanlipw 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +177 -0
- package/NOTICE +1 -0
- package/README.md +240 -0
- package/SECURITY.md +5 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +5 -0
- package/dist/index.js.map +7 -0
- package/docs/img/equation_arithmetic_mean.svg +42 -0
- package/docs/types/index.d.ts +46 -0
- package/lib/index.js +45 -0
- package/lib/main.js +56 -0
- package/package.json +82 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,177 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
package/NOTICE
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
Copyright (c) 2016-2026 The Stdlib Authors.
|
package/README.md
ADDED
|
@@ -0,0 +1,240 @@
|
|
|
1
|
+
<!--
|
|
2
|
+
|
|
3
|
+
@license Apache-2.0
|
|
4
|
+
|
|
5
|
+
Copyright (c) 2025 The Stdlib Authors.
|
|
6
|
+
|
|
7
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
8
|
+
you may not use this file except in compliance with the License.
|
|
9
|
+
You may obtain a copy of the License at
|
|
10
|
+
|
|
11
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
12
|
+
|
|
13
|
+
Unless required by applicable law or agreed to in writing, software
|
|
14
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
15
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
16
|
+
See the License for the specific language governing permissions and
|
|
17
|
+
limitations under the License.
|
|
18
|
+
|
|
19
|
+
-->
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
<details>
|
|
23
|
+
<summary>
|
|
24
|
+
About stdlib...
|
|
25
|
+
</summary>
|
|
26
|
+
<p>We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.</p>
|
|
27
|
+
<p>The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.</p>
|
|
28
|
+
<p>When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.</p>
|
|
29
|
+
<p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
|
|
30
|
+
</details>
|
|
31
|
+
|
|
32
|
+
# smeanlipw
|
|
33
|
+
|
|
34
|
+
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
|
|
35
|
+
|
|
36
|
+
> Compute the [arithmetic mean][arithmetic-mean] of a one-dimensional single-precision floating-point ndarray using a one-pass trial mean algorithm with pairwise summation.
|
|
37
|
+
|
|
38
|
+
<section class="intro">
|
|
39
|
+
|
|
40
|
+
The [arithmetic mean][arithmetic-mean] is defined as
|
|
41
|
+
|
|
42
|
+
<!-- <equation class="equation" label="eq:arithmetic_mean" align="center" raw="\mu = \frac{1}{n} \sum_{i=0}^{n-1} x_i" alt="Equation for the arithmetic mean."> -->
|
|
43
|
+
|
|
44
|
+
<div class="equation" align="center" data-raw-text="\mu = \frac{1}{n} \sum_{i=0}^{n-1} x_i" data-equation="eq:arithmetic_mean">
|
|
45
|
+
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@42d8f64d805113ab899c79c7c39d6c6bac7fe25c/lib/node_modules/@stdlib/stats/base/ndarray/mean/docs/img/equation_arithmetic_mean.svg" alt="Equation for the arithmetic mean.">
|
|
46
|
+
<br>
|
|
47
|
+
</div>
|
|
48
|
+
|
|
49
|
+
<!-- </equation> -->
|
|
50
|
+
|
|
51
|
+
</section>
|
|
52
|
+
|
|
53
|
+
<!-- /.intro -->
|
|
54
|
+
|
|
55
|
+
<section class="installation">
|
|
56
|
+
|
|
57
|
+
## Installation
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
npm install @stdlib/stats-base-ndarray-smeanlipw
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
</section>
|
|
64
|
+
|
|
65
|
+
<section class="usage">
|
|
66
|
+
|
|
67
|
+
## Usage
|
|
68
|
+
|
|
69
|
+
```javascript
|
|
70
|
+
var smeanlipw = require( '@stdlib/stats-base-ndarray-smeanlipw' );
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
#### smeanlipw( arrays )
|
|
74
|
+
|
|
75
|
+
Computes the [arithmetic mean][arithmetic-mean] of a one-dimensional single-precision floating-point ndarray using a one-pass trial mean algorithm with pairwise summation.
|
|
76
|
+
|
|
77
|
+
```javascript
|
|
78
|
+
var Float32Array = require( '@stdlib/array-float32' );
|
|
79
|
+
var ndarray = require( '@stdlib/ndarray-base-ctor' );
|
|
80
|
+
|
|
81
|
+
var xbuf = new Float32Array( [ 1.0, 3.0, 4.0, 2.0 ] );
|
|
82
|
+
var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
|
|
83
|
+
|
|
84
|
+
var v = smeanlipw( [ x ] );
|
|
85
|
+
// returns 2.5
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
The function has the following parameters:
|
|
89
|
+
|
|
90
|
+
- **arrays**: array-like object containing a one-dimensional input ndarray.
|
|
91
|
+
|
|
92
|
+
</section>
|
|
93
|
+
|
|
94
|
+
<!-- /.usage -->
|
|
95
|
+
|
|
96
|
+
<section class="notes">
|
|
97
|
+
|
|
98
|
+
## Notes
|
|
99
|
+
|
|
100
|
+
- If provided an empty one-dimensional ndarray, the function returns `NaN`.
|
|
101
|
+
- The underlying algorithm is a specialized case of Welford's algorithm. Similar to the method of assumed mean, the first ndarray element is used as a trial mean. The trial mean is subtracted from subsequent data values, and the average deviations used to adjust the initial guess. Accordingly, the algorithm's accuracy is best when data is **unordered** (i.e., the data is **not** sorted in either ascending or descending order such that the first value is an "extreme" value).
|
|
102
|
+
|
|
103
|
+
</section>
|
|
104
|
+
|
|
105
|
+
<!-- /.notes -->
|
|
106
|
+
|
|
107
|
+
<section class="examples">
|
|
108
|
+
|
|
109
|
+
## Examples
|
|
110
|
+
|
|
111
|
+
<!-- eslint no-undef: "error" -->
|
|
112
|
+
|
|
113
|
+
```javascript
|
|
114
|
+
var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
|
|
115
|
+
var ndarray = require( '@stdlib/ndarray-base-ctor' );
|
|
116
|
+
var ndarray2array = require( '@stdlib/ndarray-to-array' );
|
|
117
|
+
var smeanlipw = require( '@stdlib/stats-base-ndarray-smeanlipw' );
|
|
118
|
+
|
|
119
|
+
var xbuf = discreteUniform( 10, -50, 50, {
|
|
120
|
+
'dtype': 'float32'
|
|
121
|
+
});
|
|
122
|
+
var x = new ndarray( 'float32', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
|
|
123
|
+
console.log( ndarray2array( x ) );
|
|
124
|
+
|
|
125
|
+
var v = smeanlipw( [ x ] );
|
|
126
|
+
console.log( v );
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
</section>
|
|
130
|
+
|
|
131
|
+
<!-- /.examples -->
|
|
132
|
+
|
|
133
|
+
* * *
|
|
134
|
+
|
|
135
|
+
<section class="references">
|
|
136
|
+
|
|
137
|
+
## References
|
|
138
|
+
|
|
139
|
+
- Welford, B. P. 1962. "Note on a Method for Calculating Corrected Sums of Squares and Products." _Technometrics_ 4 (3). Taylor & Francis: 419–20. doi:[10.1080/00401706.1962.10490022][@welford:1962a].
|
|
140
|
+
- van Reeken, A. J. 1968. "Letters to the Editor: Dealing with Neely's Algorithms." _Communications of the ACM_ 11 (3): 149–50. doi:[10.1145/362929.362961][@vanreeken:1968a].
|
|
141
|
+
- Ling, Robert F. 1974. "Comparison of Several Algorithms for Computing Sample Means and Variances." _Journal of the American Statistical Association_ 69 (348). American Statistical Association, Taylor & Francis, Ltd.: 859–66. doi:[10.2307/2286154][@ling:1974a].
|
|
142
|
+
- Higham, Nicholas J. 1993. "The Accuracy of Floating Point Summation." _SIAM Journal on Scientific Computing_ 14 (4): 783–99. doi:[10.1137/0914050][@higham:1993a].
|
|
143
|
+
|
|
144
|
+
</section>
|
|
145
|
+
|
|
146
|
+
<!-- /.references -->
|
|
147
|
+
|
|
148
|
+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
|
|
149
|
+
|
|
150
|
+
<section class="related">
|
|
151
|
+
|
|
152
|
+
</section>
|
|
153
|
+
|
|
154
|
+
<!-- /.related -->
|
|
155
|
+
|
|
156
|
+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
<section class="main-repo" >
|
|
160
|
+
|
|
161
|
+
* * *
|
|
162
|
+
|
|
163
|
+
## Notice
|
|
164
|
+
|
|
165
|
+
This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
|
|
166
|
+
|
|
167
|
+
For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
|
|
168
|
+
|
|
169
|
+
#### Community
|
|
170
|
+
|
|
171
|
+
[![Chat][chat-image]][chat-url]
|
|
172
|
+
|
|
173
|
+
---
|
|
174
|
+
|
|
175
|
+
## License
|
|
176
|
+
|
|
177
|
+
See [LICENSE][stdlib-license].
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
## Copyright
|
|
181
|
+
|
|
182
|
+
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
|
|
183
|
+
|
|
184
|
+
</section>
|
|
185
|
+
|
|
186
|
+
<!-- /.stdlib -->
|
|
187
|
+
|
|
188
|
+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
|
189
|
+
|
|
190
|
+
<section class="links">
|
|
191
|
+
|
|
192
|
+
[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-ndarray-smeanlipw.svg
|
|
193
|
+
[npm-url]: https://npmjs.org/package/@stdlib/stats-base-ndarray-smeanlipw
|
|
194
|
+
|
|
195
|
+
[test-image]: https://github.com/stdlib-js/stats-base-ndarray-smeanlipw/actions/workflows/test.yml/badge.svg?branch=v0.1.0
|
|
196
|
+
[test-url]: https://github.com/stdlib-js/stats-base-ndarray-smeanlipw/actions/workflows/test.yml?query=branch:v0.1.0
|
|
197
|
+
|
|
198
|
+
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-ndarray-smeanlipw/main.svg
|
|
199
|
+
[coverage-url]: https://codecov.io/github/stdlib-js/stats-base-ndarray-smeanlipw?branch=main
|
|
200
|
+
|
|
201
|
+
<!--
|
|
202
|
+
|
|
203
|
+
[dependencies-image]: https://img.shields.io/david/stdlib-js/stats-base-ndarray-smeanlipw.svg
|
|
204
|
+
[dependencies-url]: https://david-dm.org/stdlib-js/stats-base-ndarray-smeanlipw/main
|
|
205
|
+
|
|
206
|
+
-->
|
|
207
|
+
|
|
208
|
+
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
|
|
209
|
+
[chat-url]: https://stdlib.zulipchat.com
|
|
210
|
+
|
|
211
|
+
[stdlib]: https://github.com/stdlib-js/stdlib
|
|
212
|
+
|
|
213
|
+
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
|
|
214
|
+
|
|
215
|
+
[umd]: https://github.com/umdjs/umd
|
|
216
|
+
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
|
|
217
|
+
|
|
218
|
+
[deno-url]: https://github.com/stdlib-js/stats-base-ndarray-smeanlipw/tree/deno
|
|
219
|
+
[deno-readme]: https://github.com/stdlib-js/stats-base-ndarray-smeanlipw/blob/deno/README.md
|
|
220
|
+
[umd-url]: https://github.com/stdlib-js/stats-base-ndarray-smeanlipw/tree/umd
|
|
221
|
+
[umd-readme]: https://github.com/stdlib-js/stats-base-ndarray-smeanlipw/blob/umd/README.md
|
|
222
|
+
[esm-url]: https://github.com/stdlib-js/stats-base-ndarray-smeanlipw/tree/esm
|
|
223
|
+
[esm-readme]: https://github.com/stdlib-js/stats-base-ndarray-smeanlipw/blob/esm/README.md
|
|
224
|
+
[branches-url]: https://github.com/stdlib-js/stats-base-ndarray-smeanlipw/blob/main/branches.md
|
|
225
|
+
|
|
226
|
+
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-ndarray-smeanlipw/main/LICENSE
|
|
227
|
+
|
|
228
|
+
[arithmetic-mean]: https://en.wikipedia.org/wiki/Arithmetic_mean
|
|
229
|
+
|
|
230
|
+
[@welford:1962a]: https://doi.org/10.1080/00401706.1962.10490022
|
|
231
|
+
|
|
232
|
+
[@vanreeken:1968a]: https://doi.org/10.1145/362929.362961
|
|
233
|
+
|
|
234
|
+
[@ling:1974a]: https://doi.org/10.2307/2286154
|
|
235
|
+
|
|
236
|
+
[@higham:1993a]: https://doi.org/10.1137/0914050
|
|
237
|
+
|
|
238
|
+
</section>
|
|
239
|
+
|
|
240
|
+
<!-- /.links -->
|
package/SECURITY.md
ADDED
package/dist/index.d.ts
ADDED
package/dist/index.js
ADDED
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
"use strict";var a=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var t=a(function(c,i){
|
|
2
|
+
var u=require('@stdlib/ndarray-base-numel-dimension/dist'),s=require('@stdlib/ndarray-base-stride/dist'),n=require('@stdlib/ndarray-base-offset/dist'),v=require('@stdlib/ndarray-base-data-buffer/dist'),q=require('@stdlib/stats-strided-smeanlipw/dist').ndarray;function d(e){var r=e[0];return q(u(r,0),v(r),s(r,0),n(r))}i.exports=d
|
|
3
|
+
});var m=t();module.exports=m;
|
|
4
|
+
/** @license Apache-2.0 */
|
|
5
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../lib/main.js", "../lib/index.js"],
|
|
4
|
+
"sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar numelDimension = require( '@stdlib/ndarray-base-numel-dimension' );\nvar getStride = require( '@stdlib/ndarray-base-stride' );\nvar getOffset = require( '@stdlib/ndarray-base-offset' );\nvar getData = require( '@stdlib/ndarray-base-data-buffer' );\nvar strided = require( '@stdlib/stats-strided-smeanlipw' ).ndarray;\n\n\n// MAIN //\n\n/**\n* Computes the arithmetic mean of a one-dimensional single-precision floating-point ndarray using a one-pass trial mean algorithm with pairwise summation.\n*\n* @param {ArrayLikeObject<Object>} arrays - array-like object containing an input ndarray\n* @returns {number} arithmetic mean\n*\n* @example\n* var Float32Array = require( '@stdlib/array-float32' );\n* var ndarray = require( '@stdlib/ndarray-base-ctor' );\n*\n* var xbuf = new Float32Array( [ 1.0, 3.0, 4.0, 2.0 ] );\n* var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );\n*\n* var v = smeanlipw( [ x ] );\n* // returns 2.5\n*/\nfunction smeanlipw( arrays ) {\n\tvar x = arrays[ 0 ];\n\treturn strided( numelDimension( x, 0 ), getData( x ), getStride( x, 0 ), getOffset( x ) ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = smeanlipw;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Compute the arithmetic mean of a one-dimensional single-precision floating-point ndarray using a one-pass trial mean algorithm with pairwise summation.\n*\n* @module @stdlib/stats-base-ndarray-smeanlipw\n*\n* @example\n* var Float32Array = require( '@stdlib/array-float32' );\n* var ndarray = require( '@stdlib/ndarray-base-ctor' );\n* var smeanlipw = require( '@stdlib/stats-base-ndarray-smeanlipw' );\n*\n* var xbuf = new Float32Array( [ 1.0, 3.0, 4.0, 2.0 ] );\n* var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );\n*\n* var v = smeanlipw( [ x ] );\n* // returns 2.5\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
|
|
5
|
+
"mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAiB,QAAS,sCAAuC,EACjEC,EAAY,QAAS,6BAA8B,EACnDC,EAAY,QAAS,6BAA8B,EACnDC,EAAU,QAAS,kCAAmC,EACtDC,EAAU,QAAS,iCAAkC,EAAE,QAqB3D,SAASC,EAAWC,EAAS,CAC5B,IAAIC,EAAID,EAAQ,CAAE,EAClB,OAAOF,EAASJ,EAAgBO,EAAG,CAAE,EAAGJ,EAASI,CAAE,EAAGN,EAAWM,EAAG,CAAE,EAAGL,EAAWK,CAAE,CAAE,CACzF,CAKAR,EAAO,QAAUM,IChBjB,IAAIG,EAAO,IAKX,OAAO,QAAUA",
|
|
6
|
+
"names": ["require_main", "__commonJSMin", "exports", "module", "numelDimension", "getStride", "getOffset", "getData", "strided", "smeanlipw", "arrays", "x", "main"]
|
|
7
|
+
}
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
<svg xmlns:xlink="http://www.w3.org/1999/xlink" width="12.99ex" height="7.343ex" style="vertical-align: -3.005ex;" viewBox="0 -1867.7 5592.7 3161.4" role="img" focusable="false" xmlns="http://www.w3.org/2000/svg" aria-labelledby="MathJax-SVG-1-Title">
|
|
2
|
+
<title id="MathJax-SVG-1-Title">mu equals StartFraction 1 Over n EndFraction sigma-summation Underscript i equals 0 Overscript n minus 1 Endscripts x Subscript i</title>
|
|
3
|
+
<defs aria-hidden="true">
|
|
4
|
+
<path stroke-width="1" id="E1-MJMATHI-3BC" d="M58 -216Q44 -216 34 -208T23 -186Q23 -176 96 116T173 414Q186 442 219 442Q231 441 239 435T249 423T251 413Q251 401 220 279T187 142Q185 131 185 107V99Q185 26 252 26Q261 26 270 27T287 31T302 38T315 45T327 55T338 65T348 77T356 88T365 100L372 110L408 253Q444 395 448 404Q461 431 491 431Q504 431 512 424T523 412T525 402L449 84Q448 79 448 68Q448 43 455 35T476 26Q485 27 496 35Q517 55 537 131Q543 151 547 152Q549 153 557 153H561Q580 153 580 144Q580 138 575 117T555 63T523 13Q510 0 491 -8Q483 -10 467 -10Q446 -10 429 -4T402 11T385 29T376 44T374 51L368 45Q362 39 350 30T324 12T288 -4T246 -11Q199 -11 153 12L129 -85Q108 -167 104 -180T92 -202Q76 -216 58 -216Z"></path>
|
|
5
|
+
<path stroke-width="1" id="E1-MJMAIN-3D" d="M56 347Q56 360 70 367H707Q722 359 722 347Q722 336 708 328L390 327H72Q56 332 56 347ZM56 153Q56 168 72 173H708Q722 163 722 153Q722 140 707 133H70Q56 140 56 153Z"></path>
|
|
6
|
+
<path stroke-width="1" id="E1-MJMAIN-31" d="M213 578L200 573Q186 568 160 563T102 556H83V602H102Q149 604 189 617T245 641T273 663Q275 666 285 666Q294 666 302 660V361L303 61Q310 54 315 52T339 48T401 46H427V0H416Q395 3 257 3Q121 3 100 0H88V46H114Q136 46 152 46T177 47T193 50T201 52T207 57T213 61V578Z"></path>
|
|
7
|
+
<path stroke-width="1" id="E1-MJMATHI-6E" d="M21 287Q22 293 24 303T36 341T56 388T89 425T135 442Q171 442 195 424T225 390T231 369Q231 367 232 367L243 378Q304 442 382 442Q436 442 469 415T503 336T465 179T427 52Q427 26 444 26Q450 26 453 27Q482 32 505 65T540 145Q542 153 560 153Q580 153 580 145Q580 144 576 130Q568 101 554 73T508 17T439 -10Q392 -10 371 17T350 73Q350 92 386 193T423 345Q423 404 379 404H374Q288 404 229 303L222 291L189 157Q156 26 151 16Q138 -11 108 -11Q95 -11 87 -5T76 7T74 17Q74 30 112 180T152 343Q153 348 153 366Q153 405 129 405Q91 405 66 305Q60 285 60 284Q58 278 41 278H27Q21 284 21 287Z"></path>
|
|
8
|
+
<path stroke-width="1" id="E1-MJSZ2-2211" d="M60 948Q63 950 665 950H1267L1325 815Q1384 677 1388 669H1348L1341 683Q1320 724 1285 761Q1235 809 1174 838T1033 881T882 898T699 902H574H543H251L259 891Q722 258 724 252Q725 250 724 246Q721 243 460 -56L196 -356Q196 -357 407 -357Q459 -357 548 -357T676 -358Q812 -358 896 -353T1063 -332T1204 -283T1307 -196Q1328 -170 1348 -124H1388Q1388 -125 1381 -145T1356 -210T1325 -294L1267 -449L666 -450Q64 -450 61 -448Q55 -446 55 -439Q55 -437 57 -433L590 177Q590 178 557 222T452 366T322 544L56 909L55 924Q55 945 60 948Z"></path>
|
|
9
|
+
<path stroke-width="1" id="E1-MJMATHI-69" d="M184 600Q184 624 203 642T247 661Q265 661 277 649T290 619Q290 596 270 577T226 557Q211 557 198 567T184 600ZM21 287Q21 295 30 318T54 369T98 420T158 442Q197 442 223 419T250 357Q250 340 236 301T196 196T154 83Q149 61 149 51Q149 26 166 26Q175 26 185 29T208 43T235 78T260 137Q263 149 265 151T282 153Q302 153 302 143Q302 135 293 112T268 61T223 11T161 -11Q129 -11 102 10T74 74Q74 91 79 106T122 220Q160 321 166 341T173 380Q173 404 156 404H154Q124 404 99 371T61 287Q60 286 59 284T58 281T56 279T53 278T49 278T41 278H27Q21 284 21 287Z"></path>
|
|
10
|
+
<path stroke-width="1" id="E1-MJMAIN-30" d="M96 585Q152 666 249 666Q297 666 345 640T423 548Q460 465 460 320Q460 165 417 83Q397 41 362 16T301 -15T250 -22Q224 -22 198 -16T137 16T82 83Q39 165 39 320Q39 494 96 585ZM321 597Q291 629 250 629Q208 629 178 597Q153 571 145 525T137 333Q137 175 145 125T181 46Q209 16 250 16Q290 16 318 46Q347 76 354 130T362 333Q362 478 354 524T321 597Z"></path>
|
|
11
|
+
<path stroke-width="1" id="E1-MJMAIN-2212" d="M84 237T84 250T98 270H679Q694 262 694 250T679 230H98Q84 237 84 250Z"></path>
|
|
12
|
+
<path stroke-width="1" id="E1-MJMATHI-78" d="M52 289Q59 331 106 386T222 442Q257 442 286 424T329 379Q371 442 430 442Q467 442 494 420T522 361Q522 332 508 314T481 292T458 288Q439 288 427 299T415 328Q415 374 465 391Q454 404 425 404Q412 404 406 402Q368 386 350 336Q290 115 290 78Q290 50 306 38T341 26Q378 26 414 59T463 140Q466 150 469 151T485 153H489Q504 153 504 145Q504 144 502 134Q486 77 440 33T333 -11Q263 -11 227 52Q186 -10 133 -10H127Q78 -10 57 16T35 71Q35 103 54 123T99 143Q142 143 142 101Q142 81 130 66T107 46T94 41L91 40Q91 39 97 36T113 29T132 26Q168 26 194 71Q203 87 217 139T245 247T261 313Q266 340 266 352Q266 380 251 392T217 404Q177 404 142 372T93 290Q91 281 88 280T72 278H58Q52 284 52 289Z"></path>
|
|
13
|
+
</defs>
|
|
14
|
+
<g stroke="currentColor" fill="currentColor" stroke-width="0" transform="matrix(1 0 0 -1 0 0)" aria-hidden="true">
|
|
15
|
+
<use xlink:href="#E1-MJMATHI-3BC" x="0" y="0"></use>
|
|
16
|
+
<use xlink:href="#E1-MJMAIN-3D" x="881" y="0"></use>
|
|
17
|
+
<g transform="translate(1659,0)">
|
|
18
|
+
<g transform="translate(397,0)">
|
|
19
|
+
<rect stroke="none" width="720" height="60" x="0" y="220"></rect>
|
|
20
|
+
<use xlink:href="#E1-MJMAIN-31" x="110" y="676"></use>
|
|
21
|
+
<use xlink:href="#E1-MJMATHI-6E" x="60" y="-686"></use>
|
|
22
|
+
</g>
|
|
23
|
+
</g>
|
|
24
|
+
<g transform="translate(3064,0)">
|
|
25
|
+
<use xlink:href="#E1-MJSZ2-2211" x="0" y="0"></use>
|
|
26
|
+
<g transform="translate(147,-1090)">
|
|
27
|
+
<use transform="scale(0.707)" xlink:href="#E1-MJMATHI-69" x="0" y="0"></use>
|
|
28
|
+
<use transform="scale(0.707)" xlink:href="#E1-MJMAIN-3D" x="345" y="0"></use>
|
|
29
|
+
<use transform="scale(0.707)" xlink:href="#E1-MJMAIN-30" x="1124" y="0"></use>
|
|
30
|
+
</g>
|
|
31
|
+
<g transform="translate(57,1151)">
|
|
32
|
+
<use transform="scale(0.707)" xlink:href="#E1-MJMATHI-6E" x="0" y="0"></use>
|
|
33
|
+
<use transform="scale(0.707)" xlink:href="#E1-MJMAIN-2212" x="600" y="0"></use>
|
|
34
|
+
<use transform="scale(0.707)" xlink:href="#E1-MJMAIN-31" x="1379" y="0"></use>
|
|
35
|
+
</g>
|
|
36
|
+
</g>
|
|
37
|
+
<g transform="translate(4675,0)">
|
|
38
|
+
<use xlink:href="#E1-MJMATHI-78" x="0" y="0"></use>
|
|
39
|
+
<use transform="scale(0.707)" xlink:href="#E1-MJMATHI-69" x="809" y="-213"></use>
|
|
40
|
+
</g>
|
|
41
|
+
</g>
|
|
42
|
+
</svg>
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* @license Apache-2.0
|
|
3
|
+
*
|
|
4
|
+
* Copyright (c) 2025 The Stdlib Authors.
|
|
5
|
+
*
|
|
6
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
7
|
+
* you may not use this file except in compliance with the License.
|
|
8
|
+
* You may obtain a copy of the License at
|
|
9
|
+
*
|
|
10
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
11
|
+
*
|
|
12
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
13
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
14
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
15
|
+
* See the License for the specific language governing permissions and
|
|
16
|
+
* limitations under the License.
|
|
17
|
+
*/
|
|
18
|
+
|
|
19
|
+
// TypeScript Version: 4.1
|
|
20
|
+
|
|
21
|
+
/// <reference types="@stdlib/types"/>
|
|
22
|
+
|
|
23
|
+
import { float32ndarray } from '@stdlib/types/ndarray';
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* Computes the arithmetic mean of a one-dimensional single-precision floating-point ndarray using a one-pass trial mean algorithm with pairwise summation.
|
|
27
|
+
*
|
|
28
|
+
* @param arrays - array-like object containing an input ndarray
|
|
29
|
+
* @returns arithmetic mean
|
|
30
|
+
*
|
|
31
|
+
* @example
|
|
32
|
+
* var Float32Array = require( '@stdlib/array-float32' );
|
|
33
|
+
* var ndarray = require( '@stdlib/ndarray-base-ctor' );
|
|
34
|
+
*
|
|
35
|
+
* var xbuf = new Float32Array( [ 1.0, 3.0, 4.0, 2.0 ] );
|
|
36
|
+
* var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
|
|
37
|
+
*
|
|
38
|
+
* var v = smeanlipw( [ x ] );
|
|
39
|
+
* // returns 2.5
|
|
40
|
+
*/
|
|
41
|
+
declare function smeanlipw( arrays: [ float32ndarray ] ): number;
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
// EXPORTS //
|
|
45
|
+
|
|
46
|
+
export = smeanlipw;
|
package/lib/index.js
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Apache-2.0
|
|
3
|
+
*
|
|
4
|
+
* Copyright (c) 2025 The Stdlib Authors.
|
|
5
|
+
*
|
|
6
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
7
|
+
* you may not use this file except in compliance with the License.
|
|
8
|
+
* You may obtain a copy of the License at
|
|
9
|
+
*
|
|
10
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
11
|
+
*
|
|
12
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
13
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
14
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
15
|
+
* See the License for the specific language governing permissions and
|
|
16
|
+
* limitations under the License.
|
|
17
|
+
*/
|
|
18
|
+
|
|
19
|
+
'use strict';
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
* Compute the arithmetic mean of a one-dimensional single-precision floating-point ndarray using a one-pass trial mean algorithm with pairwise summation.
|
|
23
|
+
*
|
|
24
|
+
* @module @stdlib/stats-base-ndarray-smeanlipw
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* var Float32Array = require( '@stdlib/array-float32' );
|
|
28
|
+
* var ndarray = require( '@stdlib/ndarray-base-ctor' );
|
|
29
|
+
* var smeanlipw = require( '@stdlib/stats-base-ndarray-smeanlipw' );
|
|
30
|
+
*
|
|
31
|
+
* var xbuf = new Float32Array( [ 1.0, 3.0, 4.0, 2.0 ] );
|
|
32
|
+
* var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
|
|
33
|
+
*
|
|
34
|
+
* var v = smeanlipw( [ x ] );
|
|
35
|
+
* // returns 2.5
|
|
36
|
+
*/
|
|
37
|
+
|
|
38
|
+
// MODULES //
|
|
39
|
+
|
|
40
|
+
var main = require( './main.js' );
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
// EXPORTS //
|
|
44
|
+
|
|
45
|
+
module.exports = main;
|
package/lib/main.js
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Apache-2.0
|
|
3
|
+
*
|
|
4
|
+
* Copyright (c) 2025 The Stdlib Authors.
|
|
5
|
+
*
|
|
6
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
7
|
+
* you may not use this file except in compliance with the License.
|
|
8
|
+
* You may obtain a copy of the License at
|
|
9
|
+
*
|
|
10
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
11
|
+
*
|
|
12
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
13
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
14
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
15
|
+
* See the License for the specific language governing permissions and
|
|
16
|
+
* limitations under the License.
|
|
17
|
+
*/
|
|
18
|
+
|
|
19
|
+
'use strict';
|
|
20
|
+
|
|
21
|
+
// MODULES //
|
|
22
|
+
|
|
23
|
+
var numelDimension = require( '@stdlib/ndarray-base-numel-dimension' );
|
|
24
|
+
var getStride = require( '@stdlib/ndarray-base-stride' );
|
|
25
|
+
var getOffset = require( '@stdlib/ndarray-base-offset' );
|
|
26
|
+
var getData = require( '@stdlib/ndarray-base-data-buffer' );
|
|
27
|
+
var strided = require( '@stdlib/stats-strided-smeanlipw' ).ndarray;
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
// MAIN //
|
|
31
|
+
|
|
32
|
+
/**
|
|
33
|
+
* Computes the arithmetic mean of a one-dimensional single-precision floating-point ndarray using a one-pass trial mean algorithm with pairwise summation.
|
|
34
|
+
*
|
|
35
|
+
* @param {ArrayLikeObject<Object>} arrays - array-like object containing an input ndarray
|
|
36
|
+
* @returns {number} arithmetic mean
|
|
37
|
+
*
|
|
38
|
+
* @example
|
|
39
|
+
* var Float32Array = require( '@stdlib/array-float32' );
|
|
40
|
+
* var ndarray = require( '@stdlib/ndarray-base-ctor' );
|
|
41
|
+
*
|
|
42
|
+
* var xbuf = new Float32Array( [ 1.0, 3.0, 4.0, 2.0 ] );
|
|
43
|
+
* var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
|
|
44
|
+
*
|
|
45
|
+
* var v = smeanlipw( [ x ] );
|
|
46
|
+
* // returns 2.5
|
|
47
|
+
*/
|
|
48
|
+
function smeanlipw( arrays ) {
|
|
49
|
+
var x = arrays[ 0 ];
|
|
50
|
+
return strided( numelDimension( x, 0 ), getData( x ), getStride( x, 0 ), getOffset( x ) ); // eslint-disable-line max-len
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
// EXPORTS //
|
|
55
|
+
|
|
56
|
+
module.exports = smeanlipw;
|
package/package.json
ADDED
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@stdlib/stats-base-ndarray-smeanlipw",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Compute the arithmetic mean of a one-dimensional single-precision floating-point ndarray using a one-pass trial mean algorithm with pairwise summation.",
|
|
5
|
+
"license": "Apache-2.0",
|
|
6
|
+
"author": {
|
|
7
|
+
"name": "The Stdlib Authors",
|
|
8
|
+
"url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
|
|
9
|
+
},
|
|
10
|
+
"contributors": [
|
|
11
|
+
{
|
|
12
|
+
"name": "The Stdlib Authors",
|
|
13
|
+
"url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
|
|
14
|
+
}
|
|
15
|
+
],
|
|
16
|
+
"main": "./lib",
|
|
17
|
+
"directories": {
|
|
18
|
+
"doc": "./docs",
|
|
19
|
+
"lib": "./lib",
|
|
20
|
+
"dist": "./dist"
|
|
21
|
+
},
|
|
22
|
+
"types": "./docs/types",
|
|
23
|
+
"scripts": {},
|
|
24
|
+
"homepage": "https://stdlib.io",
|
|
25
|
+
"repository": {
|
|
26
|
+
"type": "git",
|
|
27
|
+
"url": "git://github.com/stdlib-js/stats-base-ndarray-smeanlipw.git"
|
|
28
|
+
},
|
|
29
|
+
"bugs": {
|
|
30
|
+
"url": "https://github.com/stdlib-js/stdlib/issues"
|
|
31
|
+
},
|
|
32
|
+
"dependencies": {
|
|
33
|
+
"@stdlib/ndarray-base-data-buffer": "^0.2.2",
|
|
34
|
+
"@stdlib/ndarray-base-numel-dimension": "^0.3.2",
|
|
35
|
+
"@stdlib/ndarray-base-offset": "^0.2.2",
|
|
36
|
+
"@stdlib/ndarray-base-stride": "^0.2.2",
|
|
37
|
+
"@stdlib/stats-strided-smeanlipw": "^0.1.0"
|
|
38
|
+
},
|
|
39
|
+
"devDependencies": {},
|
|
40
|
+
"engines": {
|
|
41
|
+
"node": ">=0.10.0",
|
|
42
|
+
"npm": ">2.7.0"
|
|
43
|
+
},
|
|
44
|
+
"os": [
|
|
45
|
+
"aix",
|
|
46
|
+
"darwin",
|
|
47
|
+
"freebsd",
|
|
48
|
+
"linux",
|
|
49
|
+
"macos",
|
|
50
|
+
"openbsd",
|
|
51
|
+
"sunos",
|
|
52
|
+
"win32",
|
|
53
|
+
"windows"
|
|
54
|
+
],
|
|
55
|
+
"keywords": [
|
|
56
|
+
"stdlib",
|
|
57
|
+
"stdmath",
|
|
58
|
+
"statistics",
|
|
59
|
+
"stats",
|
|
60
|
+
"mathematics",
|
|
61
|
+
"math",
|
|
62
|
+
"average",
|
|
63
|
+
"avg",
|
|
64
|
+
"central tendency",
|
|
65
|
+
"mean",
|
|
66
|
+
"arithmetic mean",
|
|
67
|
+
"expected value",
|
|
68
|
+
"trial",
|
|
69
|
+
"ling",
|
|
70
|
+
"pairwise",
|
|
71
|
+
"pw",
|
|
72
|
+
"ndarray",
|
|
73
|
+
"float",
|
|
74
|
+
"flt",
|
|
75
|
+
"float32",
|
|
76
|
+
"float32array"
|
|
77
|
+
],
|
|
78
|
+
"funding": {
|
|
79
|
+
"type": "opencollective",
|
|
80
|
+
"url": "https://opencollective.com/stdlib"
|
|
81
|
+
}
|
|
82
|
+
}
|