Revert "Doc: highlight what xPOEQUB actually does"
authorChristoph Conrads <gitlab@christoph-conrads.name>
Wed, 21 Sep 2016 14:08:23 +0000 (16:08 +0200)
committerChristoph Conrads <gitlab@christoph-conrads.name>
Thu, 29 Sep 2016 15:01:43 +0000 (17:01 +0200)
This reverts commit 3c66ad2c7d6e2e73e369dbd919bba259b42e2f6d.

SRC/cpoequb.f
SRC/dpoequb.f
SRC/spoequb.f
SRC/zpoequb.f

index bf86d1a41475077e0d9aec16ccd5fe0c4d504b61..e0f474200d7ed262154ca12a52894501b8cc3d10 100644 (file)
 *>
 *> CPOEQUB computes row and column scalings intended to equilibrate a
 *> symmetric positive definite matrix A and reduce its condition number
-*> (with respect to the spectral norm). S contains the scale factors,
-*> chosen so that the scaled matrix B with elements
-*> B(i,j) = S(i)*A(i,j)*S(j) has diagonal entries close to one. S(i) is
-*> a power of b nearest to but not exceeding 1/sqrt(A(i,i)), where b is
-*> the basis use for floating point numbers on this machine. This choice
-*> of S avoids round-off errors when computing B.
+*> (with respect to the two-norm).  S contains the scale factors,
+*> S(i) = 1/sqrt(A(i,i)), chosen so that the scaled matrix B with
+*> elements B(i,j) = S(i)*A(i,j)*S(j) has ones on the diagonal.  This
+*> choice of S puts the condition number of B within a factor N of the
+*> smallest possible condition number over all possible diagonal
+*> scalings.
 *> \endverbatim
 *
 *  Arguments:
 *     .. Executable Statements ..
 *
 *     Test the input parameters.
+*
+*     Positive definite only performs 1 pass of equilibration.
 *
       INFO = 0
       IF( N.LT.0 ) THEN
index d236914122c36ca054f5f317a4814a63206400cf..fcee160e949c5cf9fa7ad7d6a8aedbc57adb7592 100644 (file)
 *>
 *> \verbatim
 *>
-*> DPOEQUB computes row and column scalings intended to equilibrate a
+*> DPOEQU computes row and column scalings intended to equilibrate a
 *> symmetric positive definite matrix A and reduce its condition number
-*> (with respect to the spectral norm). S contains the scale factors,
-*> chosen so that the scaled matrix B with elements
-*> B(i,j) = S(i)*A(i,j)*S(j) has diagonal entries close to one. S(i) is
-*> a power of b nearest to but not exceeding 1/sqrt(A(i,i)), where b is
-*> the basis use for floating point numbers on this machine. This choice
-*> of S avoids round-off errors when computing B.
+*> (with respect to the two-norm).  S contains the scale factors,
+*> S(i) = 1/sqrt(A(i,i)), chosen so that the scaled matrix B with
+*> elements B(i,j) = S(i)*A(i,j)*S(j) has ones on the diagonal.  This
+*> choice of S puts the condition number of B within a factor N of the
+*> smallest possible condition number over all possible diagonal
+*> scalings.
 *> \endverbatim
 *
 *  Arguments:
index 6bdbcda6ae22bdd1f21718ebf8ca0923f9f10126..523aee048d17a958d10a25a339eee05be6e5c98c 100644 (file)
 *>
 *> \verbatim
 *>
-*> SPOEQUB computes row and column scalings intended to equilibrate a
+*> SPOEQU computes row and column scalings intended to equilibrate a
 *> symmetric positive definite matrix A and reduce its condition number
-*> (with respect to the spectral norm). S contains the scale factors,
-*> chosen so that the scaled matrix B with elements
-*> B(i,j) = S(i)*A(i,j)*S(j) has diagonal entries close to one. S(i) is
-*> a power of b nearest to but not exceeding 1/sqrt(A(i,i)), where b is
-*> the basis use for floating point numbers on this machine. This choice
-*> of S avoids round-off errors when computing B.
+*> (with respect to the two-norm).  S contains the scale factors,
+*> S(i) = 1/sqrt(A(i,i)), chosen so that the scaled matrix B with
+*> elements B(i,j) = S(i)*A(i,j)*S(j) has ones on the diagonal.  This
+*> choice of S puts the condition number of B within a factor N of the
+*> smallest possible condition number over all possible diagonal
+*> scalings.
 *> \endverbatim
 *
 *  Arguments:
index bc4ff79b18bc3c86bf0c284af8fd1a02291671c3..c0d180c945ec490910e3776b429edb69b36b7176 100644 (file)
 *>
 *> ZPOEQUB computes row and column scalings intended to equilibrate a
 *> symmetric positive definite matrix A and reduce its condition number
-*> (with respect to the spectral norm). S contains the scale factors,
-*> chosen so that the scaled matrix B with elements
-*> B(i,j) = S(i)*A(i,j)*S(j) has diagonal entries close to one. S(i) is
-*> a power of b nearest to but not exceeding 1/sqrt(A(i,i)), where b is
-*> the basis use for floating point numbers on this machine. This choice
-*> of S avoids round-off errors when computing B.
+*> (with respect to the two-norm).  S contains the scale factors,
+*> S(i) = 1/sqrt(A(i,i)), chosen so that the scaled matrix B with
+*> elements B(i,j) = S(i)*A(i,j)*S(j) has ones on the diagonal.  This
+*> choice of S puts the condition number of B within a factor N of the
+*> smallest possible condition number over all possible diagonal
+*> scalings.
 *> \endverbatim
 *
 *  Arguments: