rkmatrix.h

Go to the documentation of this file.

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

#ifndef RKMATRIX_H
#define RKMATRIX_H

typedef struct _rkmatrix rkmatrix;

typedef rkmatrix *prkmatrix;

typedef const rkmatrix *pcrkmatrix;

#include "amatrix.h"
#include "krylov.h"
#include "settings.h"

struct _rkmatrix {
  amatrix A;
  amatrix B;

  uint k;
};

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

HEADER_PREFIX prkmatrix
init_rkmatrix(prkmatrix r, uint rows, uint cols, uint k);

HEADER_PREFIX pcrkmatrix
init_sub_rkmatrix(prkmatrix r, pcrkmatrix src, uint rows, uint roff, uint cols,
    uint coff);

HEADER_PREFIX void
uninit_rkmatrix(prkmatrix r);

HEADER_PREFIX prkmatrix
new_rkmatrix(uint rows, uint cols, uint k);

HEADER_PREFIX pcrkmatrix
new_sub_rkmatrix(pcrkmatrix src, uint rows, uint roff, uint cols, uint coff);

HEADER_PREFIX void
del_rkmatrix(prkmatrix r);

/* ------------------------------------------------------------
 * Change rank
 * ------------------------------------------------------------ */

void
setrank_rkmatrix(prkmatrix r, uint k);

void
resize_rkmatrix(prkmatrix r, uint rows, uint cols, uint k);

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

HEADER_PREFIX size_t
getsize_rkmatrix(pcrkmatrix r);

HEADER_PREFIX size_t
getsize_heap_rkmatrix(pcrkmatrix r);

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

HEADER_PREFIX prkmatrix
clone_rkmatrix(pcrkmatrix r);

HEADER_PREFIX void
copy_rkmatrix(bool atrans, pcrkmatrix a, prkmatrix b);

HEADER_PREFIX void
scale_rkmatrix(field alpha, prkmatrix r);

HEADER_PREFIX void
random_rkmatrix(prkmatrix r, uint kmax);

/* ------------------------------------------------------------
 * Matrix-vector multiplication
 * ------------------------------------------------------------ */

HEADER_PREFIX void
addeval_rkmatrix_avector(field alpha, pcrkmatrix r, pcavector x, pavector y);

HEADER_PREFIX void
addevaltrans_rkmatrix_avector(field alpha, pcrkmatrix r, pcavector x,
    pavector y);

HEADER_PREFIX void
mvm_rkmatrix_avector(field alpha, bool rtrans, pcrkmatrix r, pcavector x,
    pavector y);

/* ------------------------------------------------------------
 * Spectral norm
 * ------------------------------------------------------------ */

HEADER_PREFIX real
norm2_rkmatrix(pcrkmatrix R);

HEADER_PREFIX real
norm2diff_rkmatrix(pcrkmatrix a, pcrkmatrix b);

#endif

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

#ifndef RKMATRIX_COMPLETE
#define RKMATRIX_COMPLETE

#ifdef __GNUC__
INLINE_PREFIX uint
getrows_rkmatrix(pcrkmatrix) __attribute__ ((const,unused));
INLINE_PREFIX uint
getcols_rkmatrix(pcrkmatrix) __attribute__ ((const,unused));
INLINE_PREFIX uint
getrank_rkmatrix(pcrkmatrix r) __attribute__ ((const, unused));
INLINE_PREFIX pamatrix
getA_rkmatrix(prkmatrix r) __attribute__ ((unused));
INLINE_PREFIX pamatrix
getB_rkmatrix(prkmatrix r) __attribute__ ((unused));
#endif

INLINE_PREFIX uint
getrows_rkmatrix(pcrkmatrix r) {
  return r->A.rows;
}

INLINE_PREFIX uint
getcols_rkmatrix(pcrkmatrix r) {
  return r->B.rows;
}

INLINE_PREFIX uint
getrank_rkmatrix(pcrkmatrix r) {
  assert(r->A.cols == r->B.cols);

  return r->A.cols;
}

INLINE_PREFIX pamatrix
getA_rkmatrix(prkmatrix r) {
  return &r->A;
}

INLINE_PREFIX pamatrix
getB_rkmatrix(prkmatrix r) {
  return &r->B;
}

#endif