lacn2(3)

πŸ’… bestie's guide to lacn2(3) πŸ’…

Okay so this is lacn2(3) from the Library Functions Manual, and ngl it's a whole family situation β€” four subroutines, all doing the same iconic thing in different precisions. Let's get into it 🫢


✨ NAME ✨

lacn2 β€” it's the lacn2: a 1-norm estimate, e.g., || A^{-1} ||_1 in gecon. Periodt. πŸ’…


🌸 SYNOPSIS 🌸

πŸ’– Functions

  • subroutine clacn2 (n, v, x, est, kase, isave) β€” CLACN2 estimates the 1-norm of a square matrix, using reverse communication for evaluating matrix-vector products.
  • subroutine dlacn2 (n, v, x, isgn, est, kase, isave) β€” DLACN2 estimates the 1-norm of a square matrix, using reverse communication for evaluating matrix-vector products.
  • subroutine slacn2 (n, v, x, isgn, est, kase, isave) β€” SLACN2 estimates the 1-norm of a square matrix, using reverse communication for evaluating matrix-vector products.
  • subroutine zlacn2 (n, v, x, est, kase, isave) β€” ZLACN2 estimates the 1-norm of a square matrix, using reverse communication for evaluating matrix-vector products.

πŸ¦‹ Detailed Description πŸ¦‹

Not me checking this section three times β€” bestie there is literally nothing here. It's a heading with no body. The actual tea is all in Function Documentation below, so keep scrolling πŸ‘‘


πŸ”₯ Function Documentation πŸ”₯


πŸ’œ clacn2

subroutine clacn2 (integer n, complex, dimension( * ) v, complex, dimension( * ) x, real est, integer kase, integer, dimension( 3 ) isave)

CLACN2 estimates the 1-norm of a square matrix, using reverse communication for evaluating matrix-vector products.

⭐ Purpose

CLACN2 estimates the 1-norm of a square, complex matrix A. Reverse communication is used for evaluating matrix-vector products.

πŸŽ€ Parameters

  • N β€” N is INTEGER. The order of the matrix. N >= 1. No zero-sized matrices bestie, the math said so.
  • V β€” V is COMPLEX array, dimension (N). On the final return, V = A*W, where EST = norm(V)/norm(W) (W is not returned). Yeah she's not giving you W back, don't ask 😭
  • X β€” X is COMPLEX array, dimension (N). On an intermediate return, X should be overwritten by A * X if KASE=1, or A**H * X if KASE=2, where A**H is the conjugate transpose of A, and CLACN2 must be re-called with all the other parameters unchanged. All of them. Don't touch. πŸ™ˆ
  • EST β€” EST is REAL. On entry with KASE = 1 or 2 and ISAVE(1) = 3, EST should be unchanged from the previous call to CLACN2. On exit, EST is an estimate (a lower bound) for norm(A).
  • KASE β€” KASE is INTEGER. On the initial call to CLACN2, KASE should be 0. On an intermediate return, KASE will be 1 or 2, indicating whether X should be overwritten by A * X or A**H * X. On the final return from CLACN2, KASE will again be 0. It's giving ✨full circle✨
  • ISAVE β€” ISAVE is INTEGER array, dimension (3). ISAVE is used to save variables between calls to SLACN2.
Yeah bestie, that last line says SLACN2 on the CLACN2 page πŸ’€ that's just how the doc is written, I'm reporting it exactly as it lives.

πŸ‘‘ Author

Univ. of Tennessee

Univ. of California Berkeley

Univ. of Colorado Denver

NAG Ltd.

πŸ’€ Further Details:

  • Originally named CONEST, dated March 16, 1988.
  • Last modified: April, 1999
  • This is a thread safe version of CLACON, which uses the array ISAVE in place of a SAVE statement, as follows:
 CLACON     CLACN2
  JUMP     ISAVE(1)
  J        ISAVE(2)
  ITER     ISAVE(3)

🫢 Contributors:

Nick Higham, University of Manchester

πŸ“š References:

N.J. Higham, "FORTRAN codes for estimating the one-norm of a real or complex matrix, with applications to condition estimation", ACM Trans. Math. Soft., vol. 14, no. 4, pp. 381-396, December 1988.

