AssociationPairOutput (bayesserver 11.1 API)

java.lang.Object
- com.bayesserver.analysis.AssociationPairOutput

```
public final class AssociationPairOutput
extends Object
```
Contains the results of the association calculations between two sets of variables.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Double`	`getEntropyX()`	Gets the entropy for X.
`Double`	`getEntropyY()`	Gets the entropy for Y.
`Double`	`getMutualInformation()`	Gets the mutual information between X and Y, denoted I(X;Y).
`AssociationPair`	`getPair()`	Gets the pair (X, Y) that these association results are calculated for.
`Double`	`getProficiencyXGivenY()`	Gets the proficiency (uncertainty coefficient) U(X\|Y) = I(X;Y) / H(X).
`Double`	`getProficiencyYGivenX()`	Gets the proficiency (uncertainty coefficient) U(Y\|X) = I(X;Y) / H(Y).
`Double`	`getSymmetricMutualInformation()`	Gets a normalized version of the mutual information called the 'symmetric uncertainty' between X and Y.

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

- Method Detail
  - getPair
```
public AssociationPair getPair()
```
    Gets the pair (X, Y) that these association results are calculated for.
  - getSymmetricMutualInformation
```
public Double getSymmetricMutualInformation()
```
    Gets a normalized version of the mutual information called the 'symmetric uncertainty' between X and Y. 2 * I(X,Y) / (H(X) + H(Y))
  - getProficiencyXGivenY
```
public Double getProficiencyXGivenY()
```
    Gets the proficiency (uncertainty coefficient) U(X|Y) = I(X;Y) / H(X). This quantifies how much knowing Y can reduce the uncertainty in X.
  - getProficiencyYGivenX
```
public Double getProficiencyYGivenX()
```
    Gets the proficiency (uncertainty coefficient) U(Y|X) = I(X;Y) / H(Y). This quantifies how much knowing X can reduce the uncertainty in Y.
  - getMutualInformation
```
public Double getMutualInformation()
```
    Gets the mutual information between X and Y, denoted I(X;Y).
  - getEntropyX
```
public Double getEntropyX()
```
    Gets the entropy for X.
  - getEntropyY
```
public Double getEntropyY()
```
    Gets the entropy for Y.