Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Entropy

Calculates entropy, joint entropy or conditional entropy, which can be used to determine the uncertainty in the states of a discrete distribution.

A higher values indicates less certainty about being in a particular state.

Hierarchy

  • Entropy

Index

Methods

Methods

Static calculate

  • Measures the uncertainty of a distribution.

    Parameters

    • joint: IDistribution

      The marginal or joint distribution.

    • logarithmBase: LogarithmBase

      The logarithm base to use for the calculations.

    Returns number

    The entropy value.

  • Measures the uncertainty of a distribution conditional on one or more variables.

    Parameters

    • joint: IDistribution

      The marginal or joint distribution.

    • conditionOn: IList<VariableContext>

      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 number

    The entropy value.

  • Measures the uncertainty of a distribution conditional on one or more variables.

    Parameters

    • joint: Table

      The marginal or joint distribution.

    • conditionOn: IList<VariableContext>

      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 number

    The entropy value.

  • Measures the uncertainty of a distribution.

    Parameters

    • joint: Table

      The marginal or joint distribution.

    • logarithmBase: LogarithmBase

      The logarithm base to use for the calculations.

    Returns number

    The entropy value.

  • Measures the uncertainty of a distribution conditional on one or more variables.

    Parameters

    • joint: CLGaussian

      The marginal or joint distribution.

    • conditionOn: IList<VariableContext>

      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 number

    The entropy value.

  • Measures the uncertainty of a distribution.

    Parameters

    • joint: CLGaussian

      The marginal or joint distribution.

    • logarithmBase: LogarithmBase

      The logarithm base to use for the calculations.

    Returns number

    The entropy value.