lapmt(3)

📦
version 3.12.1 · 9 versions
, in arch rolling

🦋 lapmt(3) — the LAPACK library-functions-manual page you didn't know you needed 🦋

okay so bestie, quick vibe check: this is lapmt from the LAPACK Library Functions Manual, and she's not one function, she's a whole girl group — four subroutines that do the exact same glow-up on four different data types. think of them as the same main character in four different outfits. 💅 no cap.

✨ NAME ✨

lapmt — lapmt: permute cols

that's it, that's the whole name section. short, iconic, to the point. 🎀

🌸 SYNOPSIS 🌸

💖 Functions 💖

  • subroutine clapmt (forwrd, m, n, x, ldx, k) — CLAPMT performs a forward or backward permutation of the columns of a matrix.
  • subroutine dlapmt (forwrd, m, n, x, ldx, k) — DLAPMT performs a forward or backward permutation of the columns of a matrix.
  • subroutine slapmt (forwrd, m, n, x, ldx, k) — SLAPMT performs a forward or backward permutation of the columns of a matrix.
  • subroutine zlapmt (forwrd, m, n, x, ldx, k) — ZLAPMT performs a forward or backward permutation of the columns of a matrix.

like, the way they all have the exact same energy but different letters in front? that's the LAPACK naming convention doing its thing and honestly it ate. 🫶

🦋 Detailed Description 🦋

ok so this heading exists and then it just… hands you straight over to the function docs. no extra lore, no secret chapter. it's giving "table of contents with commitment issues." 😭 the real content lives in the next section, so let's go. 💜

👑 Function Documentation 👑

💅 subroutine clapmt

subroutine clapmt (logical forwrd, integer m, integer n, complex, dimension(
    ldx, * ) x, integer ldx, integer, dimension( * ) k)

CLAPMT performs a forward or backward permutation of the columns of a matrix.

✨ Purpose ✨

the whole personality of this one, straight up: CLAPMT rearranges the columns of the M by N matrix X as specified by the permutation K(1),K(2),...,K(N) of the integers 1,...,N.

if FORWRD = .TRUE., that's a forward permutation:

X(*,K(J)) is moved X(*,J) for J = 1,2,...,N.

if FORWRD = .FALSE., that's a backward permutation:

X(*,J) is moved to X(*,K(J)) for J = 1,2,...,N.

🎀 Parameters 🎀

  • FORWRD — FORWRD is LOGICAL. set it to .TRUE. for a forward permutation, or .FALSE. for a backward permutation. that's the whole mood switch right there, bestie. 🔥
  • M — M is INTEGER, and it's the number of rows of the matrix X. constraint: M >= 0. (zero rows is valid, she's just empty and thriving. 🫶)
  • N — N is INTEGER, the number of columns of the matrix X. constraint: N >= 0.
  • X — X is COMPLEX array, dimension (LDX,N). on entry it's the M by N matrix X; on exit, X contains the permuted matrix X. glow-up complete. ✨
  • LDX — LDX is INTEGER, the leading dimension of the array X. constraint: LDX >= MAX(1,M). don't skip this one, it's load-bearing. 💀
  • K — K is INTEGER array, dimension (N). on entry, K contains the permutation vector. heads up: K is used as internal workspace, but it gets reset to its original value on output — so she goes in looking a mess and comes out flawless, no permanent changes. 💅

🌸 Author 🌸

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

Definition at line 103 of file clapmt.f.

💜 subroutine dlapmt

subroutine dlapmt (logical forwrd, integer m, integer n, double precision,
    dimension( ldx, * ) x, integer ldx, integer, dimension( * ) k)

DLAPMT performs a forward or backward permutation of the columns of a matrix.

✨ Purpose ✨

DLAPMT rearranges the columns of the M by N matrix X as specified by the permutation K(1),K(2),...,K(N) of the integers 1,...,N.

if FORWRD = .TRUE., forward permutation:

X(*,K(J)) is moved X(*,J) for J = 1,2,...,N.

if FORWRD = .FALSE., backward permutation:

X(*,J) is moved to X(*,K(J)) for J = 1,2,...,N.

