Skip to content

Commit

Permalink
Updated header for info_theory.hpp
Browse files Browse the repository at this point in the history
  • Loading branch information
mercere99 committed Jul 20, 2021
1 parent 1cc3d19 commit dd214d1
Showing 1 changed file with 22 additions and 20 deletions.
42 changes: 22 additions & 20 deletions include/emp/math/info_theory.hpp
Original file line number Diff line number Diff line change
@@ -1,23 +1,25 @@
// This file is part of Empirical, https://github.com/devosoft/Empirical
// Copyright (C) Michigan State University, 2016-2017.
// Released under the MIT Software license; see doc/LICENSE
//
//
// Tools to calculate Information Theory metrics.
// Status: ALPHA
//
//
// Info-theory formulas:
// H(X) = -SUM(X: p[x] log2 p[x])
// H(X|Y) = H(XY) - H(Y)
// I(X:Y) = H(X) - H(X|Y)
// H2(p) = -p log2(p) - (1-p)log2(1-p) = H({p, 1-p})
//
// Developer notes:
// * Input may come as WEIGHTS or as ELEMENTS (or both!).
// ELEMENTS need to be converted to WEIGHTS for calculations.
// * Want basic info theory functions, as well as tools (for channels, error-correction,
// compression, etc.)
/**
* @note This file is part of Empirical, https://github.com/devosoft/Empirical
* @copyright Copyright (C) Michigan State University, MIT Software license; see doc/LICENSE.md
* @date 2021.
*
* @file info_theory.hpp
* @brief Tools to calculate Information Theory metrics.
* @note Status: ALPHA
*
* Info-theory formulas:
* H(X) = -SUM(X: p[x] log2 p[x])
* H(X|Y) = H(XY) - H(Y)
* I(X:Y) = H(X) - H(X|Y)
* H2(p) = -p log2(p) - (1-p)log2(1-p) = H({p, 1-p})
*
* Developer notes:
* - Input may come as WEIGHTS or as ELEMENTS (or both!).
* ELEMENTS need to be converted to WEIGHTS for calculations.
* - Want basic info theory functions, as well as tools (for channels, error-correction,
* compression, etc.)
*/


#ifndef EMP_INFO_THEORY_H
#define EMP_INFO_THEORY_H
Expand Down

0 comments on commit dd214d1

Please sign in to comment.