NAG CL Interface
s14cqc (beta_​incomplete_​vector)

Settings help

CL Name Style:


1 Purpose

s14cqc computes an array of values for the regularized incomplete beta function Ix(a,b) and its complement 1-Ix(a,b).

2 Specification

#include <nag.h>
void  s14cqc (Integer n, const double a[], const double b[], const double x[], double w[], double w1[], Integer ivalid[], NagError *fail)
The function may be called by the names: s14cqc, nag_specfun_beta_incomplete_vector or nag_incomplete_beta_vector.

3 Description

s14cqc evaluates the regularized incomplete beta function Ix(a,b) and its complement 1Ix(a,b) in the normalized form, for arrays of arguments xi, ai and bi, for i=1,2,,n. The incomplete beta function and its complement are given by
Ix(a,b) = 1 B(a,b) 0 x ta-1 (1-t) b-1 dt 1Ix (a,b) = Iy (b,a) , where ​ y=1-x ,  
with
Several methods are used to evaluate the functions depending on the arguments a, b and x. The methods include Wise's asymptotic expansion (see Wise (1950)) when a>b, continued fraction derived by DiDonato and Morris (1992) when a, b>1, and power series when b1 or b×x0.7. When both a and b are large, specifically a, b15, the DiDonato and Morris (1992) asymptotic expansion is employed for greater efficiency.
Once either Ix(a,b) or Iy(b,a) is computed, the other is obtained by subtraction from 1. In order to avoid loss of relative precision in this subtraction, the smaller of Ix(a,b) and Iy(b,a) is computed first.
s14cqc is derived from BRATIO in DiDonato and Morris (1992).

4 References

DiDonato A R and Morris A H (1992) Algorithm 708: Significant digit computation of the incomplete beta function ratios ACM Trans. Math. Software 18 360–373
Wise M E (1950) The incomplete beta function as a contour integral and a quickly converging series for its inverse Biometrika 37 208–218

5 Arguments

1: n Integer Input
On entry: n, the number of points.
Constraint: n0.
2: a[n] const double Input
On entry: the argument ai of the function, for i=1,2,,n.
Constraint: a[i-1]0.0, for i=1,2,,n.
3: b[n] const double Input
On entry: the argument bi of the function, for i=1,2,,n.
Constraints:
  • b[i-1]0.0, for i=1,2,,n;
  • b[i-1]0.0 or a[i-1]0.0, for i=1,2,,n.
4: x[n] const double Input
On entry: xi, the upper limit of integration, for i=1,2,,n.
Constraints:
  • x[i-1]0.0, for i=1,2,,n;
  • x[i-1]0.0 or a[i-1]0.0, for i=1,2,,n;
  • 1-x[i-1]0.0 or b[i-1]0.0, for i=1,2,,n.
5: w[n] double Output
On exit: the values of the incomplete beta function Ixi(ai,bi) evaluated from zero to xi.
6: w1[n] double Output
On exit: the values of the complement of the incomplete beta function 1-Ixi(ai,bi), i.e., the incomplete beta function evaluated from xi to one.
7: ivalid[n] Integer Output
On exit: ivalid[i-1] contains the error code for the ith evaluation, for i=1,2,,n.
ivalid[i-1]=0
No error.
ivalid[i-1]=1
ai​ or ​bi<0.
ivalid[i-1]=2
Both ai​ and ​bi=0.
ivalid[i-1]=3
xi[0,1].
ivalid[i-1]=4
Both xi​ and ​ai=0.
ivalid[i-1]=5
Both 1-xi​ and ​bi=0.
8: fail NagError * Input/Output
The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).

6 Error Indicators and Warnings

NE_ALLOC_FAIL
Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
NE_BAD_PARAM
On entry, argument value had an illegal value.
NE_INT
On entry, n=value.
Constraint: n0.
NE_INTERNAL_ERROR
An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.
See Section 7.5 in the Introduction to the NAG Library CL Interface for further information.
NE_NO_LICENCE
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library CL Interface for further information.
NW_IVALID
On entry, at least one argument had an invalid value.
Check ivalid for more information.

7 Accuracy

s14cqc is designed to maintain relative accuracy for all arguments. For very tiny results (of the order of machine precision or less) some relative accuracy may be lost – loss of three or four decimal places has been observed in experiments. For other arguments full relative accuracy may be expected.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
s14cqc is not threaded in any implementation.

9 Further Comments

None.

10 Example

This example reads 10 values for each vector argument a, b and x from a file. It then evaluates the function and its complement for each set of values.

10.1 Program Text

Program Text (s14cqce.c)

10.2 Program Data

Program Data (s14cqce.d)

10.3 Program Results

Program Results (s14cqce.r)