API reference#
Categories [0]–[10] preserve the order used by the
SHT reference. Categories
[11]–[12] contain pySHT-native independence and circular-data methods. The R
crosswalk remains limited to SHT identities; native additions have their own
catalog. The candidate catalog contains 72
canonical public functions, including 21 validated pySHT-native additions.
Every public function uses lowercase
snake_case, lives in its scientific module, and is not re-exported from
top-level pysht.
[0] Utilities#
SHT’s usek1d and useknd adapters have no Python counterpart. Python
functions can be passed and called directly.
[1] Tests for Univariate Mean#
Function |
Purpose |
|---|---|
One population mean |
|
Two independent or paired means |
|
Two or more independent means |
[2] Tests for Multivariate Mean#
Function |
Purpose |
|---|---|
One-sample Hotelling test |
|
Independent or paired Hotelling test |
|
Dempster mean tests |
|
Bai–Saranadasa tests |
|
Srivastava–Du tests |
|
Yao unequal-covariance test |
|
Johansen unequal-covariance test |
|
Nel–Van der Merwe test |
|
Krishnamoorthy–Yu test |
|
Random-projection test |
|
Random-subspace test |
|
Chen–Qin dense high-dimensional test |
|
Li fixed-small-sample tests |
|
Lee–You–Lin maximum pairwise log Bayes factor |
|
Schott multi-sample test |
|
Zhang–Xu transformed test |
|
Cao–Park–He test |
[3] Tests for Variance#
Function |
Purpose |
|---|---|
One normal-population variance |
|
Two normal-population variances |
|
Normal-population variance homogeneity |
|
Spread around group means |
|
Spread around group medians |
[4] Tests for Covariance#
Function |
Purpose |
|---|---|
Wu–Li random-projection tests |
|
Chen–Zhang–Zhong identity test |
|
Chen–Zhang–Zhong sphericity test |
|
Li–Chen dense covariance test |
|
Cai–Liu–Xia sparse maximum test |
|
Lee–You–Lin known-zero-mean log Bayes factor |
|
Fixed-dimensional covariance homogeneity |
|
High-dimensional covariance homogeneity |
[5] Simultaneous Tests for Mean and Variance#
Function |
Purpose |
|---|---|
One normal mean and variance jointly |
|
Pearson–Neyman approximation |
|
Perng–Littell component combination |
|
Corrected likelihood-ratio approximation |
|
Exact Zhang–Xu–Chen calibration |
|
Asymptotic two-sample LRT |
[6] Simultaneous Tests for Mean and Covariance#
Function |
Purpose |
|---|---|
High-dimensional one-sample joint test |
|
Classical one-sample joint LRT |
|
High-dimensional two-sample joint test |
[7] Tests for Equality of Distributions#
Function |
Purpose |
|---|---|
Biswas–Ghosh two-sample test |
|
DISCO/energy multi-sample test |
|
Characteristic-kernel MMD test |
[8] Goodness-of-Fit: Normal Distribution#
Function |
Purpose |
|---|---|
Shapiro normality tests |
|
|
Moment normality tests |
Multivariate Henze–Zirkler test |
|
Multivariate energy test |
[9] Goodness-of-Fit: Uniform Distribution#
Function |
Purpose |
|---|---|
Yang–Modarres interpoint test |
|
Yang–Modarres quantile test |
|
EHY nearest-neighbor rectangular-uniformity test |
[10] Tests on Special Domains#
Function |
Purpose |
|---|---|
Dirichlet-alternative simplex-uniformity LRT |
|
Omnibus EHY simplex-uniformity test |
|
Alpha-transformed compositional equality test |
[11] Independence#
Function |
Purpose |
|---|---|
Distance-covariance pairwise independence |
|
Kernel pairwise independence |
|
Kernel joint independence of two or more blocks |
|
Distance-multivariance mutual independence |
[12] Circular Data#
Function |
Purpose |
|---|---|
First-harmonic circular non-uniformity |
|
Watson \(U^2\) omnibus circular uniformity |
|
Modified Hermans–Rasson omnibus test |
|
Circular multi-sample equality |
Correctness-gated research candidates#
Ball Divergence, the Xue–Yao mean test, and the Yu–Li–Xue covariance combination have private research implementations but no public callable because their planned finite-resampling or joint-component calibration did not pass the release gate. The JWJWZ covariance and YLXL joint procedures remain formula-audit targets with no callable. A blocked method is never replaced by a silent fallback.
Result objects#
Every public test returns an immutable
StatisticalTestResult subtype. Frequentist tests report a
statistic and p-value; resampling results add exactness and Monte Carlo
diagnostics. The two maximum-pairwise-Bayes-factor functions instead report
maximum and component log Bayes factors and have no p-value.
For R names, years, and expanded acronyms, use the migration crosswalk, the method-name glossary, and the native-method catalog.