clProbDist_template.h

Go to the documentation of this file.

/*
 * Authors:
 *
 *   David Munger <mungerd@iro.umontreal.ca>        (2015)
 *   Nabil Kemerchou <kemerchn@iro.umontreal.ca>    (2015)
 *   Pierre L'Ecuyer <lecuyer@iro.umontreal.ca>     (2015)
 *
 */

#pragma once
#ifndef CLRNG_TEMPLATE_H
#define CLRNG_TEMPLATE_H

#error This file is a template for specific probability distributions; it should not be included as is.  Use a distribution-specific header such as poisson.h instead.

#include <clProbDist.h>


typedef struct { /* ... */ } clprobdistObject;

typedef cl_double vartype;


clprobdistObject* clprobdistCreate(DIST_PARAMS, size_t* bufSize, clprobdistStatus* err);

clprobdistStatus clprobdistDestroy(clprobdistObject* dist);

cl_double clprobdistDensityWithObject(const clprobdistObject* dist, cl_double x, clprobdistStatus* err);

cl_double clprobdistProbWithObject(const clprobdistObject* dist, cl_int x, clprobdistStatus* err);

cl_double clprobdistCDFWithObject(const clprobdistObject* dist, vartype x, clprobdistStatus* err);

cl_double clprobdistComplCDFWithObject(const clprobdistObject* dist, vartype x, clprobdistStatus* err);

vartype clprobdistInverseCDFWithObject(const clprobdistObject* dist, cl_double u, clprobdistStatus* err);

cl_double clprobdistMeanWithObject(const clprobdistObject* dist, clprobdistStatus* err);

cl_double clprobdistVarianceWithObject(const clprobdistObject* dist, clprobdistStatus* err);

cl_double clprobdistStdDeviationWithObject(const clprobdistObject* dist, clprobdistStatus* err);

clprobdistStatus clprobdistCopyOverFromGlobal(_CLPROBDIST_<DIST>_OBJ_MEM clprobdistObject* destDist, __global const clprobdistObject* srcDist);

cl_double clprobdistDensity(DIST_PARAMS, cl_double x, clprobdistStatus* err);

cl_double clprobdistProb(DIST_PARAMS, cl_int x, clprobdistStatus* err);

cl_double clprobdistCDF(DIST_PARAMS, vartype x, clprobdistStatus* err);

cl_double clprobdistComplCDF(DIST_PARAMS, vartype x, clprobdistStatus* err);

vartype clprobdistInverseCDF(DIST_PARAMS, cl_double u, clprobdistStatus* err);

cl_double clprobdistMean(DIST_PARAMS, clprobdistStatus* err);

cl_double clprobdistVariance(DIST_PARAMS, clprobdistStatus* err);

cl_double clprobdistStdDeviation(DIST_PARAMS, clprobdistStatus* err);

#endif /* CLPROBDIST_H */

/*
* vim: syntax=c.doxygen spell spelllang=en fdm=syntax fdls=0 expandtab
*/