sparsematrix.h

Go to the documentation of this file.

/* ------------------------------------------------------------
 * This is the file "sparsematrix.h" of the H2Lib package.
 * All rights reserved, Steffen Boerm 2012
 * ------------------------------------------------------------ */

#ifndef SPARSEMATRIX_H
#define SPARSEMATRIX_H

typedef struct _sparsematrix sparsematrix;

typedef sparsematrix *psparsematrix;

typedef const sparsematrix *pcsparsematrix;

#include "basic.h"
#include "avector.h"
#include "sparsepattern.h"
#include "krylov.h"

struct _sparsematrix {
  uint rows;
  uint cols;
  uint nz;

  uint *row;
  uint *col;
  pfield coeff;
};

/* ------------------------------------------------------------ *
 * Constructors and destructors                                 *
 * ------------------------------------------------------------ */

HEADER_PREFIX psparsematrix
new_raw_sparsematrix(uint rows, uint cols, uint nz);

HEADER_PREFIX psparsematrix
new_identity_sparsematrix(uint rows, uint cols);

HEADER_PREFIX psparsematrix
new_zero_sparsematrix(psparsepattern sp);

HEADER_PREFIX void
del_sparsematrix(psparsematrix a);

/* ------------------------------------------------------------ *
 * Access methods
 * ------------------------------------------------------------ */

HEADER_PREFIX field
addentry_sparsematrix(psparsematrix a, uint row, uint col, field x);

HEADER_PREFIX void
setentry_sparsematrix(psparsematrix a, uint row, uint col, field x);

/* ------------------------------------------------------------
 * Statistics
 * ------------------------------------------------------------ */

HEADER_PREFIX size_t
getsize_sparsematrix(pcsparsematrix a);

/* ------------------------------------------------------------
 * Simple utility functions
 * ------------------------------------------------------------ */

HEADER_PREFIX void
sort_sparsematrix(psparsematrix a);

HEADER_PREFIX void
clear_sparsematrix(psparsematrix a);

HEADER_PREFIX void
print_sparsematrix(pcsparsematrix a);

HEADER_PREFIX void
print_eps_sparsematrix(pcsparsematrix a, const char *filename, uint offset);

/* ------------------------------------------------------------
 * Basic linear algebra
 * ------------------------------------------------------------ */

HEADER_PREFIX void
addeval_sparsematrix_avector(field alpha, pcsparsematrix a, pcavector x,
    pavector y);

HEADER_PREFIX void
addevaltrans_sparsematrix_avector(field alpha, pcsparsematrix a, pcavector x,
    pavector y);

HEADER_PREFIX void
mvm_sparsematrix_avector(field alpha, bool trans, pcsparsematrix a, pcavector x,
    pavector y);

HEADER_PREFIX real
norm2_sparsematrix(pcsparsematrix S);

HEADER_PREFIX real
norm2diff_sparsematrix(pcsparsematrix a, pcsparsematrix b);

HEADER_PREFIX void
add_sparsematrix_amatrix(field alpha, bool atrans, pcsparsematrix a, pamatrix b);

#endif