WilcoxonSignedRankTest.Result

java.lang.Object
- org.apache.commons.statistics.inference.BaseSignificanceResult
- - org.apache.commons.statistics.inference.WilcoxonSignedRankTest.Result

All Implemented Interfaces:

SignificanceResult

Enclosing class:

WilcoxonSignedRankTest
```
public static final class WilcoxonSignedRankTest.Result
extends BaseSignificanceResult
```
Result for the Wilcoxon signed-rank test.
This class is immutable.

Since:

1.1

Field Summary

Fields
Modifier and Type Field Description

private boolean tiedValues
Flag indicating the data had tied values.

private boolean zeroValues
Flag indicating the data had zero values.

Constructor Summary

Constructors
Constructor Description

Result(double statistic, boolean tiedValues, boolean zeroValues, double p)
Create an instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`hasTiedValues()`	Return `true` if the data had tied values (with equal ranks).
`boolean`	`hasZeroValues()`	Return `true` if the data had zero values.

Methods inherited from class org.apache.commons.statistics.inference.BaseSignificanceResult
getPValue, getStatistic

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.commons.statistics.inference.SignificanceResult
reject

- Field Detail
  - tiedValues
```
private final boolean tiedValues
```
    Flag indicating the data had tied values.
  - zeroValues
```
private final boolean zeroValues
```
    Flag indicating the data had zero values.
- Constructor Detail
  - Result
```
Result(double statistic,
       boolean tiedValues,
       boolean zeroValues,
       double p)
```
    Create an instance.
    
    Parameters:
    
    statistic - Test statistic.
    
    tiedValues - Flag indicating the data had tied values.
    
    zeroValues - Flag indicating the data had zero values.
    
    p - Result p-value.
- Method Detail
  - hasTiedValues
```
public boolean hasTiedValues()
```
    Return true if the data had tied values (with equal ranks).
    Note: The exact computation cannot be used when there are tied values. The p-value uses the asymptotic approximation using a tie correction.
    
    Returns:
    
    true if there were tied values
  - hasZeroValues
```
public boolean hasZeroValues()
```
    Return true if the data had zero values. This occurs when the differences between sample values matched the expected location shift: z = x - y == mu.
    Note: The exact computation cannot be used when there are zero values. The p-value uses the asymptotic approximation.
    
    Returns:
    
    true if there were zero values