random_number.h

Go to the documentation of this file.

/* 
 * This file is part of biomcmc-lib, a low-level library for phylogenomic analysis.
 * Copyright (C) 2019-today  Leonardo de Oliveira Martins [ leomrtns at gmail.com;  http://www.leomartins.org ]
 *
 * biomcmc 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.
 *
 * This program 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 PARTICULLAR PURPOSE.  See the GNU General Public License for more 
 * details (file "COPYING" or http://www.gnu.org/copyleft/gpl.html).
 */

#ifndef _biomcmc_random_number_h_
#define _biomcmc_random_number_h_

#include "random_number_gen.h"

typedef struct biomcmc_rng_struct* biomcmc_rng;

struct biomcmc_rng_struct 
{
  rng_taus_struct taus; 
  rng_mt19937_struct mt; 
  uint64_t bit32;    
  bool have_bit32;   
  double rnorm32, rnorm64;         
  bool have_rnorm32, have_rnorm64; 
};

extern biomcmc_rng biomcmc_random_number; /* in OSX at least, the linker will bundle all sources into one library,
                                             and thus global variables must be declared "extern" in the headers 
                                             and defined only once in the corresponding .c file (to avoid duplicates).
                                             Functions don't need this because they are implicitly declared "extern" 
                                             Another solution is to declare all global variables as "static" but this 
                                             is dangerous since we may have several static copies. */

void biomcmc_random_number_init (unsigned long long int seed);
void biomcmc_random_number_finalize (void);

biomcmc_rng new_biomcmc_rng (unsigned long long int seed, int stream_number);
void del_biomcmc_rng (biomcmc_rng r);

unsigned long long int biomcmc_rng_get_initial_seed (void);
biomcmc_rng new_biomcmc_rng_from_seed (unsigned long long int seed, int stream_number);

extern double biomcmc_rng_snorm32 (void);
extern double biomcmc_rng_snorm (void);

extern double biomcmc_rng_unif (void);
extern double biomcmc_rng_unif_pos (void);
extern uint64_t biomcmc_rng_unif_int64 (uint64_t n);

extern double biomcmc_rng_unif32 (void);
extern double biomcmc_rng_unif_pos32 (void);
extern uint32_t biomcmc_rng_unif_int (uint32_t n);

/* * * low level functions (direct access to generator) */

extern uint64_t biomcmc_rng_get (void);
extern double   biomcmc_rng_get_52 (void);
extern uint32_t biomcmc_rng_get_32 (void);

void biomcmc_get_time (int *time);
double biomcmc_elapsed_time (int *now, int *past);

#endif