Definition at line 132 of file clacn2.f.


🧚 dlacn2

subroutine dlacn2 (integer n, double precision, dimension( * ) v, double precision, dimension( * ) x, integer, dimension( * ) isgn, double precision est, integer kase, integer, dimension( 3 ) isave)

DLACN2 estimates the 1-norm of a square matrix, using reverse communication for evaluating matrix-vector products.

⭐ Purpose

DLACN2 estimates the 1-norm of a square, real matrix A. Reverse communication is used for evaluating matrix-vector products.

πŸŽ€ Parameters

  • N β€” N is INTEGER. The order of the matrix. N >= 1.
  • V β€” V is DOUBLE PRECISION array, dimension (N). On the final return, V = A*W, where EST = norm(V)/norm(W) (W is not returned).
  • X β€” X is DOUBLE PRECISION array, dimension (N). On an intermediate return, X should be overwritten by A * X if KASE=1, or A**T * X if KASE=2, and DLACN2 must be re-called with all the other parameters unchanged.
  • ISGN β€” ISGN is INTEGER array, dimension (N). That's it. That's the whole description. Iconic minimalism πŸ’…
  • EST β€” EST is DOUBLE PRECISION. On entry with KASE = 1 or 2 and ISAVE(1) = 3, EST should be unchanged from the previous call to DLACN2. On exit, EST is an estimate (a lower bound) for norm(A).
  • KASE β€” KASE is INTEGER. On the initial call to DLACN2, KASE should be 0. On an intermediate return, KASE will be 1 or 2, indicating whether X should be overwritten by A * X or A**T * X. On the final return from DLACN2, KASE will again be 0.
  • ISAVE β€” ISAVE is INTEGER array, dimension (3). ISAVE is used to save variables between calls to DLACN2.

πŸ‘‘ Author

Univ. of Tennessee

Univ. of California Berkeley

Univ. of Colorado Denver

NAG Ltd.

πŸ’€ Further Details:

  • Originally named SONEST, dated March 16, 1988.
  • This is a thread safe version of DLACON, which uses the array ISAVE in place of a SAVE statement, as follows:
 DLACON     DLACN2
  JUMP     ISAVE(1)
  J        ISAVE(2)
  ITER     ISAVE(3)

🫢 Contributors:

Nick Higham, University of Manchester

πŸ“š References:

N.J. Higham, "FORTRAN codes for estimating the one-norm of a real or complex matrix, with applications to condition estimation", ACM Trans. Math. Soft., vol. 14, no. 4, pp. 381-396, December 1988.

Definition at line 135 of file dlacn2.f.


🌈 slacn2

subroutine slacn2 (integer n, real, dimension( * ) v, real, dimension( * ) x, integer, dimension( * ) isgn, real est, integer kase, integer, dimension( 3 ) isave)

SLACN2 estimates the 1-norm of a square matrix, using reverse communication for evaluating matrix-vector products.

⭐ Purpose

SLACN2 estimates the 1-norm of a square, real matrix A. Reverse communication is used for evaluating matrix-vector products.

πŸŽ€ Parameters

  • N β€” N is INTEGER. The order of the matrix. N >= 1.
  • V β€” V is REAL array, dimension (N). On the final return, V = A*W, where EST = norm(V)/norm(W) (W is not returned).
  • X β€” X is REAL array, dimension (N). On an intermediate return, X should be overwritten by A * X if KASE=1, or A**T * X if KASE=2, and SLACN2 must be re-called with all the other parameters unchanged.
  • ISGN β€” ISGN is INTEGER array, dimension (N). Again, that's the whole thing. She said "no notes" πŸ™ˆ
  • EST β€” EST is REAL. On entry with KASE = 1 or 2 and ISAVE(1) = 3, EST should be unchanged from the previous call to SLACN2. On exit, EST is an estimate (a lower bound) for norm(A).
  • KASE β€” KASE is INTEGER. On the initial call to SLACN2, KASE should be 0. On an intermediate return, KASE will be 1 or 2, indicating whether X should be overwritten by A * X or A**T * X. On the final return from SLACN2, KASE will again be 0.
  • ISAVE β€” ISAVE is INTEGER array, dimension (3). ISAVE is used to save variables between calls to SLACN2.

