fortran-lapack
Loading...
Searching...
No Matches
la_info Module Reference

Decode the info exit code of the LAPACK routines into a la_state. More...

Functions/Subroutines

elemental subroutine, public handle_gesv (where_at, info, n, nrhs, lda, ldb, err)
 Process the exit code of gesv(n,nrhs,a,lda,ipiv,b,ldb,info)
 
elemental subroutine, public handle_getrf (where_at, info, m, n, lda, err)
 Process the exit code of getrf(m,n,a,lda,ipiv,info)
 
elemental subroutine, public handle_getri (where_at, info, n, lda, err)
 Process the exit code of getri(n,a,lda,ipiv,work,lwork,info)
 
elemental subroutine, public handle_gecon (where_at, info, n, lda, err)
 Process the exit code of gecon(norm,n,a,lda,anorm,rcond,work,iwork,info)
 
elemental subroutine, public handle_posv (where_at, info, triangle, n, nrhs, lda, ldb, err)
 Process the exit code of posv(uplo,n,nrhs,a,lda,b,ldb,info)
 
elemental subroutine, public handle_potrs (where_at, info, triangle, n, nrhs, lda, ldb, err)
 Process the exit code of potrs(uplo,n,nrhs,a,lda,b,ldb,info)
 
elemental subroutine, public handle_potrf (where_at, info, triangle, n, lda, err)
 Process the exit code of potrf(uplo,n,a,lda,info)
 
elemental subroutine, public handle_geqrf (where_at, info, m, n, lwork, err)
 Process the exit code of geqrf(m,n,a,lda,tau,work,lwork,info)
 
elemental subroutine, public handle_geqp3 (where_at, info, m, n, lwork, err)
 Process the exit code of geqp3(m,n,a,lda,jpvt,tau,work,lwork,[rwork,]info)
 
elemental subroutine, public handle_orgqr (where_at, info, m, n, k, lwork, err)
 Process the exit code of orgqr/ungqr(m,n,k,a,lda,tau,work,lwork,info)
 
elemental subroutine, public handle_gees (where_at, info, n, lda, ldvs, err)
 Process the exit code of gees: real gees(jobvs,sort,select,n,a,lda,sdim,wr,wi,vs,ldvs,work, lwork,bwork,info), complex gees(jobvs,sort,select,n,a,lda,sdim,w,vs,ldvs,work,lwork,rwork, bwork,info). The complex form has one eigenvalue array less, so ldvs and lwork come one position earlier: never on a code where the real form has a scalar argument.
 
elemental subroutine, public handle_geev (where_at, info, n, lda, err)
 Process the exit code of geev: real geev(jobvl,jobvr,n,a,lda,wr,wi,vl,ldvl,vr,ldvr,work,lwork, info), complex geev(jobvl,jobvr,n,a,lda,w,vl,ldvl,vr,ldvr,work,lwork,rwork,info). The complex form has one eigenvalue array less, so ldvl, ldvr and lwork come one position earlier: never on a code where the real form has a scalar argument.
 
elemental subroutine, public handle_ggev (where_at, info, n, lda, ldb, err)
 Process the exit code of ggev: real ggev(jobvl,jobvr,n,a,lda,b,ldb,alphar,alphai,beta,vl,ldvl, vr,ldvr,work,lwork,info), complex ggev(jobvl,jobvr,n,a,lda,b,ldb,alpha,beta,vl,ldvl,vr,ldvr, work,lwork,rwork,info). The complex form has one eigenvalue array less, so ldvl, ldvr and lwork come one position earlier: never on a code where the real form has a scalar argument.
 
elemental subroutine, public handle_heev (where_at, info, n, lda, err)
 Process the exit code of syev(jobz,uplo,n,a,lda,w,work,lwork,info) and heev(jobz,uplo,n,a,lda,w,work,lwork,rwork,info)
 
elemental subroutine, public handle_gesdd (where_at, info, m, n, err)
 Process the exit code of gesdd(jobz,m,n,a,lda,s,u,ldu,vt,ldvt,work,lwork,[rwork,]iwork,info)
 
elemental subroutine, public handle_gelsd (where_at, info, n, nrhs, lda, ldb, err)
 Process the exit code of gelsd(m,n,nrhs,a,lda,b,ldb,s,rcond,rank,work,lwork,[rwork,]iwork,info)
 
