Class Entropy
Calculates entropy, joint entropy or conditional entropy, which can be used to determine the uncertainty in the states of a discrete distribution.
Inheritance
Inherited Members
Namespace: BayesServer.Statistics
Assembly: BayesServer.Statistics.dll
Syntax
public static class Entropy
Remarks
A higher values indicates less certainty about being in a particular state.
Methods
Calculate(CLGaussian, LogarithmBase)
Measures the uncertainty of a distribution.
Declaration
public static double Calculate(CLGaussian joint, LogarithmBase logarithmBase)
Parameters
Type | Name | Description |
---|---|---|
CLGaussian | joint | The marginal or joint distribution. |
LogarithmBase | logarithmBase | The logarithm base to use for the calculations. |
Returns
Type | Description |
---|---|
System.Double | The entropy value. |
Calculate(CLGaussian, IList<VariableContext>, LogarithmBase)
Measures the uncertainty of a distribution conditional on one or more variables.
Declaration
public static double Calculate(CLGaussian joint, IList<VariableContext> conditionOn, LogarithmBase logarithmBase)
Parameters
Type | Name | Description |
---|---|---|
CLGaussian | joint | The marginal or joint distribution. |
System.Collections.Generic.IList<VariableContext> | conditionOn | Any conditional variables. I.e. those on the right hand side of H(Y|X) when calculating conditional entropy. |
LogarithmBase | logarithmBase | The logarithm base to use for the calculations. |
Returns
Type | Description |
---|---|
System.Double | The entropy value. |
Calculate(IDistribution, LogarithmBase)
Measures the uncertainty of a distribution.
Declaration
public static double Calculate(IDistribution joint, LogarithmBase logarithmBase)
Parameters
Type | Name | Description |
---|---|---|
IDistribution | joint | The marginal or joint distribution. |
LogarithmBase | logarithmBase | The logarithm base to use for the calculations. |
Returns
Type | Description |
---|---|
System.Double | The entropy value. |
Calculate(IDistribution, IList<VariableContext>, LogarithmBase)
Measures the uncertainty of a distribution conditional on one or more variables.
Declaration
public static double Calculate(IDistribution joint, IList<VariableContext> conditionOn, LogarithmBase logarithmBase)
Parameters
Type | Name | Description |
---|---|---|
IDistribution | joint | The marginal or joint distribution. |
System.Collections.Generic.IList<VariableContext> | conditionOn | Any conditional variables. I.e. those on the right hand side of H(Y|X) when calculating conditional entropy. |
LogarithmBase | logarithmBase | The logarithm base to use for the calculations. |
Returns
Type | Description |
---|---|
System.Double | The entropy value. |
Calculate(Table, LogarithmBase)
Measures the uncertainty of a distribution.
Declaration
public static double Calculate(Table joint, LogarithmBase logarithmBase)
Parameters
Type | Name | Description |
---|---|---|
Table | joint | The marginal or joint distribution. |
LogarithmBase | logarithmBase | The logarithm base to use for the calculations. |
Returns
Type | Description |
---|---|
System.Double | The entropy value. |
Calculate(Table, IList<VariableContext>, LogarithmBase)
Measures the uncertainty of a distribution conditional on one or more variables.
Declaration
public static double Calculate(Table joint, IList<VariableContext> conditionOn, LogarithmBase logarithmBase)
Parameters
Type | Name | Description |
---|---|---|
Table | joint | The marginal or joint distribution. |
System.Collections.Generic.IList<VariableContext> | conditionOn | Any conditional variables. I.e. those on the right hand side of H(Y|X) when calculating conditional entropy. |
LogarithmBase | logarithmBase | The logarithm base to use for the calculations. |
Returns
Type | Description |
---|---|
System.Double | The entropy value. |