# SRC/sutil.c File Reference

Matrix utility functions. More...

`#include <math.h>`
`#include "slu_sdefs.h"`

## Functions
void | sCreate_CompCol_Matrix (SuperMatrix *A, int m, int n, int nnz, float *nzval, int *rowind, int *colptr, Stype_t stype, Dtype_t dtype, Mtype_t mtype)
| Supernodal LU factor related.
void | sCreate_CompRow_Matrix (SuperMatrix *A, int m, int n, int nnz, float *nzval, int *colind, int *rowptr, Stype_t stype, Dtype_t dtype, Mtype_t mtype)
void | sCopy_CompCol_Matrix (SuperMatrix *A, SuperMatrix *B)
| Copy matrix A into matrix B.
void | sCreate_Dense_Matrix (SuperMatrix *X, int m, int n, float *x, int ldx, Stype_t stype, Dtype_t dtype, Mtype_t mtype)
void | sCopy_Dense_Matrix (int M, int N, float *X, int ldx, float *Y, int ldy)
void | sCreate_SuperNode_Matrix (SuperMatrix *L, int m, int n, int nnz, float *nzval, int *nzval_colptr, int *rowind, int *rowind_colptr, int *col_to_sup, int *sup_to_col, Stype_t stype, Dtype_t dtype, Mtype_t mtype)
void | sCompRow_to_CompCol (int m, int n, int nnz, float *a, int *colind, int *rowptr, float **at, int **rowind, int **colptr)
| Convert a row compressed storage into a column compressed storage.
void | sPrint_CompCol_Matrix (char *what, SuperMatrix *A)
| Routines for debugging.
void | sPrint_SuperNode_Matrix (char *what, SuperMatrix *A)
void | sPrint_Dense_Matrix (char *what, SuperMatrix *A)
void | sprint_lu_col (char *msg, int jcol, int pivrow, int *xprune, GlobalLU_t *Glu)
| Diagnostic print of column "jcol" in the U/L factor.
void | scheck_tempv (int n, float *tempv)
| Check whether tempv[] == 0. This should be true before and after calling any numeric routines, i.e., "panel_bmod" and "column_bmod".
void | sGenXtrue (int n, int nrhs, float *x, int ldx)
void | sFillRHS (trans_t trans, int nrhs, float *x, int ldx, SuperMatrix *A, SuperMatrix *B)
| Let rhs[i] = sum of i-th row of A, so the solution vector is all 1's.
void | sfill (float *a, int alen, float dval)
| Fills a float precision array with a given value.
void | sinf_norm_error (int nrhs, SuperMatrix *X, float *xtrue)
| Check the inf-norm of the error vector.
void | sPrintPerf (SuperMatrix *L, SuperMatrix *U, mem_usage_t *mem_usage, float rpg, float rcond, float *ferr, float *berr, char *equed, SuperLUStat_t *stat)
| Print performance of the code.
| print_float_vec (char *what, int n, float *vec)

## Detailed Description

     -- SuperLU routine (version 3.1) --
     Univ. of California Berkeley, Xerox Palo Alto Research Center,
     and Lawrence Berkeley National Lab.
     August 1, 2008

     Copyright (c) 1994 by Xerox Corporation.  All rights reserved.

     THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY
     EXPRESSED OR IMPLIED.  ANY USE IS AT YOUR OWN RISK.

     Permission is hereby granted to use or copy this program for any
     purpose, provided the above notices are retained on all copies.
     Permission to modify the code and to distribute modified code is
     granted, provided the above notices are retained, and a notice that
     the code was modified is included with the above copyright notice.

## Function Documentation

print_float_vec | ( | char * | what,
|  | int | n,
|  | float * | vec |
| ) |  |  |

void scheck_tempv | ( | int | n,
|  | float * | tempv |
| ) |  |  |

void sCompRow_to_CompCol | ( | int | m,
|  | int | n,
|  | int | nnz,
|  | float * | a,
|  | int * | colind,
|  | int * | rowptr,
|  | float ** | at,
|  | int ** | rowind,
|  | int ** | colptr |
| ) |  |  |

void sCopy_CompCol_Matrix | ( | SuperMatrix * | A,
|  | SuperMatrix * | B |
| ) |  |  |

void sCopy_Dense_Matrix | ( | int | M,
|  | int | N,
|  | float * | X,
|  | int | ldx,
|  | float * | Y,
|  | int | ldy |
| ) |  |  |

Copies a two-dimensional matrix X to another matrix Y.

void sCreate_CompCol_Matrix | ( | SuperMatrix * | A,
|  | int | m,
|  | int | n,
|  | int | nnz,
|  | float * | nzval,
|  | int * | rowind,
|  | int * | colptr,
|  | Stype_t | stype,
|  | Dtype_t | dtype,
|  | Mtype_t | mtype |
| ) |  |  |

void sCreate_CompRow_Matrix | ( | SuperMatrix * | A,
|  | int | m,
|  | int | n,
|  | int | nnz,
|  | float * | nzval,
|  | int * | colind,
|  | int * | rowptr,
|  | Stype_t | stype,
|  | Dtype_t | dtype,
|  | Mtype_t | mtype |
| ) |  |  |

void sCreate_Dense_Matrix | ( | SuperMatrix * | X,
|  | int | m,
|  | int | n,
|  | float * | x,
|  | int | ldx,
|  | Stype_t | stype,
|  | Dtype_t | dtype,
|  | Mtype_t | mtype |
| ) |  |  |

void sCreate_SuperNode_Matrix | ( | SuperMatrix * | L,
|  | int | m,
|  | int | n,
|  | int | nnz,
|  | float * | nzval,
|  | int * | nzval_colptr,
|  | int * | rowind,
|  | int * | rowind_colptr,
|  | int * | col_to_sup,
|  | int * | sup_to_col,
|  | Stype_t | stype,
|  | Dtype_t | dtype,
|  | Mtype_t | mtype |
| ) |  |  |

void sfill | ( | float * | a,
|  | int | alen,
|  | float | dval |
| ) |  |  |

void sFillRHS | ( | trans_t | trans,
|  | int | nrhs,
|  | float * | x,
|  | int | ldx,
|  | SuperMatrix * | A,
|  | SuperMatrix * | B |
| ) |  |  |

void sGenXtrue | ( | int | n,
|  | int | nrhs,
|  | float * | x,
|  | int | ldx |
| ) |  |  |

void sinf_norm_error | ( | int | nrhs,
|  | SuperMatrix * | X,
|  | float * | xtrue |
| ) |  |  |

void sPrint_CompCol_Matrix | ( | char * | what,
|  | SuperMatrix * | A |
| ) |  |  |

void sPrint_Dense_Matrix | ( | char * | what,
|  | SuperMatrix * | A |
| ) |  |  |

void sprint_lu_col | ( | char * | msg,
|  | int | jcol,
|  | int | pivrow,
|  | int * | xprune,
|  | GlobalLU_t * | Glu |
| ) |  |  |

void sPrint_SuperNode_Matrix | ( | char * | what,
|  | SuperMatrix * | A |
| ) |  |  |

void sPrintPerf | ( | SuperMatrix * | L,
|  | SuperMatrix * | U,
|  | mem_usage_t * | mem_usage,
|  | float | rpg,
|  | float | rcond,
|  | float * | ferr,
|  | float * | berr,
|  | char * | equed,
|  | SuperLUStat_t * | stat |
| ) |  |  |