elemental subroutine, public handle_gglse (where_at, info, m, n, p, err)
 Process the exit code of gglse(m,n,p,a,lda,b,ldb,c,d,x,work,lwork,info), that minimizes ||c - a*x|| subject to b*x = d. The messages name the matrices as constrained_lstsq does: a(m,n) and the constraint c(p,n)
 
elemental subroutine, public handle_ggglm (where_at, info, m, n, err)
 Process the exit code of ggglm(n,m,p,a,lda,b,ldb,d,x,y,work,lwork,info), that minimizes ||y|| subject to d = a*x + b*y. The messages name the matrices as generalized_lstsq does: a(m,n), with m rows, and the square root w of the covariance in place of b.
 

Detailed Description

Decode the info exit code of the LAPACK routines into a la_state.

One elemental handler per LAPACK routine, handle_<routine>, shared by every procedure that calls it. Each handler takes the caller's name first, which becomes the where_at of the returned state, then the exit code, then the routine arguments its messages need.

One classification holds for every routine: an invalid dimension of the user's data is a LINALG_VALUE_ERROR; an invalid argument the library chose (a job character, a triangle selection, a workspace size) is a LINALG_INTERNAL_ERROR; a failure that info > 0 reports is a LINALG_ERROR; any code that LAPACK does not document is a LINALG_INTERNAL_ERROR.

Function/Subroutine Documentation

◆ handle_gecon()

elemental subroutine, public la_info::handle_gecon ( character(*), intent(in) where_at,
integer(ilp), intent(in) info,
integer(ilp), intent(in) n,
integer(ilp), intent(in) lda,
type(la_state), intent(out) err )

Process the exit code of gecon(norm,n,a,lda,anorm,rcond,work,iwork,info)

Parameters
[in]where_atName of the calling procedure
[in]infogecon exit code
[in]ngecon arguments
[in]ldagecon arguments
[out]errState return flag

◆ handle_gees()

elemental subroutine, public la_info::handle_gees ( character(*), intent(in) where_at,
integer(ilp), intent(in) info,
integer(ilp), intent(in) n,
integer(ilp), intent(in) lda,
integer(ilp), intent(in) ldvs,
type(la_state), intent(out) err )

Process the exit code of gees: real gees(jobvs,sort,select,n,a,lda,sdim,wr,wi,vs,ldvs,work, lwork,bwork,info), complex gees(jobvs,sort,select,n,a,lda,sdim,w,vs,ldvs,work,lwork,rwork, bwork,info). The complex form has one eigenvalue array less, so ldvs and lwork come one position earlier: never on a code where the real form has a scalar argument.

Parameters
[in]where_atName of the calling procedure
[in]infogees exit code
[in]ngees arguments
[in]ldagees arguments
[in]ldvsgees arguments
[out]errState return flag

◆ handle_geev()

elemental subroutine, public la_info::handle_geev ( character(*), intent(in) where_at,
integer(ilp), intent(in) info,
integer(ilp), intent(in) n,
integer(ilp), intent(in) lda,
type(la_state), intent(out) err )

Process the exit code of geev: real geev(jobvl,jobvr,n,a,lda,wr,wi,vl,ldvl,vr,ldvr,work,lwork, info), complex geev(jobvl,jobvr,n,a,lda,w,vl,ldvl,vr,ldvr,work,lwork,rwork,info). The complex form has one eigenvalue array less, so ldvl, ldvr and lwork come one position earlier: never on a code where the real form has a scalar argument.

Parameters
[in]where_atName of the calling procedure
[in]infogeev exit code
[in]ngeev arguments
[in]ldageev arguments
[out]errState return flag

◆ handle_gelsd()

elemental subroutine, public la_info::handle_gelsd ( character(*), intent(in) where_at,
integer(ilp), intent(in) info,
integer(ilp), intent(in) n,
integer(ilp), intent(in) nrhs,
integer(ilp), intent(in) lda,
integer(ilp), intent(in) ldb,
type(la_state), intent(out) err )

Process the exit code of gelsd(m,n,nrhs,a,lda,b,ldb,s,rcond,rank,work,lwork,[rwork,]iwork,info)

Parameters
[in]where_atName of the calling procedure
[in]infogelsd exit code
[in]ngelsd arguments
[in]nrhsgelsd arguments
[in]ldagelsd arguments
[in]ldbgelsd arguments
[out]errState return flag

◆ handle_geqp3()

elemental subroutine, public la_info::handle_geqp3 ( character(*), intent(in) where_at,
integer(ilp), intent(in) info,
integer(ilp), intent(in) m,
integer(ilp), intent(in) n,
integer(ilp), intent(in) lwork,
type(la_state), intent(out) err )

