random.h

Go to the documentation of this file.

/*
 * Copyright (c) 2014 The University of Manchester
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef __RANDOM_H__
#define __RANDOM_H__
 
#include <stdint.h>
#include <stdfix-full-iso.h>
 
uint32_t mars_kiss32(void);
 
// 219.9 nanosecs (i.e. 44 ticks) per call on ARM with gcc 4.8.1
// Also available in custom seed form.
uint32_t mars_kiss64_simp(void);
 
// And now... with seeds
 
typedef uint32_t mars_kiss64_seed_t[4];
 
void validate_mars_kiss64_seed(mars_kiss64_seed_t seed);
 
uint32_t mars_kiss64_seed(mars_kiss64_seed_t seed);
 
//   294.9 nanosecs (i.e. 59 ticks) per call
 
void init_WELL1024a_simp(void);
 
uint32_t WELL1024a_simp(void);
 
// Versions with seeds
 
typedef uint32_t WELL1024a_seed_t[33];
 
void validate_WELL1024a_seed(WELL1024a_seed_t seed);
 
uint32_t WELL1024a_seed(WELL1024a_seed_t seed);
 
/* **************************************************
 
    Non-uniform RNGs
 
    Being added to all the time, and updated for better speed as
    fixed-point transcendentals and optimised multiplies become available
 
****************************************************/
typedef uint32_t (*uniform_rng)(uint32_t*);
 
s1615 exponential_dist_variate(uniform_rng uni_rng, uint32_t* seed_arg);
 
s1615 gaussian_dist_variate(uniform_rng uni_rng, uint32_t* seed_arg);
 
uint32_t poisson_dist_variate(
    uniform_rng uni_rng,
    uint32_t*   seed_arg,
    s1615       lambda);
 
uint32_t poisson_dist_variate_exp_minus_lambda(
    uniform_rng uni_rng,
    uint32_t*   seed_arg,
    u032        exp_minus_lambda);
 
 
#endif  /*__RANDOM_H__*/