laset(3)

📦
version 3.12.1 · 9 versions
, in arch rolling

💅 laset(3) — the laset girlies (set matrix) ✨

ok so this page lives in Library Functions Manual, and honestly? it's giving "LAPACK's most relatable little helper." bestie, laset is literally just set matrix — it fills your matrix with values and dips. no cap, it's iconic in its simplicity 🎀

There are four flavors of this bad boy, one for each real/complex × single/double combo, and they all do the exact same vibe: off-diagonals get ALPHA, diagonal gets BETA. let's go 🦋

✨ SYNOPSIS ✨

🧚 Functions

  • subroutine claset (uplo, m, n, alpha, beta, a, lda) — CLASET initializes the off-diagonal elements and the diagonal elements of a matrix to given values.
  • subroutine dlaset (uplo, m, n, alpha, beta, a, lda) — DLASET initializes the off-diagonal elements and the diagonal elements of a matrix to given values.
  • subroutine slaset (uplo, m, n, alpha, beta, a, lda) — SLASET initializes the off-diagonal elements and the diagonal elements of a matrix to given values.
  • subroutine zlaset (uplo, m, n, alpha, beta, a, lda) — ZLASET initializes the off-diagonal elements and the diagonal elements of a matrix to given values.

🌸 Detailed Description 🌸

(fr fr, the description is the function list. this page does not beat around the bush 💀)

👑 Function Documentation 👑

💜 subroutine claset (character uplo, integer m, integer n, complex alpha, complex beta, complex, dimension( lda, * ) a, integer lda)

CLASET initializes the off-diagonal elements and the diagonal elements of a matrix to given values.

🍓 Purpose:

!>
!> CLASET initializes a 2-D array A to BETA on the diagonal and
!> ALPHA on the offdiagonals.
!>

🎀 Parameters

UPLO

!>          UPLO is CHARACTER*1
!>          Specifies the part of the matrix A to be set.
!>          = 'U':      Upper triangular part is set. The lower triangle
!>                      is unchanged.
!>          = 'L':      Lower triangular part is set. The upper triangle
!>                      is unchanged.
!>          Otherwise:  All of the matrix A is set.
!>

M

!>          M is INTEGER
!>          On entry, M specifies the number of rows of A.
!>

N

!>          N is INTEGER
!>          On entry, N specifies the number of columns of A.
!>

ALPHA

!>          ALPHA is COMPLEX
!>          All the offdiagonal array elements are set to ALPHA.
!>

BETA

!>          BETA is COMPLEX
!>          All the diagonal array elements are set to BETA.
!>

A

!>          A is COMPLEX array, dimension (LDA,N)
!>          On entry, the m by n matrix A.
!>          On exit, A(i,j) = ALPHA, 1 <= i <= m, 1 <= j <= n, i.ne.j;
!>                   A(i,i) = BETA , 1 <= i <= min(m,n)
!>

LDA

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

🌈 Author

Univ. of Tennessee

Univ. of California Berkeley

Univ. of Colorado Denver

NAG Ltd.

Definition at line 105 of file claset.f.

🦋 subroutine dlaset (character uplo, integer m, integer n, double precision alpha, double precision beta, double precision, dimension( lda, * ) a, integer lda)

DLASET initializes the off-diagonal elements and the diagonal elements of a matrix to given values.

🍓 Purpose:

!>
!> DLASET initializes an m-by-n matrix A to BETA on the diagonal and
!> ALPHA on the offdiagonals.
!>

🎀 Parameters

UPLO

!>          UPLO is CHARACTER*1
!>          Specifies the part of the matrix A to be set.
!>          = 'U':      Upper triangular part is set; the strictly lower
!>                      triangular part of A is not changed.
!>          = 'L':      Lower triangular part is set; the strictly upper
!>                      triangular part of A is not changed.
!>          Otherwise:  All of the matrix A is set.
!>

M

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

N

!>          N is INTEGER
!>          The number of columns of the matrix A.  N >= 0.
!>

ALPHA

!>          ALPHA is DOUBLE PRECISION
!>          The constant to which the offdiagonal elements are to be set.
!>

BETA

!>          BETA is DOUBLE PRECISION
!>          The constant to which the diagonal elements are to be set.
!>

A

!>          A is DOUBLE PRECISION array, dimension (LDA,N)
!>          On exit, the leading m-by-n submatrix of A is set as follows:
!>
!>          if UPLO = 'U', A(i,j) = ALPHA, 1<=i<=j-1, 1<=j<=n,
!>          if UPLO = 'L', A(i,j) = ALPHA, j+1<=i<=m, 1<=j<=n,
!>          otherwise,     A(i,j) = ALPHA, 1<=i<=m, 1<=j<=n, i.ne.j,
!>
!>          and, for all UPLO, A(i,i) = BETA, 1<=i<=min(m,n).
!>

