/shannon-entropy

A rust library to calculate the shannon entropy of a string.

Primary LanguageRustApache License 2.0Apache-2.0

Build Status Coverage Status

shannon-entropy

A rust library to calculate the Shannon entropy of a string.

Usage

Available on crates.io

Add this to your Cargo.toml

[dependencies]
shannon-entropy = "0.2"

Example

fn main() {
  let test_strings = vec![
                          ("hello world", 2.8453512),
                          ("hello worldd", 2.8553884),
                          ("a", 0.0),
                          ("", 0.0),
                          ];

  for (test, answer) in test_strings {
      let entropy: f32 = shannon_entropy(test);
      assert_eq!(entropy, answer);
  }  
}