NAG AD Library
g01fb (inv_cdf_students_t)

Settings help

AD Name Style:

AD Specification Language:

1 Purpose

g01fb is the AD Library version of the primal routine g01fbf. Based (in the C++ interface) on overload resolution, g01fb can be used for primal, tangent and adjoint evaluation. It supports tangents and adjoints of first order.

2 Specification

Fortran Interface
Subroutine g01fb_AD_f ( ad_handle, tail, p, df, x, ifail)
Integer, Intent (Inout) :: ifail
ADTYPE, Intent (In) :: p, df
ADTYPE, Intent (Out) :: x
Character (1), Intent (In) :: tail
Type (c_ptr), Intent (Inout) :: ad_handle
Corresponding to the overloaded C++ function, the Fortran interface provides five routines with names reflecting the type used for active real arguments. The actual subroutine and type names are formed by replacing AD and ADTYPE in the above as follows:
when ADTYPE is Real(kind=nag_wp) then AD is p0w
when ADTYPE is Type(nagad_a1w_w_rtype) then AD is a1w
when ADTYPE is Type(nagad_t1w_w_rtype) then AD is t1w
C++ Header Interface
#include <dco.hpp>
#include <nagad.h>
namespace nag {
namespace ad {
void g01fb ( void *&ad_handle, const char *tail, const ADTYPE &p, const ADTYPE &df, ADTYPE &x, Integer &ifail)
The function is overloaded on ADTYPE which represents the type of active arguments. ADTYPE may be any of the following types:
Note: this function can be used with AD tools other than dco/c++. For details, please contact NAG.

3 Description

g01fb is the AD Library version of the primal routine g01fbf.
g01fbf returns the deviate associated with the given tail probability of Student's t-distribution with real degrees of freedom. For further information see Section 3 in the documentation for g01fbf.

4 References

Hastings N A J and Peacock J B (1975) Statistical Distributions Butterworth
Hill G W (1970) Student's t-distribution Comm. ACM 13(10) 617–619

5 Arguments

In addition to the arguments present in the interface of the primal routine, g01fb includes some arguments specific to AD.
A brief summary of the AD specific arguments is given below. For the remainder, links are provided to the corresponding argument from the primal routine. A tooltip popup for all arguments can be found by hovering over the argument name in Section 2 and in this section.
Note that the primal routine is a function whereas g01fb_a1w_f, is a subroutine, where the function value is returned in the additional output parameter, x.
1: ad_handle – Pointer to AD Data Input/Output
On entry: a handle to the AD configuration data object, as created by x10aa.
2: tail – character Input
3: pADTYPE Input
4: dfADTYPE Input
5: xADTYPE Output
On exit: the deviate associated with the given tail probability of Student’s t-distribution with real degrees of freedom.
6: ifail – Integer Input/Output

6 Error Indicators and Warnings

g01fb preserves all error codes from g01fbf and in addition can return:
An unexpected AD error has been triggered by this routine. Please contact NAG.
See Section 4.8.2 in the NAG AD Library Introduction for further information.
The routine was called using a mode that has not yet been implemented.
On entry: ad_handle is nullptr.
This check is only made if the overloaded C++ interface is used with arguments not of type double.
A C++ exception was thrown.
The error message will show the details of the C++ exception text.
Dynamic memory allocation failed for AD.
See Section 4.8.1 in the NAG AD Library Introduction for further information.

7 Accuracy

Not applicable.

8 Parallelism and Performance

g01fb is not threaded in any implementation.

9 Further Comments


10 Example

The following examples are variants of the example for g01fbf, modified to demonstrate calling the NAG AD Library.
Description of the primal example.
This example reads the probability, the tail that probability represents and the degrees of freedom for a number of Student's t-distributions and computes the corresponding deviates.

10.1 Adjoint modes

Language Source File Data Results
Fortran g01fb_a1w_fe.f90 g01fb_a1w_fe.d g01fb_a1w_fe.r
C++ g01fb_a1w_hcppe.cpp g01fb_a1w_hcppe.d g01fb_a1w_hcppe.r

10.2 Tangent modes

Language Source File Data Results
Fortran g01fb_t1w_fe.f90 g01fb_t1w_fe.d g01fb_t1w_fe.r
C++ g01fb_t1w_hcppe.cpp g01fb_t1w_hcppe.d g01fb_t1w_hcppe.r

10.3 Passive mode

Language Source File Data Results
Fortran g01fb_p0w_fe.f90 g01fb_p0w_fe.d g01fb_p0w_fe.r
C++ g01fb_p0w_hcppe.cpp g01fb_p0w_hcppe.d g01fb_p0w_hcppe.r