Skip to content
Snippets Groups Projects
Commit d5592c64 authored by Kipp Cannon's avatar Kipp Cannon
Browse files

gstlal_cdf_weighted_chisq_P: silence gtk-doc warnings

about undocumented function parameters.
parent 693a82a9
No related branches found
No related tags found
No related merge requests found
......@@ -376,38 +376,41 @@ static double cfe(double x, jmp_buf env, int *count, int lim, const double *A, c
/**
* gstlal_cdf_weighted_chisq_P:
* @A: coefficient of j-th \chi^{2} variable
* @noncent: non-centrality parameter of the j-th \chi^{2} variable
* @dof: degrees of freedom of the j-th \chi^{2} variable
* @N: number of \chi^{2} variables
* @var: variance of zero-mean normal variable
* @c: point at which distribution is to be evaluated
* @lim: maximum number of terms in integration; < 0 --> no limit
* @accuracy: maximum error
* @trace: if not NULL will contain diagnostic information
* @fault: if not NULL will contain reason for failure
*
* Compute the cummulative distribution function for a linear combination
* of non-central chi-squared random variables. Returns the value of the
* cumulative distribution function at c or NaN on failure.
* of non-central chi-squared random variables.
*
* On failure, the value stored in the location pointed to by fault means:
* 1 required accuracy NOT achieved, 2 round-off error possibly
* significant, 3 invalid parameters, 4 unable to locate integration
* parameters, 5 out of memory,
*
* Returns: the value of the cumulative distribution function at c or NaN
* on failure.
*/
double gstlal_cdf_weighted_chisq_P(
/* coefficient of j-th \chi^{2} variable */
const double *A,
/* non-centrality parameter of the j-th \chi^{2} variable */
const double *noncent,
/* degrees of freedom of the j-th \chi^{2} variable */
const int *dof,
/* number of \chi^{2} variables */
int N,
/* variance of zero-mean normal variable */
double var,
/* point at which distribution is to be evaluated */
double c,
/* maximum number of terms in integration; < 0 --> no limit */
int lim,
/* maximum error */
double accuracy,
/* output: if not NULL will contain diagnostic information */
struct gstlal_cdf_weighted_chisq_P_trace *trace,
/* output: if not NULL will contain reason for failure
* 1 required accuracy NOT achieved
* 2 round-off error possibly significant
* 3 invalid parameters
* 4 unable to locate integration parameters
* 5 out of memory
*/
int *fault
)
{
......
......@@ -42,7 +42,7 @@ struct gstlal_cdf_weighted_chisq_P_trace {
#define GSTLAL_CDF_WEIGHTED_CHISQ_P_TRACE_INITIALIZER ((struct gstlal_cdf_weighted_chisq_P_trace) {0.0, 0, 0, 0.0, 0.0, 0.0, 0})
double gstlal_cdf_weighted_chisq_P(const double *, const double *, const int *, int, double, double, int, double, struct gstlal_cdf_weighted_chisq_P_trace *, int *);
double gstlal_cdf_weighted_chisq_P(const double *A, const double *noncent, const int *dof, int N, double var, double c, int lim, double accuracy, struct gstlal_cdf_weighted_chisq_P_trace *trace, int *fault);
#endif /* __GSTLAL_CDF_WEIGHTED_CHISQ_P_H__ */
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment