rinform (version 1.0.2)

shannon_mutual_info: Shannon Mutual Information

Description

Compute the base-b mutual information between two random variables.

Usage

shannon_mutual_info(p_xy, p_x, p_y, b = 2)

Arguments

p_xy

Dist specifying the joint distribution.

p_x

Dist specifying the x-marginal distribution.

p_y

Dist specifying the y-marginal distribution.

b

Numeric giving the base of the logarithm.

Value

Numeric giving the Shannon mutual information.

Examples

# NOT RUN {
xy <- Dist(c(10, 70, 15, 5))
x  <- Dist(c(80, 20))
y  <- Dist(c(25, 75))
shannon_mutual_info(xy, x, y)           # 0.2141709
shannon_mutual_info(xy, x, y, b = 3)    # 0.1351268
shannon_mutual_info(xy, x, y, b = 0)    # 0

# }