LDA

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

🌈 Author

Univ. of Tennessee

Univ. of California Berkeley

Univ. of Colorado Denver

NAG Ltd.

Definition at line 109 of file dlaset.f.

🧁 subroutine slaset (character uplo, integer m, integer n, real alpha, real beta, real, dimension( lda, * ) a, integer lda)

SLASET initializes the off-diagonal elements and the diagonal elements of a matrix to given values.

🍓 Purpose:

!>
!> SLASET initializes an m-by-n matrix A to BETA on the diagonal and
!> ALPHA on the offdiagonals.
!>

🎀 Parameters

UPLO

!>          UPLO is CHARACTER*1
!>          Specifies the part of the matrix A to be set.
!>          = 'U':      Upper triangular part is set; the strictly lower
!>                      triangular part of A is not changed.
!>          = 'L':      Lower triangular part is set; the strictly upper
!>                      triangular part of A is not changed.
!>          Otherwise:  All of the matrix A is set.
!>

M

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

N

!>          N is INTEGER
!>          The number of columns of the matrix A.  N >= 0.
!>

ALPHA

!>          ALPHA is REAL
!>          The constant to which the offdiagonal elements are to be set.
!>

BETA

!>          BETA is REAL
!>          The constant to which the diagonal elements are to be set.
!>

A

!>          A is REAL array, dimension (LDA,N)
!>          On exit, the leading m-by-n submatrix of A is set as follows:
!>
!>          if UPLO = 'U', A(i,j) = ALPHA, 1<=i<=j-1, 1<=j<=n,
!>          if UPLO = 'L', A(i,j) = ALPHA, j+1<=i<=m, 1<=j<=n,
!>          otherwise,     A(i,j) = ALPHA, 1<=i<=m, 1<=j<=n, i.ne.j,
!>
!>          and, for all UPLO, A(i,i) = BETA, 1<=i<=min(m,n).
!>

LDA

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

🌈 Author

Univ. of Tennessee

Univ. of California Berkeley

Univ. of Colorado Denver

NAG Ltd.

Definition at line 109 of file slaset.f.

🫶 subroutine zlaset (character uplo, integer m, integer n, complex*16 alpha, complex*16 beta, complex*16, dimension( lda, * ) a, integer lda)

ZLASET initializes the off-diagonal elements and the diagonal elements of a matrix to given values.

🍓 Purpose:

!>
!> ZLASET initializes a 2-D array A to BETA on the diagonal and
!> ALPHA on the offdiagonals.
!>

🎀 Parameters

UPLO

!>          UPLO is CHARACTER*1
!>          Specifies the part of the matrix A to be set.
!>          = 'U':      Upper triangular part is set. The lower triangle
!>                      is unchanged.
!>          = 'L':      Lower triangular part is set. The upper triangle
!>                      is unchanged.
!>          Otherwise:  All of the matrix A is set.
!>

M

!>          M is INTEGER
!>          On entry, M specifies the number of rows of A.
!>

N

!>          N is INTEGER
!>          On entry, N specifies the number of columns of A.
!>

ALPHA

!>          ALPHA is COMPLEX*16
!>          All the offdiagonal array elements are set to ALPHA.
!>

BETA

!>          BETA is COMPLEX*16
!>          All the diagonal array elements are set to BETA.
!>

A

!>          A is COMPLEX*16 array, dimension (LDA,N)
!>          On entry, the m by n matrix A.
!>          On exit, A(i,j) = ALPHA, 1 <= i <= m, 1 <= j <= n, i.ne.j;
!>                   A(i,i) = BETA , 1 <= i <= min(m,n)
!>

LDA

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

🌈 Author

Univ. of Tennessee

Univ. of California Berkeley

Univ. of Colorado Denver

NAG Ltd.

Definition at line 105 of file zlaset.f.

⚠️ friendly lil heads up bestie: LDA >= max(1,M) is not a suggestion, it's a lifestyle. the manual says so, and the manual does not lie 💀

🌟 Author 🌟

Generated automatically by Doxygen for LAPACK from the source code. (yes, a robot wrote this, and it ate, honestly 🤖✨)

k that's the whole page, mwah 💋 — brought to you by LAPACK, Version 3.12.0, page laset(3), and yes the docs really did generate themselves automatically, main character energy fr fr 🌈👑

📦 where this page comes from