πŸ‘‘ Author

Univ. of Tennessee

Univ. of California Berkeley

Univ. of Colorado Denver

NAG Ltd.

πŸ’€ Further Details:

  • Originally named SONEST, dated March 16, 1988.
  • This is a thread safe version of SLACON, which uses the array ISAVE in place of a SAVE statement, as follows:
 SLACON     SLACN2
  JUMP     ISAVE(1)
  J        ISAVE(2)
  ITER     ISAVE(3)

🫢 Contributors:

Nick Higham, University of Manchester

πŸ“š References:

N.J. Higham, "FORTRAN codes for estimating the one-norm of a real or complex matrix, with applications to condition estimation", ACM Trans. Math. Soft., vol. 14, no. 4, pp. 381-396, December 1988.

Definition at line 135 of file slacn2.f.


πŸ¦„ zlacn2

subroutine zlacn2 (integer n, complex*16, dimension( * ) v, complex*16, dimension( * ) x, double precision est, integer kase, integer, dimension( 3 ) isave)

ZLACN2 estimates the 1-norm of a square matrix, using reverse communication for evaluating matrix-vector products.

⭐ Purpose

ZLACN2 estimates the 1-norm of a square, complex matrix A. Reverse communication is used for evaluating matrix-vector products.

πŸŽ€ Parameters

  • N β€” N is INTEGER. The order of the matrix. N >= 1.
  • V β€” V is COMPLEX*16 array, dimension (N). On the final return, V = A*W, where EST = norm(V)/norm(W) (W is not returned).
  • X β€” X is COMPLEX*16 array, dimension (N). On an intermediate return, X should be overwritten by A * X if KASE=1, or A**H * X if KASE=2, where A**H is the conjugate transpose of A, and ZLACN2 must be re-called with all the other parameters unchanged.
  • EST β€” EST is DOUBLE PRECISION. On entry with KASE = 1 or 2 and ISAVE(1) = 3, EST should be unchanged from the previous call to ZLACN2. On exit, EST is an estimate (a lower bound) for norm(A).
  • KASE β€” πŸŽ€ okay bestie this is exactly where part 1 cuts off β€” KASE, plus the rest of zlacn2's details, roll right into part 2. Don't move, we're mid-sentence on purpose πŸŽ€
  • KASE β€” okay so KASE is INTEGER πŸ’…. On the initial call to ZLACN2, KASE should be 0. On an intermediate return, KASE will be 1 or 2, indicating whether X should be overwritten by A * X or A**H * X. On the final return from ZLACN2, KASE will again be 0. 🫢
  • ISAVE β€” ISAVE is INTEGER array, dimension (3) ✨. ISAVE is used to save variables between calls to ZLACN2. Lowkey the memory keeper of the whole situation. πŸŽ€

🌸 Author 🌸

  • Univ. of Tennessee
  • Univ. of California Berkeley
  • Univ. of Colorado Denver
  • NAG Ltd.

🧚 Further Details:

Originally named CONEST, dated March 16, 1988. ✨

Last modified: April, 1999 πŸ•°οΈ

This is a thread safe version of ZLACON, which uses the array ISAVE in place of a SAVE statement, as follows:

     ZLACON     ZLACN2
      JUMP     ISAVE(1)
      J        ISAVE(2)
      ITER     ISAVE(3)

🌈 Contributors:

  • Nick Higham, University of Manchester

πŸ’œ References:

  • N.J. Higham, "FORTRAN codes for estimating the one-norm of a real or complex matrix, with applications to condition estimation", ACM Trans. Math. Soft., vol. 14, no. 4, pp. 381-396, December 1988.

Definition at line 132 of file zlacn2.f. 🫢

πŸŽ€ Author πŸŽ€

Generated automatically by Doxygen for LAPACK from the source code. πŸ€–πŸ’–


Cute sign-off: this is LAPACK Version 3.12.0, page lacn2(3) β€” and the footer didn’t give us a date, so that’s the whole story, bestie. πŸ’…βœ¨

πŸ“¦ where this page comes from