misc.h

Go to the documentation of this file.

/***********************************************************************
    Copyright (C) 2005,2006 Frédéric HENRY <neryel@reveries.info>

    This file is part of ASpiReNN.

    ASpiReNN is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published 
    by the Free Software Foundation; either version 2 of the License,
    or (at your option) any later version.

    ASpiReNN is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of 
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License 
    along with ASpiReNN; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
    02111-1307  USA.

***********************************************************************/

#ifndef _MISC_H_
#define _MISC_H_

#include <stdio.h>
#include <stdlib.h>

/* Only useful for python */
extern const void * aspi_null;

/* Init random number generator */
void aspi_init_rand (int seed);
/* Return a number between 0 and 1 */
double aspi_misc_random_number (void);
/* Return a number using gaussian law */
double aspi_misc_random_gaussian (double mean, double sigma);
/* Return a number following gaussian function */
double aspi_misc_gaussian (double mu, double sigma, double x);
/* Return a number using a binomial law */
int aspi_misc_random_binomial (int runs, double proba);
/* Return a number using a poisson law */
int aspi_misc_random_poisson (double lambda);

/* Set the number of runs used to calculate poisson law */
void aspi_misc_poisson_set_runs (int runs);

#define ASPI_PI 3.14159265358979323846




#ifndef DEBUG 
 #ifdef NDEBUG
  #define DEBUG 0
 #else /* NDEBUG */
  #define DEBUG 1
 #endif /* NDEBUG */
#endif /* DEBUG */

#ifndef aspi_return_if_fail
#define aspi_return_if_fail(expr)                                         \
     if (!(expr))                                                       \
       {                                                                \
         fprintf(stderr,                                                \
                "** CRITICAL ** file %s: line %d (%s): assertion `%s' failed.\n",        \
                __FILE__,                                               \
                __LINE__,                                               \
                __PRETTY_FUNCTION__,                                    \
                #expr);                                                 \
         if (DEBUG)                                                     \
           abort ();                                                    \
         return;                                                        \
       };                             
#endif /* aspi_return_if_fail */

#ifndef aspi_return_value_if_fail
#define aspi_return_value_if_fail(expr, value)                             \
     if (!(expr))                                                       \
       {                                                                \
         fprintf(stderr,                                                \
                "** CRITICAL ** file %s: line %d (%s): assertion `%s' failed.\n",        \
                __FILE__,                                               \
                __LINE__,                                               \
                __PRETTY_FUNCTION__,                                    \
                #expr);                                                 \
         if (DEBUG)                                                     \
           abort ();                                                    \
         return (value);                                                 \
       };              
#endif  /* aspi_return_value_if_fail */


#endif /* _MISC_H_ */

---