On exit: iflag should either be unchanged from its entry value of zero, or may be set nonzero to indicate that there is a problem in evaluating the function ; for instance may not be defined. If iflag is returned as nonzero then f01kcc will terminate the computation, with NE_INT, NE_INT_2 or NE_USER_STOP.
3: – IntegerInput
On entry: , the number of function or derivative values required.
4: – const ComplexInput
On entry: the points at which the function is to be evaluated.
5: – ComplexOutput
On exit: the function or derivative values.
should return the value , for .
6: – Nag_Comm *
Pointer to structure of type Nag_Comm; the following members are relevant to f.
user – double *
iuser – Integer *
p – Pointer
The type Pointer will be void *. Before calling f01kcc you may allocate memory and initialize these pointers with various quantities for use by f when called from f01kcc (see Section 3.1.1 in the Introduction to the NAG Library CL Interface).
Note:f should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by f01kcc. If your code inadvertently does return any NaNs or infinities, f01kcc is likely to produce unexpected results.
5: – Nag_Comm *
The NAG communication argument (see Section 3.1.1 in the Introduction to the NAG Library CL Interface).
On exit: an estimate of the absolute condition number of at .
8: – double *Output
On exit: the -norm of .
9: – double *Output
On exit: the -norm of .
10: – NagError *Input/Output
The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).
6Error Indicators and Warnings
Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
On entry, argument had an illegal value.
On entry, .
On entry, and .
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.
An internal error occurred when estimating the norm of the Fréchet derivative of at . Please contact NAG.
An internal error occurred when evaluating the matrix function . You can investigate further by calling f01fmc with the matrix and the function .
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.
f01kcc uses the norm estimation function f04zdc to estimate a quantity , where and . For further details on the accuracy of norm estimation, see the documentation for f04zdc.
8Parallelism and Performance
Background information to multithreading can be found in the Multithreading documentation.
f01kcc is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library. In these implementations, this function may make calls to the user-supplied functions from within an OpenMP parallel region. Thus OpenMP pragmas within the user functions can only be used if you are compiling the user-supplied function and linking the executable in accordance with the instructions in the Users' Note for your implementation. You must also ensure that you use the NAG communication argument comm in a thread safe manner, which is best achieved by only using it to supply read-only data to the user functions.
f01kcc makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.
Please consult the X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this function. Please also consult the Users' Note for your implementation for any additional implementation-specific information.
Approximately of complex allocatable memory is required by the routine, in addition to the memory used by the underlying matrix function routine f01fmc.
f01kcc returns the matrix function . This is computed using f01fmc. If only is required, without an estimate of the condition number, then it is far more efficient to use f01fmc directly.