harmmean — Compute the harmonic mean of numeric data.
harmmean(X) computes the harmonic mean along the first non-singleton dimension. Dimension, vector-dimension, "all", "includenan", and "omitnan" forms are supported.
Syntax
Y = harmmean(X)
Y = harmmean(X, dim)
Y = harmmean(X, dim, nanflag)Inputs
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X | Any | Yes | — | Input data array. |
dim | Any | No | — | Dimension, dimension vector, or "all" selector. |
options | Any | Variadic | — | Optional dimension and missing-value arguments. |
Returns
| Name | Type | Description |
|---|---|---|
Y | NumericArray | Computed statistic. |
Errors
| Identifier | When | Message |
|---|---|---|
RunMat:harmmean:InvalidArgument | Inputs, flags, dimensions, or options are malformed. | descriptive statistics: invalid argument |
RunMat:harmmean:Internal | Internal tensor conversion or allocation fails. | descriptive statistics: internal error |
How harmmean works
- NaNs are included by default.
"omitnan"skips NaNs in each slice; empty slices returnNaN.- A zero in a slice produces a zero harmonic mean for that slice.
- Numeric and logical inputs are promoted to double precision.
Example
Harmonic mean across all values
m = harmmean([1 2 4], "all")Using harmmean with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how harmmean changes the result.
Run a small harmmean example, explain the result, then change one input and compare the output.
FAQ
Can I reduce over several dimensions?⌄
Yes. Pass a dimension vector such as harmmean(X,[1 3]).
Related Stats functions
Summary
binocdf · boxplot · cdf · cdfplot · chi2cdf · corr · corrcoef · corrcov · cov · cov2corr · dummyvar · ecdf · filloutliers · fitdist · geomean · grpstats · icdf · isoutlier · kstest · kurtosis · lsline · mad · mode · nanmax · normalize · normcdf · norminv · normpdf · onehotdecode · onehotencode · pdf · prctile · quantile · refline · rmse · skewness · tabulate · tcdf · tiedrank · tinv · tpdf · ttest2 · wblinv
Ml
bayesopt · classify · confusionmat · crossvalind · cvpartition · fitclinear · fitctree · fitlm · kmeans · knnsearch · lasso · lassoglm · linkage · lscov · mnrfit · optimizableVariable · pdist · pdist2 · perfcurve · predict · regress · ridge · squareform · test · training · tsne
Random
binornd · bootstrp · datasample · dividerand · exprnd · gamrnd · lhsdesign · mvnrnd · normrnd · random · randsample · rng · trnd · unidrnd · unifrnd · wblrnd
Hist
Open-source implementation
Unlike proprietary runtimes, every RunMat function is open-source. Read exactly how harmmean is executed, line by line, in Rust.
- View the source for harmmean in Rust on GitHub
- Learn how the RunMat runtime works
- Found a bug? Open an issue with a minimal reproduction.
About RunMat
RunMat is an open-source runtime that executes MATLAB-syntax code blazing on any GPU. It is licensed under the Apache 2.0 license.
- RunMat automatically optimizes your math for GPU execution on Apple, Nvidia, and AMD hardware. No code changes needed. Simulations that took hours now take minutes.
- Start running code in seconds. RunMat runs in the browser, on the desktop, or from the CLI. No license server, no IT ticket.