chiark - git - mdw - catacomb/blob - maurer.h

   1 /* -*-c-*-
   2  *
   3  * $Id: maurer.h,v 1.1 2000/06/17 11:29:49 mdw Exp $
   4  *
   5  * Maurer's universal statistical test
   6  *
   7  * (c) 2000 Straylight/Edgeware
   8  */
   9
  10 /*----- Licensing notice --------------------------------------------------*
  11  *
  12  * This file is part of Catacomb.
  13  *
  14  * Catacomb is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU Library General Public License as
  16  * published by the Free Software Foundation; either version 2 of the
  17  * License, or (at your option) any later version.
  18  *
  19  * Catacomb is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Library General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU Library General Public
  25  * License along with Catacomb; if not, write to the Free
  26  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  27  * MA 02111-1307, USA.
  28  */
  29
  30 /*----- Revision history --------------------------------------------------*
  31  *
  32  * $Log: maurer.h,v $
  33  * Revision 1.1  2000/06/17 11:29:49  mdw
  34  * Maurer's universal statistical test.
  35  *
  36  */
  37
  38 #ifndef CATACOMB_MAURER_H
  39 #define CATACOMB_MAURER_H
  40
  41 #ifdef __cplusplus
  42   extern "C" {
  43 #endif
  44
  45 /*----- Header files ------------------------------------------------------*/
  46
  47 #include <mLib/bits.h>
  48
  49 /*----- Functions provided ------------------------------------------------*/
  50
  51 /* --- @maurer@ --- *
  52  *
  53  * Arguments:   @const octet *p@ = pointer to a buffer of data
  54  *              @size_t sz@ = size of the buffer
  55  *              @unsigned l@ = number of bits to take at a time
  56  *
  57  * Returns:     The statistic %$Z_u = (X_u - \mu)/\sigma$%, which should be
  58  *              normally distributed with a mean of zero and standard
  59  *              deviation of 1.
  60  *
  61  * Use:         Performs Maurer's universal statistical test on a buffer of
  62  *              data.  You must ensure that the buffer size @sz@ is larger
  63  *              than %$11 l \cdot 2^l$% bits long, and ideally much larger.
  64  *
  65  *              Note that, under Unix systems, this function requires the
  66  *              maths library.
  67  */
  68
  69 extern double maurer(const octet */*p*/, size_t /*sz*/, unsigned /*l*/);
  70
  71 /*----- That's all, folks -------------------------------------------------*/
  72
  73 #ifdef __cplusplus
  74   }
  75 #endif
  76
  77 #endif