

STATS Library
=============

    Table of contents :

        I   ) Introduction

        II  ) Build instructions

        III ) Examples

        A   ) References

        B   ) About this project

        C   ) Contact and bug report manager

  ----------------------------------------------------------------------------

    I) Introduction

        The STATS Library is an implementation of the Statistical Tests for
        Proportions Comparison presented by E. D. Taillard, Ph. Waelti and
        J. Zuber in [1].

        Online implementation can be found at :

            http://qualopt.heig-vd.ch

  ----------------------------------------------------------------------------

    II) Build instructions

        * See COMPILE.txt files in src and samples directories or:

        * Unix / Linux

            Customize the Makefile (default config should be OK) and type
            `make` in the top level directory of the distribution.

            When compilation is done, following message appear

            /* ---------------------------------------------------- */

             Build done :

                     Library -> ./lib
                     Header  -> ./include
                     Samples -> ./samples

             /* ---------------------------------------------------- */

             indicating where to find library, ...

        * Windows

            Use your favorite Win32 compiler to generate the library contained
            in the './src' directory. Cygwin users may refer to Unix/Linux
            section.

            MINGW compiler is recommanded to compile and build.

        * Or...

            Don't want to build library, just include all files (*.h *.c)
            in your project directory and link object file with your linker
            after compiling all files.

  ----------------------------------------------------------------------------

    III) Examples

        The './samples' contains the examples binary (if builded with
        Makefile, otherwise sources are in './samples' directory).
        There is currently two little program :

            1) taillard_test

                Usage : taillard_test

                Program will ask you test parameters and give you the
                probability than success rate a/n is significantly higher
                than success rate b/n.

            2) taillard_table

                Usage : ./bin/taillard_table [ n m c ]

                    n : N value (Sample 1)
                    m : M value (Sample 2)
                    c : Confidence level [%]

                Program will display couples [a,b] for which a success rate
                >= a/n is significantly higher than a success rate <= b/m,
                for a given confidence level.

                Value between {n,m} are repectively n and m values and the
                [a,b] following the {} are the couples that satisfy the
                above condition.

  ----------------------------------------------------------------------------

    A) References

        [1] E. D. Taillard, Ph. Waelti, J. Zuber, "Few statistical tests
            for proportions comparison", Technical report, HEIG-Vd, 2006

  ----------------------------------------------------------------------------

    B) About this project

        QualOpt project is supported by the strategic founds of the Applied
        University of Western Switzerland (HES-SO), grant QUALOPT-11731

  ----------------------------------------------------------------------------

    C) Contact and bug report manager

        Eric D. Taillard
         > http://mistic.heig-vd.ch/taillard

        Thanks for your bug reports !