Process the exit code of geqp3(m,n,a,lda,jpvt,tau,work,lwork,[rwork,]info)

Parameters
[in]where_atName of the calling procedure
[in]infogeqp3 exit code
[in]mgeqp3 arguments
[in]ngeqp3 arguments
[in]lworkgeqp3 arguments
[out]errState return flag

◆ handle_geqrf()

elemental subroutine, public la_info::handle_geqrf ( character(*), intent(in) where_at,
integer(ilp), intent(in) info,
integer(ilp), intent(in) m,
integer(ilp), intent(in) n,
integer(ilp), intent(in) lwork,
type(la_state), intent(out) err )

Process the exit code of geqrf(m,n,a,lda,tau,work,lwork,info)

Parameters
[in]where_atName of the calling procedure
[in]infogeqrf exit code
[in]mgeqrf arguments
[in]ngeqrf arguments
[in]lworkgeqrf arguments
[out]errState return flag

◆ handle_gesdd()

elemental subroutine, public la_info::handle_gesdd ( character(*), intent(in) where_at,
integer(ilp), intent(in) info,
integer(ilp), intent(in) m,
integer(ilp), intent(in) n,
type(la_state), intent(out) err )

Process the exit code of gesdd(jobz,m,n,a,lda,s,u,ldu,vt,ldvt,work,lwork,[rwork,]iwork,info)

Parameters
[in]where_atName of the calling procedure
[in]infogesdd exit code
[in]mgesdd arguments
[in]ngesdd arguments
[out]errState return flag

◆ handle_gesv()

elemental subroutine, public la_info::handle_gesv ( character(*), intent(in) where_at,
integer(ilp), intent(in) info,
integer(ilp), intent(in) n,
integer(ilp), intent(in) nrhs,
integer(ilp), intent(in) lda,
integer(ilp), intent(in) ldb,
type(la_state), intent(out) err )

Process the exit code of gesv(n,nrhs,a,lda,ipiv,b,ldb,info)

Parameters
[in]where_atName of the calling procedure
[in]infogesv exit code
[in]ngesv arguments
[in]nrhsgesv arguments
[in]ldagesv arguments
[in]ldbgesv arguments
[out]errState return flag

◆ handle_getrf()

elemental subroutine, public la_info::handle_getrf ( character(*), intent(in) where_at,
integer(ilp), intent(in) info,
integer(ilp), intent(in) m,
integer(ilp), intent(in) n,
integer(ilp), intent(in) lda,
type(la_state), intent(out) err )

Process the exit code of getrf(m,n,a,lda,ipiv,info)

Parameters
[in]where_atName of the calling procedure
[in]infogetrf exit code
[in]mgetrf arguments
[in]ngetrf arguments
[in]ldagetrf arguments
[out]errState return flag

◆ handle_getri()

elemental subroutine, public la_info::handle_getri ( character(*), intent(in) where_at,
integer(ilp), intent(in) info,
integer(ilp), intent(in) n,
integer(ilp), intent(in) lda,
type(la_state), intent(out) err )

Process the exit code of getri(n,a,lda,ipiv,work,lwork,info)

Parameters
[in]where_atName of the calling procedure
[in]infogetri exit code
[in]ngetri arguments
[in]ldagetri arguments
[out]errState return flag

◆ handle_ggev()

elemental subroutine, public la_info::handle_ggev ( character(*), intent(in) where_at,
integer(ilp), intent(in) info,
integer(ilp), intent(in) n,
integer(ilp), intent(in) lda,
integer(ilp), intent(in) ldb,
type(la_state), intent(out) err )

Process the exit code of ggev: real ggev(jobvl,jobvr,n,a,lda,b,ldb,alphar,alphai,beta,vl,ldvl, vr,ldvr,work,lwork,info), complex ggev(jobvl,jobvr,n,a,lda,b,ldb,alpha,beta,vl,ldvl,vr,ldvr, work,lwork,rwork,info). The complex form has one eigenvalue array less, so ldvl, ldvr and lwork come one position earlier: never on a code where the real form has a scalar argument.

Parameters
[in]where_atName of the calling procedure
[in]infoggev exit code
[in]nggev arguments
[in]ldaggev arguments
[in]ldbggev arguments
[out]errState return flag

◆ handle_ggglm()

