larcm(3)

📦
version 3.12.1 · 9 versions
, in arch rolling

💅 larcm(3) — the real-times-complex matrix multiply moment ✨

okay so bestie, this one comes straight out of the LAPACK Library Functions Manual, and it's honestly iconic: it's the whole "multiply a real matrix by a complex matrix" vibe. no cap. 🫶

🌸 NAME 🌸

larcm — larcm: real * complex matrix-matrix multiply

like, that's the name and the energy, both at once. 💖

✨ SYNOPSIS ✨

🧚 Functions

  • subroutine clarcm (m, n, a, lda, b, ldb, c, ldc, rwork) — CLARCM copies all or part of a real two-dimensional array to a complex array.
  • subroutine zlarcm (m, n, a, lda, b, ldb, c, ldc, rwork) — ZLARCM copies all or part of a real two-dimensional array to a complex array.

two icons, same job, different precision. we love a consistent duo. 👑

Detailed Description

this is the "here's the whole page" part — the detailed description lives down in the function docs below, so scroll a lil and it's all there. 🦋

🔥 Function Documentation 🔥

⭐ subroutine clarcm (integer m, integer n, real, dimension( lda, * ) a, integer lda, complex, dimension( ldb, * ) b, integer ldb, complex, dimension( ldc, * ) c, integer ldc, real, dimension( * ) rwork) ⭐

CLARCM copies all or part of a real two-dimensional array to a complex array. periodt. 💅

🎀 Purpose 🎀

!>
!> CLARCM performs a very simple matrix-matrix multiplication:
!>          C := A * B,
!> where A is M by M and real; B is M by N and complex;
!> C is M by N and complex.
!>

so yes — A is real and M by M, B is complex and M by N, and C comes out M by N and complex. very simple, very demure. ✨

🌸 Parameters 🌸

  • M
!>          M is INTEGER
!>          The number of rows of the matrix A and of the matrix C.
!>          M >= 0.
!>

the row count for A and C, bestie. and it has to be M >= 0 — no negative-row nonsense here. 🙈

  • N
!>          N is INTEGER
!>          The number of columns and rows of the matrix B and
!>          the number of columns of the matrix C.
!>          N >= 0.
!>

this one's doing double duty: columns and rows of B, plus the columns of C. busy queen. N >= 0, obviously. 💜

  • A
!>          A is REAL array, dimension (LDA, M)
!>          On entry, A contains the M by M matrix A.
!>

a real array with dimension (LDA, M), and on entry it's holding your M by M matrix A. 💖

  • LDA
!>          LDA is INTEGER
!>          The leading dimension of the array A. LDA >=max(1,M).
!>

the leading dimension of A, and it's gotta satisfy LDA >=max(1,M). don't skip that check, fr fr. ⚠️

  • B
!>          B is COMPLEX array, dimension (LDB, N)
!>          On entry, B contains the M by N matrix B.
!>

complex array, dimension (LDB, N), and on entry it holds the M by N matrix B. 🦋

  • LDB
!>          LDB is INTEGER
!>          The leading dimension of the array B. LDB >=max(1,M).
!>

leading dimension of B, with LDB >=max(1,M). yes ma'am. 🌟

  • C
!>          C is COMPLEX array, dimension (LDC, N)
!>          On exit, C contains the M by N matrix C.
!>

complex array, dimension (LDC, N) — and note it's on exit, 'cause that's where the answer shows up. main character array energy. 👑

  • LDC
!>          LDC is INTEGER
!>          The leading dimension of the array C. LDC >=max(1,M).
!>

leading dimension of C, must be LDC >=max(1,M). 🎀

  • RWORK
!>          RWORK is REAL array, dimension (2*M*N)
!>

real array, dimension (2*M*N). that's it, that's the whole vibe. 💀

🌈 Author 🌈

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

⭐ Definition at line 113 of file clarcm.f. ⭐

💜 subroutine zlarcm (integer m, integer n, double precision, dimension( lda, * ) a, integer lda, complex*16, dimension( ldb, * ) b, integer ldb, complex*16, dimension( ldc, * ) c, integer ldc, double precision, dimension( * ) rwork) 💜

ZLARCM copies all or part of a real two-dimensional array to a complex array. same job, double precision edition. slay. 💅

🎀 Purpose 🎀

!>
!> ZLARCM performs a very simple matrix-matrix multiplication:
!>          C := A * B,
!> where A is M by M and real; B is M by N and complex;
!> C is M by N and complex.
!>

exact same math, just double precision flavored. ✨

🌸 Parameters 🌸

  • M
!>          M is INTEGER
!>          The number of rows of the matrix A and of the matrix C.
!>          M >= 0.
!>

rows of A, rows of C, and M >= 0. 🫶

  • N
!>          N is INTEGER
!>          The number of columns and rows of the matrix B and
!>          the number of columns of the matrix C.
!>          N >= 0.
!>

columns and rows of B plus columns of C, with N >= 0. 🦋

  • A
!>          A is DOUBLE PRECISION array, dimension (LDA, M)
!>          On entry, A contains the M by M matrix A.
!>

DOUBLE PRECISION array, dimension (LDA, M), holding the M by M matrix A on entry. 💖

  • LDA
!>          LDA is INTEGER
!>          The leading dimension of the array A. LDA >=max(1,M).
!>

leading dimension of A, LDA >=max(1,M). 🔥

  • B
!>          B is COMPLEX*16 array, dimension (LDB, N)
!>          On entry, B contains the M by N matrix B.
!>

COMPLEX*16 array, dimension (LDB, N), holding the M by N matrix B on entry. 🌟

  • LDB
!>          LDB is INTEGER
!>          The leading dimension of the array B. LDB >=max(1,M).
!>

leading dimension of B, LDB >=max(1,M). 💜

  • C
!>          C is COMPLEX*16 array, dimension (LDC, N)
!>          On exit, C contains the M by N matrix C.
!>

COMPLEX*16 array, dimension (LDC, N), and on exit it contains the M by N matrix C. the payoff. 👑

  • LDC
!>          LDC is INTEGER
!>          The leading dimension of the array C. LDC >=max(1,M).
!>

leading dimension of C, LDC >=max(1,M). 🎀

  • RWORK
!>          RWORK is DOUBLE PRECISION array, dimension (2*M*N)
!>

DOUBLE PRECISION array, dimension (2*M*N). 🍓

🌈 Author 🌈

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

⭐ Definition at line 113 of file zlarcm.f. ⭐

👑 Author 👑

Generated automatically by Doxygen for LAPACK from the source code.

like, not even a human wrote this section, it's giving "the tooling did it" energy. respect tho. 🤖💖

and that's the whole page, bestie — LAPACK, Version 3.12.0, larcm(3), signed off and slaying. go multiply something. 🎀✨🦋

📦 where this page comes from