MatTranspose#

Computes the transpose of a matrix, either in-place or out-of-place.

Synopsis#

#include "petscmat.h" 
PetscErrorCode MatTranspose(Mat mat, MatReuse reuse, Mat *B)

Collective

Input Parameters#

mat - the matrix to transpose
reuse - either MAT_INITIAL_MATRIX, MAT_REUSE_MATRIX, or MAT_INPLACE_MATRIX

Output Parameter#

B - the transpose of the matrix

Notes#

If you use MAT_INPLACE_MATRIX then you must pass in &mat for B

MAT_REUSE_MATRIX uses the B matrix obtained from a previous call to this function with MAT_INITIAL_MATRIX to store the transpose. If you already have a matrix to contain the transpose, call MatTransposeSetPrecursor(mat, B) before calling this routine.

If the nonzero structure of mat changed from the previous call to this function with the same matrices an error will be generated for some matrix types.

Consider using MatCreateTranspose() instead if you only need a matrix that behaves like the transpose but don’t need the storage to be changed. For example, the result of MatCreateTranspose() will compute the transpose of the given matrix times a vector for matrix-vector products computed with MatMult().

If mat is unchanged from the last call this function returns immediately without recomputing the result

If you only need the symbolic transpose of a matrix, and not the numerical values, use MatTransposeSymbolic()

Level#

intermediate

Location#

src/mat/interface/matrix.c

Examples#

src/tao/pde_constrained/tutorials/parabolic.c
src/ksp/ksp/tutorials/ex79.c
src/snes/tutorials/ex70.c
src/ksp/ksp/tutorials/ex87.c
src/ksp/ksp/tutorials/ex65.c
src/ksp/ksp/tutorials/ex43.c
src/ksp/pc/tutorials/ex4.c
src/ksp/ksp/tutorials/ex74.c
src/tao/pde_constrained/tutorials/hyperbolic.c

Implementations#

Index of all Mat routines
Table of Contents for all manual pages
Index of all manual pages