Skip to main content
POST
/
quantlib
/
physics
/
entropy
/
mutual-information
curl --request POST \
  --url https://finceptbackend.share.zrok.io/quantlib/physics/entropy/mutual-information \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "joint_prob": [
    [
      0.45,
      0.05,
      0
    ],
    [
      0.05,
      0.4,
      0.05
    ],
    [
      0,
      0,
      0
    ]
  ],
  "base": 2.718281828459045
}
'
{
  "success": true,
  "data": {
    "mutual_information": 0.5623
  }
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication. Get your key at https://finceptbackend.share.zrok.io/auth/register

Body

application/json
​
joint_prob
number[][]
required

Joint probability matrix (must sum to 1)

Example:
[
  [0.4, 0.1, 0.05],
  [0.05, 0.3, 0.05],
  [0.02, 0.01, 0.02]
]
​
base
number
default:2.718281828459045

Logarithm base for information calculation

Example:

2.718281828459045

Response

Mutual information calculated successfully

​
success
boolean
Example:

true

​
data
object