elemental subroutine, public la_info::handle_ggglm ( character(*), intent(in) where_at,
integer(ilp), intent(in) info,
integer(ilp), intent(in) m,
integer(ilp), intent(in) n,
type(la_state), intent(out) err )

Process the exit code of ggglm(n,m,p,a,lda,b,ldb,d,x,y,work,lwork,info), that minimizes ||y|| subject to d = a*x + b*y. The messages name the matrices as generalized_lstsq does: a(m,n), with m rows, and the square root w of the covariance in place of b.

Parameters
[in]where_atName of the calling procedure
[in]infoggglm exit code
[in]mRows and columns of a, ggglm's n and m
[in]nRows and columns of a, ggglm's n and m
[out]errState return flag

◆ handle_gglse()

elemental subroutine, public la_info::handle_gglse ( character(*), intent(in) where_at,
integer(ilp), intent(in) info,
integer(ilp), intent(in) m,
integer(ilp), intent(in) n,
integer(ilp), intent(in) p,
type(la_state), intent(out) err )

Process the exit code of gglse(m,n,p,a,lda,b,ldb,c,d,x,work,lwork,info), that minimizes ||c - a*x|| subject to b*x = d. The messages name the matrices as constrained_lstsq does: a(m,n) and the constraint c(p,n)

Parameters
[in]where_atName of the calling procedure
[in]infogglse exit code
[in]mgglse arguments
[in]ngglse arguments
[in]pgglse arguments
[out]errState return flag

◆ handle_heev()

elemental subroutine, public la_info::handle_heev ( character(*), intent(in) where_at,
integer(ilp), intent(in) info,
integer(ilp), intent(in) n,
integer(ilp), intent(in) lda,
type(la_state), intent(out) err )

Process the exit code of syev(jobz,uplo,n,a,lda,w,work,lwork,info) and heev(jobz,uplo,n,a,lda,w,work,lwork,rwork,info)

Parameters
[in]where_atName of the calling procedure
[in]infosyev/heev exit code
[in]nsyev/heev arguments
[in]ldasyev/heev arguments
[out]errState return flag

◆ handle_orgqr()

elemental subroutine, public la_info::handle_orgqr ( character(*), intent(in) where_at,
integer(ilp), intent(in) info,
integer(ilp), intent(in) m,
integer(ilp), intent(in) n,
integer(ilp), intent(in) k,
integer(ilp), intent(in) lwork,
type(la_state), intent(out) err )

Process the exit code of orgqr/ungqr(m,n,k,a,lda,tau,work,lwork,info)

Parameters
[in]where_atName of the calling procedure
[in]infoorgqr exit code
[in]morgqr arguments
[in]norgqr arguments
[in]korgqr arguments
[in]lworkorgqr arguments
[out]errState return flag

◆ handle_posv()

elemental subroutine, public la_info::handle_posv ( character(*), intent(in) where_at,
integer(ilp), intent(in) info,
character, intent(in) triangle,
integer(ilp), intent(in) n,
integer(ilp), intent(in) nrhs,
integer(ilp), intent(in) lda,
integer(ilp), intent(in) ldb,
type(la_state), intent(out) err )

Process the exit code of posv(uplo,n,nrhs,a,lda,b,ldb,info)

Parameters
[in]where_atName of the calling procedure
[in]infoposv exit code
[in]triangleposv arguments
[out]errState return flag

◆ handle_potrf()

elemental subroutine, public la_info::handle_potrf ( character(*), intent(in) where_at,
integer(ilp), intent(in) info,
character, intent(in) triangle,
integer(ilp), intent(in) n,
integer(ilp), intent(in) lda,
type(la_state), intent(out) err )

Process the exit code of potrf(uplo,n,a,lda,info)

Parameters
[in]where_atName of the calling procedure
[in]infopotrf exit code
[in]trianglepotrf arguments
[out]errState return flag

◆ handle_potrs()

elemental subroutine, public la_info::handle_potrs ( character(*), intent(in) where_at,
integer(ilp), intent(in) info,
character, intent(in) triangle,
integer(ilp), intent(in) n,
integer(ilp), intent(in) nrhs,
integer(ilp), intent(in) lda,
integer(ilp), intent(in) ldb,
type(la_state), intent(out) err )

Process the exit code of potrs(uplo,n,nrhs,a,lda,b,ldb,info)

Parameters
[in]where_atName of the calling procedure
[in]infopotrs exit code
[in]trianglepotrs arguments
[out]errState return flag