Delila Program: surprisal

surprisal program

Documentation for the surprisal program is below, with links to related programs in the "see also" section.

{version = 1.00; (* of surprisal.p 2000 January 10}

(* begin module describe.divide *)
(*
name
   surprisal: make the surprisal curve for a histogram

synopsis
   surprisal(histog: in, surprisalp: in, xyin: out, output: out)

files
   histog:  position and number

   xyin: Columns generated by the surprisal program:
      1: position
      2: -log2(frequency), surprisal in bits
      3: frequency
      4: original count in this bin

   surprisalp:  parameters to control the program.  The file must contain the
      following parameters, one per line:

      parameterversion: The version number of the program.  This allows the
         user to be warned if an old parameter file is used.

   output: messages to the user

description

   Convert a histogram into a surprisal curve by finding the sum of the
   values in the histogram, converting the histogram to frequencies and
   taking the negative log base two of each frequency.

examples

documentation

see also
   to generate the histog, use: genhis.p
   to plot the result, use: xyplo.p

author
   Thomas Dana Schneider

bugs

technical notes

*)
(* end module describe.surprisal *)
{This manual page was created by makman 1.44}
{created by htmlink 1.55}
National Cancer Institute    National Institutes of Health    Health and Human Services    USA Gov - Official Web Portal    Viewing Files    Accessibility