Class MutualInformation

Static calculate

• calculate(joint: IDistribution, x: VariableContext, y: VariableContext, logarithmBase: LogarithmBase): number
• calculate(joint: IDistribution, x: VariableContext, y: VariableContext, conditionOn: IList<VariableContext>, logarithmBase: LogarithmBase): number
• calculate(joint: IDistribution, x: IList<VariableContext>, y: IList<VariableContext>, conditionOn: IList<VariableContext>, logarithmBase: LogarithmBase): number

• Measures the dependence between two variables.

  Parameters

  • joint: IDistribution

    The joint distribution over two (head) variables.

  • x: VariableContext

    X in the expression I(X,Y).

  • y: VariableContext

    Y in the expression I(X,Y).

  • logarithmBase: LogarithmBase

    The logarithm base to use for the calculations.

  Returns number

  The mutual information value.

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

  Parameters

  • joint: IDistribution

    The joint distribution over two or more variables.

  • x: VariableContext

    X in the expression I(X,Y) or I(X,Y|Z).

  • y: VariableContext

    Y in the expression I(X,Y) or I(X,Y|Z).

  • conditionOn: IList<VariableContext>

    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 number

  The mutual information value.

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

  Parameters

  • joint: IDistribution

    The joint distribution over two or more variables.

  • x: IList<VariableContext>

    X in the expression I(X,Y) or I(X,Y|Z).

  • y: IList<VariableContext>

    Y in the expression I(X,Y) or I(X,Y|Z).

  • conditionOn: IList<VariableContext>

    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 number

  The mutual information value.