NAG Library Routine Document

g01sef (prob_beta_vector)

1
Purpose

g01sef computes a number of lower or upper tail probabilities for the beta distribution.

2
Specification

Fortran Interface
Subroutine g01sef ( ltail, tail, lbeta, beta, la, a, lb, b, p, ivalid, ifail)
Integer, Intent (In):: ltail, lbeta, la, lb
Integer, Intent (Inout):: ifail
Integer, Intent (Out):: ivalid(*)
Real (Kind=nag_wp), Intent (In):: beta(lbeta), a(la), b(lb)
Real (Kind=nag_wp), Intent (Out):: p(*)
Character (1), Intent (In):: tail(ltail)
C Header Interface
#include <nagmk26.h>
void  g01sef_ (const Integer *ltail, const char tail[], const Integer *lbeta, const double beta[], const Integer *la, const double a[], const Integer *lb, const double b[], double p[], Integer ivalid[], Integer *ifail, const Charlen length_tail)

3
Description

The lower tail probability, P Bi βi :ai,bi  is defined by
P Bi βi :ai,bi = Γ ai + bi Γ ai Γ bi 0 βi Bi ai-1 1-Bi bi-1 dBi = Iβi ai,bi ,   0 βi 1 ;  ai , bi > 0 .  
The function Iβiai,bi, also known as the incomplete beta function is calculated using s14ccf.
The input arrays to this routine are designed to allow maximum flexibility in the supply of vector arguments by re-using elements of any arrays that are shorter than the total number of evaluations required. See Section 2.6 in the G01 Chapter Introduction for further information.

4
References

NIST Digital Library of Mathematical Functions
Hastings N A J and Peacock J B (1975) Statistical Distributions Butterworth
Majumder K L and Bhattacharjee G P (1973) Algorithm AS 63. The incomplete beta integral Appl. Statist. 22 409–411

5
Arguments

1:     ltail – IntegerInput
On entry: the length of the array tail.
Constraint: ltail>0.
2:     tailltail – Character(1) arrayInput
On entry: indicates whether a lower or upper tail probabilities are required. For j= i-1 mod ltail +1 , for i=1,2,,maxltail,lbeta,la,lb:
tailj='L'
The lower tail probability is returned, i.e., pi = P Bi βi :ai,bi .
tailj='U'
The upper tail probability is returned, i.e., pi = P Bi βi :ai,bi .
Constraint: tailj='L' or 'U', for j=1,2,,ltail.
3:     lbeta – IntegerInput
On entry: the length of the array beta.
Constraint: lbeta>0.
4:     betalbeta – Real (Kind=nag_wp) arrayInput
On entry: βi, the value of the beta variate with βi=betaj, j=i-1 mod lbeta+1.
Constraint: 0.0betaj1.0, for j=1,2,,lbeta.
5:     la – IntegerInput
On entry: the length of the array a.
Constraint: la>0.
6:     ala – Real (Kind=nag_wp) arrayInput
On entry: ai, the first parameter of the required beta distribution with ai=aj, j=i-1 mod la+1.
Constraint: aj>0.0, for j=1,2,,la.
7:     lb – IntegerInput
On entry: the length of the array b.
Constraint: lb>0.
8:     blb – Real (Kind=nag_wp) arrayInput
On entry: bi, the second parameter of the required beta distribution with bi=bj, j=i-1 mod lb+1.
Constraint: bj>0.0, for j=1,2,,lb.
9:     p* – Real (Kind=nag_wp) arrayOutput
Note: the dimension of the array p must be at least maxltail,lbeta,la,lb.
On exit: pi, the probabilities for the beta distribution.
10:   ivalid* – Integer arrayOutput
Note: the dimension of the array ivalid must be at least maxltail,lbeta,la,lb.
On exit: ivalidi indicates any errors with the input arguments, with
ivalidi=0
No error.
ivalidi=1
On entry,invalid value supplied in tail when calculating pi.
ivalidi=2
On entry,βi<0.0,
orβi>1.0.
ivalidi=3
On entry,ai0.0,
orbi0.0,
11:   ifail – IntegerInput/Output
On entry: ifail must be set to 0, -1 or 1. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value -1 or 1 is recommended. If the output of error messages is undesirable, then the value 1 is recommended. Otherwise, because for this routine the values of the output arguments may be useful even if ifail0 on exit, the recommended value is -1. When the value -1 or 1 is used it is essential to test the value of ifail on exit.
On exit: ifail=0 unless the routine detects an error or a warning has been flagged (see Section 6).

6
Error Indicators and Warnings

If on entry ifail=0 or -1, explanatory error messages are output on the current error message unit (as defined by x04aaf).
Note: g01sef may return useful information for one or more of the following detected errors or warnings.
Errors or warnings detected by the routine:
ifail=1
On entry, at least one value of beta, a, b or tail was invalid.
Check ivalid for more information.
ifail=2
On entry, array size=value.
Constraint: ltail>0.
ifail=3
On entry, array size=value.
Constraint: lbeta>0.
ifail=4
On entry, array size=value.
Constraint: la>0.
ifail=5
On entry, array size=value.
Constraint: lb>0.
ifail=-99
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.
ifail=-399
Your licence key may have expired or may not have been installed correctly.
See Section 3.8 in How to Use the NAG Library and its Documentation for further information.
ifail=-999
Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

7
Accuracy

The accuracy is limited by the error in the incomplete beta function. See Section 7 in s14ccf for further details.

8
Parallelism and Performance

g01sef is not threaded in any implementation.

9
Further Comments

None.

10
Example

This example reads values from a number of beta distributions and computes the associated lower tail probabilities.

10.1
Program Text

Program Text (g01sefe.f90)

10.2
Program Data

Program Data (g01sefe.d)

10.3
Program Results

Program Results (g01sefe.r)