Skip to content

Commit 5475251

Browse files
author
GYT
committed
Add note to *TRTRS and *TBTRS about how only exact singularity is checked
1 parent 9840f50 commit 5475251

File tree

8 files changed

+64
-16
lines changed

8 files changed

+64
-16
lines changed

SRC/ctbtrs.f

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,14 @@
3939
*>
4040
*> A * X = B, A**T * X = B, or A**H * X = B,
4141
*>
42-
*> where A is a triangular band matrix of order N, and B is an
43-
*> N-by-NRHS matrix. A check is made to verify that A is nonsingular.
42+
*> where A is a triangular band matrix of order N, and B is an N-by-NRHS matrix.
43+
*>
44+
*> This subroutine verifies that A is nonsingular, but callers should note that only exact
45+
*> singularity is detected. It is conceivable for one or more diagonal elements of A to be
46+
*> subnormally tiny numbers without this subroutine signalling an error.
47+
*>
48+
*> If a possible loss of numerical precision due to near-singular matrices is a concern, the
49+
*> caller should verify that A is nonsingular within some tolerance before calling this subroutine.
4450
*> \endverbatim
4551
*
4652
* Arguments:

SRC/ctrtrs.f

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,14 @@
3939
*>
4040
*> A * X = B, A**T * X = B, or A**H * X = B,
4141
*>
42-
*> where A is a triangular matrix of order N, and B is an N-by-NRHS
43-
*> matrix. A check is made to verify that A is nonsingular.
42+
*> where A is a triangular matrix of order N, and B is an N-by-NRHS matrix.
43+
*>
44+
*> This subroutine verifies that A is nonsingular, but callers should note that only exact
45+
*> singularity is detected. It is conceivable for one or more diagonal elements of A to be
46+
*> subnormally tiny numbers without this subroutine signalling an error.
47+
*>
48+
*> If a possible loss of numerical precision due to near-singular matrices is a concern, the
49+
*> caller should verify that A is nonsingular within some tolerance before calling this subroutine.
4450
*> \endverbatim
4551
*
4652
* Arguments:

SRC/dtbtrs.f

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,14 @@
3939
*>
4040
*> A * X = B or A**T * X = B,
4141
*>
42-
*> where A is a triangular band matrix of order N, and B is an
43-
*> N-by NRHS matrix. A check is made to verify that A is nonsingular.
42+
*> where A is a triangular band matrix of order N, and B is an N-by-NRHS matrix.
43+
*>
44+
*> This subroutine verifies that A is nonsingular, but callers should note that only exact
45+
*> singularity is detected. It is conceivable for one or more diagonal elements of A to be
46+
*> subnormally tiny numbers without this subroutine signalling an error.
47+
*>
48+
*> If a possible loss of numerical precision due to near-singular matrices is a concern, the
49+
*> caller should verify that A is nonsingular within some tolerance before calling this subroutine.
4450
*> \endverbatim
4551
*
4652
* Arguments:

SRC/dtrtrs.f

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,14 @@
3939
*>
4040
*> A * X = B or A**T * X = B,
4141
*>
42-
*> where A is a triangular matrix of order N, and B is an N-by-NRHS
43-
*> matrix. A check is made to verify that A is nonsingular.
42+
*> where A is a triangular matrix of order N, and B is an N-by-NRHS matrix.
43+
*>
44+
*> This subroutine verifies that A is nonsingular, but callers should note that only exact
45+
*> singularity is detected. It is conceivable for one or more diagonal elements of A to be
46+
*> subnormally tiny numbers without this subroutine signalling an error.
47+
*>
48+
*> If a possible loss of numerical precision due to near-singular matrices is a concern, the
49+
*> caller should verify that A is nonsingular within some tolerance before calling this subroutine.
4450
*> \endverbatim
4551
*
4652
* Arguments:

SRC/stbtrs.f

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,14 @@
3939
*>
4040
*> A * X = B or A**T * X = B,
4141
*>
42-
*> where A is a triangular band matrix of order N, and B is an
43-
*> N-by NRHS matrix. A check is made to verify that A is nonsingular.
42+
*> where A is a triangular band matrix of order N, and B is an N-by-NRHS matrix.
43+
*>
44+
*> This subroutine verifies that A is nonsingular, but callers should note that only exact
45+
*> singularity is detected. It is conceivable for one or more diagonal elements of A to be
46+
*> subnormally tiny numbers without this subroutine signalling an error.
47+
*>
48+
*> If a possible loss of numerical precision due to near-singular matrices is a concern, the
49+
*> caller should verify that A is nonsingular within some tolerance before calling this subroutine.
4450
*> \endverbatim
4551
*
4652
* Arguments:

SRC/strtrs.f

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,14 @@
3939
*>
4040
*> A * X = B or A**T * X = B,
4141
*>
42-
*> where A is a triangular matrix of order N, and B is an N-by-NRHS
43-
*> matrix. A check is made to verify that A is nonsingular.
42+
*> where A is a triangular matrix of order N, and B is an N-by-NRHS matrix.
43+
*>
44+
*> This subroutine verifies that A is nonsingular, but callers should note that only exact
45+
*> singularity is detected. It is conceivable for one or more diagonal elements of A to be
46+
*> subnormally tiny numbers without this subroutine signalling an error.
47+
*>
48+
*> If a possible loss of numerical precision due to near-singular matrices is a concern, the
49+
*> caller should verify that A is nonsingular within some tolerance before calling this subroutine.
4450
*> \endverbatim
4551
*
4652
* Arguments:

SRC/ztbtrs.f

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,14 @@
3939
*>
4040
*> A * X = B, A**T * X = B, or A**H * X = B,
4141
*>
42-
*> where A is a triangular band matrix of order N, and B is an
43-
*> N-by-NRHS matrix. A check is made to verify that A is nonsingular.
42+
*> where A is a triangular band matrix of order N, and B is an N-by-NRHS matrix.
43+
*>
44+
*> This subroutine verifies that A is nonsingular, but callers should note that only exact
45+
*> singularity is detected. It is conceivable for one or more diagonal elements of A to be
46+
*> subnormally tiny numbers without this subroutine signalling an error.
47+
*>
48+
*> If a possible loss of numerical precision due to near-singular matrices is a concern, the
49+
*> caller should verify that A is nonsingular within some tolerance before calling this subroutine.
4450
*> \endverbatim
4551
*
4652
* Arguments:

SRC/ztrtrs.f

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,14 @@
3939
*>
4040
*> A * X = B, A**T * X = B, or A**H * X = B,
4141
*>
42-
*> where A is a triangular matrix of order N, and B is an N-by-NRHS
43-
*> matrix. A check is made to verify that A is nonsingular.
42+
*> where A is a triangular matrix of order N, and B is an N-by-NRHS matrix.
43+
*>
44+
*> This subroutine verifies that A is nonsingular, but callers should note that only exact
45+
*> singularity is detected. It is conceivable for one or more diagonal elements of A to be
46+
*> subnormally tiny numbers without this subroutine signalling an error.
47+
*>
48+
*> If a possible loss of numerical precision due to near-singular matrices is a concern, the
49+
*> caller should verify that A is nonsingular within some tolerance before calling this subroutine.
4450
*> \endverbatim
4551
*
4652
* Arguments:

0 commit comments

Comments
 (0)