Blame qrng/gsl_qrng.h

Packit 67cb25
/* Author: G. Jungman + modifications from O. Teytaud
Packit 67cb25
 */
Packit 67cb25
#ifndef __GSL_QRNG_H__
Packit 67cb25
#define __GSL_QRNG_H__
Packit 67cb25
Packit 67cb25
#include <stdlib.h>
Packit 67cb25
#include <gsl/gsl_types.h>
Packit 67cb25
#include <gsl/gsl_errno.h>
Packit 67cb25
#include <gsl/gsl_inline.h>
Packit 67cb25
Packit 67cb25
#undef __BEGIN_DECLS
Packit 67cb25
#undef __END_DECLS
Packit 67cb25
#ifdef __cplusplus
Packit 67cb25
# define __BEGIN_DECLS extern "C" {
Packit 67cb25
# define __END_DECLS }
Packit 67cb25
#else
Packit 67cb25
# define __BEGIN_DECLS /* empty */
Packit 67cb25
# define __END_DECLS /* empty */
Packit 67cb25
#endif
Packit 67cb25
Packit 67cb25
__BEGIN_DECLS
Packit 67cb25
Packit 67cb25
Packit 67cb25
/* Once again, more inane C-style OOP... kill me now. */
Packit 67cb25
Packit 67cb25
/* Structure describing a type of generator.
Packit 67cb25
 */
Packit 67cb25
typedef struct
Packit 67cb25
{
Packit 67cb25
  const char * name;
Packit 67cb25
  unsigned int max_dimension;
Packit 67cb25
  size_t (*state_size) (unsigned int dimension);
Packit 67cb25
  int (*init_state) (void * state, unsigned int dimension);
Packit 67cb25
  int (*get) (void * state, unsigned int dimension, double x[]);
Packit 67cb25
}
Packit 67cb25
gsl_qrng_type;
Packit 67cb25
Packit 67cb25
/* Structure describing a generator instance of a
Packit 67cb25
 * specified type, with generator-specific state info
Packit 67cb25
 * and dimension-specific info.
Packit 67cb25
 */
Packit 67cb25
typedef struct
Packit 67cb25
{
Packit 67cb25
  const gsl_qrng_type * type;
Packit 67cb25
  unsigned int dimension;
Packit 67cb25
  size_t state_size;
Packit 67cb25
  void * state;
Packit 67cb25
}
Packit 67cb25
gsl_qrng;
Packit 67cb25
Packit 67cb25
Packit 67cb25
/* Supported generator types.
Packit 67cb25
 */
Packit 67cb25
GSL_VAR const gsl_qrng_type * gsl_qrng_niederreiter_2;
Packit 67cb25
GSL_VAR const gsl_qrng_type * gsl_qrng_sobol;
Packit 67cb25
GSL_VAR const gsl_qrng_type * gsl_qrng_halton;
Packit 67cb25
GSL_VAR const gsl_qrng_type * gsl_qrng_reversehalton;
Packit 67cb25
Packit 67cb25
Packit 67cb25
/* Allocate and initialize a generator
Packit 67cb25
 * of the specified type, in the given
Packit 67cb25
 * space dimension.
Packit 67cb25
 */
Packit 67cb25
gsl_qrng * gsl_qrng_alloc (const gsl_qrng_type * T, unsigned int dimension);
Packit 67cb25
Packit 67cb25
Packit 67cb25
/* Copy a generator. */
Packit 67cb25
int gsl_qrng_memcpy (gsl_qrng * dest, const gsl_qrng * src);
Packit 67cb25
Packit 67cb25
Packit 67cb25
/* Clone a generator. */
Packit 67cb25
gsl_qrng * gsl_qrng_clone (const gsl_qrng * q);
Packit 67cb25
Packit 67cb25
Packit 67cb25
/* Free a generator. */
Packit 67cb25
void gsl_qrng_free (gsl_qrng * q);
Packit 67cb25
Packit 67cb25
Packit 67cb25
/* Intialize a generator. */
Packit 67cb25
void gsl_qrng_init (gsl_qrng * q);
Packit 67cb25
Packit 67cb25
Packit 67cb25
/* Get the standardized name of the generator. */
Packit 67cb25
const char * gsl_qrng_name (const gsl_qrng * q);
Packit 67cb25
Packit 67cb25
Packit 67cb25
/* ISN'T THIS CONFUSING FOR PEOPLE?
Packit 67cb25
  WHAT IF SOMEBODY TRIES TO COPY WITH THIS ???
Packit 67cb25
  */
Packit 67cb25
size_t gsl_qrng_size (const gsl_qrng * q);
Packit 67cb25
Packit 67cb25
Packit 67cb25
void * gsl_qrng_state (const gsl_qrng * q);
Packit 67cb25
Packit 67cb25
Packit 67cb25
/* Retrieve next vector in sequence. */
Packit 67cb25
INLINE_DECL int gsl_qrng_get (const gsl_qrng * q, double x[]);
Packit 67cb25
Packit 67cb25
#ifdef HAVE_INLINE
Packit 67cb25
INLINE_FUN int gsl_qrng_get (const gsl_qrng * q, double x[])
Packit 67cb25
{
Packit 67cb25
  return (q->type->get) (q->state, q->dimension, x);
Packit 67cb25
}
Packit 67cb25
Packit 67cb25
#endif /* HAVE_INLINE */
Packit 67cb25
Packit 67cb25
Packit 67cb25
__END_DECLS
Packit 67cb25
Packit 67cb25
Packit 67cb25
#endif /* !__GSL_QRNG_H__ */