🎀 Parameters 🎀

  • FORWRD — FORWRD is LOGICAL. .TRUE. = forward permutation, .FALSE. = backward permutation. same deal as her sister. 💫
  • M — M is INTEGER, the number of rows of the matrix X. M >= 0.
  • N — N is INTEGER, the number of columns of the matrix X. N >= 0.
  • X — X is DOUBLE PRECISION array, dimension (LDX,N). on entry, the M by N matrix X; on exit, X contains the permuted matrix X. yup, double the precision, double the slay. 🔥
  • LDX — LDX is INTEGER, the leading dimension of the array X, with LDX >= MAX(1,M).
  • K — K is INTEGER array, dimension (N). on entry it holds the permutation vector; it's used as internal workspace, but reset to its original value on output. no trauma left behind. 🫶

🌸 Author 🌸

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

Definition at line 103 of file dlapmt.f.

🌈 subroutine slapmt

subroutine slapmt (logical forwrd, integer m, integer n, real, dimension(
    ldx, * ) x, integer ldx, integer, dimension( * ) k)

SLAPMT performs a forward or backward permutation of the columns of a matrix.

✨ Purpose ✨

SLAPMT rearranges the columns of the M by N matrix X as specified by the permutation K(1),K(2),...,K(N) of the integers 1,...,N.

if FORWRD = .TRUE., forward permutation:

X(*,K(J)) is moved X(*,J) for J = 1,2,...,N.

if FORWRD = .FALSE., backward permutation:

X(*,J) is moved to X(*,K(J)) for J = 1,2,...,N.

🎀 Parameters 🎀

  • FORWRD — FORWRD is LOGICAL. .TRUE. means forward permutation, .FALSE. means backward permutation. pick your fighter. 💅
  • M — M is INTEGER, the number of rows of the matrix X. M >= 0.
  • N — N is INTEGER, the number of columns of the matrix X. N >= 0.
  • X — X is REAL array, dimension (LDX,N). on entry, the M by N matrix X; on exit, X contains the permuted matrix X. keepin' it real, literally. ✨
  • LDX — LDX is INTEGER, the leading dimension of the array X, and LDX >= MAX(1,M).
  • K — K is INTEGER array, dimension (N). on entry, it's your permutation vector; it gets used as internal workspace but is reset to its original value on output. very "borrow your hoodie and return it washed" of her. 🧚

🌸 Author 🌸

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

Definition at line 103 of file slapmt.f.

⭐ subroutine zlapmt

subroutine zlapmt (logical forwrd, integer m, integer n, complex*16,
    dimension( ldx, * ) x, integer ldx, integer, dimension( * ) k)

ZLAPMT performs a forward or backward permutation of the columns of a matrix.

✨ Purpose ✨

ZLAPMT rearranges the columns of the M by N matrix X as specified by the permutation K(1),K(2),...,K(N) of the integers 1,...,N.

if FORWRD = .TRUE., forward permutation:

X(*,K(J)) is moved X(*,J) for J = 1,2,...,N.

if FORWRD = .FALSE., backward permutation:

X(*,J) is moved to X(*,K(J)) for J = 1,2,...,N.

🎀 Parameters 🎀

  • FORWRD — FORWRD is LOGICAL. .TRUE. = forward permutation, .FALSE. = backward permutation. she's flexible, we love that. 💫
  • M — M is INTEGER, the number of rows of the matrix X. M >= 0.
  • N — N is INTEGER, the number of columns of the matrix X. N >= 0.
  • X — X is COMPLEX*16 array, dimension (LDX,N). on entry, the M by N matrix X; on exit, X contains the permuted matrix X. complex and double precision? she's overachieving and honestly we stan. 👑
  • LDX — LDX is INTEGER, the leading dimension of the array X, LDX >= MAX(1,M).
  • K — K is INTEGER array, dimension (N). on entry, K contains the permutation vector; it's used as internal workspace, but reset to its original value on output. ✨

🌸 Author 🌸

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

Definition at line 103 of file zlapmt.f.

🌟 Author 🌟

Generated automatically by Doxygen for LAPACK from the source code.

so yeah, she wasn't hand-written by a person, a robot did her makeup. respect. 🤖💄

and that's the whole page, bestie!! four subroutines, one job, zero notes. this was LAPACK, Version 3.12.0, and the page is dated the same — lapmt(3) saying goodbye from the Library Functions Manual. mwah 💋 🎀🦋💖

📦 where this page comes from