Class MutualInformation

Calculates mutual information or conditional mutual information, which measures the dependence between two variables.

Inheritance

System.Object

MutualInformation

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: BayesServer.Statistics

Assembly: BayesServer.Statistics.dll

Syntax

public static class MutualInformation

Methods

Calculate(IDistribution, VariableContext, VariableContext, LogarithmBase)

Measures the dependence between two variables.

Declaration

public static double Calculate(IDistribution joint, VariableContext x, VariableContext y, LogarithmBase logarithmBase)

Parameters

Type	Name	Description
IDistribution	joint	The joint distribution over two (head) variables.
VariableContext	x	X in the expression I(X,Y).
VariableContext	y	Y in the expression I(X,Y).
LogarithmBase	logarithmBase	The logarithm base to use for the calculations.

Returns

Type	Description
System.Double	The mutual information value.

Calculate(IDistribution, VariableContext, VariableContext, IList<VariableContext>, LogarithmBase)

Calculates mutual information or conditional mutual information, which measures the dependence between two variables.

Declaration

public static double Calculate(IDistribution joint, VariableContext x, VariableContext y, IList<VariableContext> conditionOn, LogarithmBase logarithmBase)

Parameters

Type	Name	Description
IDistribution	joint	The joint distribution over two or more variables.
VariableContext	x	X in the expression I(X,Y) or I(X,Y|Z).
VariableContext	y	Y in the expression I(X,Y) or I(X,Y|Z).
System.Collections.Generic.IList<VariableContext>	conditionOn	Any conditional variables. I.e. Z in the expression I(X,Y|Z) when calculating conditional mutual information.
LogarithmBase	logarithmBase	The logarithm base to use for the calculations.

Returns

Type	Description
System.Double	The mutual information value.

Calculate(IDistribution, IList<VariableContext>, IList<VariableContext>, IList<VariableContext>, LogarithmBase)

Calculates mutual information or conditional mutual information, which measures the dependence between two variables.

Declaration

public static double Calculate(IDistribution joint, IList<VariableContext> x, IList<VariableContext> y, IList<VariableContext> conditionOn, LogarithmBase logarithmBase)

Parameters

Type	Name	Description
IDistribution	joint	The joint distribution over two or more variables.
System.Collections.Generic.IList<VariableContext>	x	X in the expression I(X,Y) or I(X,Y|Z).
System.Collections.Generic.IList<VariableContext>	y	Y in the expression I(X,Y) or I(X,Y|Z).
System.Collections.Generic.IList<VariableContext>	conditionOn	Any conditional variables. I.e. Z in the expression I(X,Y|Z) when calculating conditional mutual information.
LogarithmBase	logarithmBase	The logarithm base to use for the calculations.

Returns

Type	Description
System.Double	The mutual information value.