amatrix.h

Go to the documentation of this file.

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

#ifndef AMATRIX_H
#define AMATRIX_H

typedef struct _amatrix amatrix;

typedef amatrix *pamatrix;

typedef const amatrix *pcamatrix;

#include <assert.h>
#include <math.h>
#include <stdlib.h>

#include "basic.h"
#include "settings.h"
#include "blas.h"
#include "avector.h"
#include "realavector.h"
#include "krylov.h"

struct _amatrix {
  field *a;

  uint ld;

  uint rows;
  uint cols;

  void *owner;
};

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

HEADER_PREFIX pamatrix
init_amatrix(pamatrix a, uint rows, uint cols);

HEADER_PREFIX pamatrix
init_sub_amatrix(pamatrix a, pamatrix src, uint rows, uint roff, uint cols,
    uint coff);

HEADER_PREFIX pamatrix
init_vec_amatrix(pamatrix a, pavector src, uint rows, uint cols);

HEADER_PREFIX pamatrix
init_pointer_amatrix(pamatrix a, pfield src, uint rows, uint cols);

HEADER_PREFIX pamatrix
init_zero_amatrix(pamatrix a, uint rows, uint cols);

HEADER_PREFIX pamatrix
init_identity_amatrix(pamatrix a, uint rows, uint cols);

HEADER_PREFIX void
uninit_amatrix(pamatrix a);

HEADER_PREFIX pamatrix
new_amatrix(uint rows, uint cols);

HEADER_PREFIX pamatrix
new_sub_amatrix(pamatrix src, uint rows, uint roff, uint cols, uint coff);

HEADER_PREFIX pamatrix
new_pointer_amatrix(field *src, uint rows, uint cols);

HEADER_PREFIX pamatrix
new_zero_amatrix(uint rows, uint cols);

HEADER_PREFIX pamatrix
new_identity_amatrix(uint rows, uint cols);

HEADER_PREFIX void
del_amatrix(pamatrix a);

HEADER_PREFIX void
resize_amatrix(pamatrix a, uint rows, uint cols);

HEADER_PREFIX void
resizecopy_amatrix(pamatrix a, uint rows, uint cols);

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

#ifdef __GNUC__
INLINE_PREFIX field
getentry_amatrix(pcamatrix, uint, uint) __attribute__ ((const,unused));
INLINE_PREFIX void
setentry_amatrix(pamatrix, uint, uint, field) __attribute__((unused));
INLINE_PREFIX field
addentry_amatrix(pamatrix, uint, uint, field) __attribute__((unused));
#endif

INLINE_PREFIX field getentry_amatrix(pcamatrix a, uint row, uint col) {
  longindex lda = a->ld;
#ifdef FULL_DEBUG
  assert(row < a->rows);
  assert(col < a->cols);
#endif

  return a->a[row + lda * col];
}

INLINE_PREFIX void setentry_amatrix(pamatrix a, uint row, uint col, field x) {
  longindex lda = a->ld;
#ifdef FULL_DEBUG
  assert(row < a->rows);
  assert(col < a->cols);
#endif

  a->a[row + lda * col] = x;
}

INLINE_PREFIX field addentry_amatrix(pamatrix a, uint row, uint col, field x) {
  longindex lda = a->ld;
#ifdef FULL_DEBUG
  assert(row < a->rows);
  assert(col < a->cols);
#endif

  return (a->a[row + lda * col] += x);
}

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

HEADER_PREFIX uint
getactives_amatrix();

HEADER_PREFIX size_t
getsize_amatrix(pcamatrix a);

HEADER_PREFIX size_t
getsize_heap_amatrix(pcamatrix a);

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

HEADER_PREFIX void
clear_amatrix(pamatrix a);

HEADER_PREFIX void
clear_lower_amatrix(pamatrix a, bool strict);

HEADER_PREFIX void
clear_upper_amatrix(pamatrix a, bool strict);

HEADER_PREFIX void
identity_amatrix(pamatrix a);

HEADER_PREFIX void
random_amatrix(pamatrix a);

HEADER_PREFIX void
random_invertible_amatrix(pamatrix a, real alpha);

HEADER_PREFIX void
random_selfadjoint_amatrix(pamatrix a);

HEADER_PREFIX void
random_spd_amatrix(pamatrix a, real alpha);

HEADER_PREFIX void
copy_amatrix(bool atrans, pcamatrix a, pamatrix b);

HEADER_PREFIX void
copy_colpiv_amatrix(bool atrans, pcamatrix a, const uint *colpiv,
        pamatrix b);

HEADER_PREFIX pamatrix
clone_amatrix(pcamatrix src);

HEADER_PREFIX void
copy_sub_amatrix(bool atrans, pcamatrix a, pamatrix b);

HEADER_PREFIX void
print_amatrix(pcamatrix a);

HEADER_PREFIX void
print_matlab_amatrix(pcamatrix a);

HEADER_PREFIX real
check_ortho_amatrix(bool atrans, pcamatrix a);

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

HEADER_PREFIX void
scale_amatrix(field alpha, pamatrix a);

HEADER_PREFIX void
conjugate_amatrix(pamatrix a);

HEADER_PREFIX field
dotprod_amatrix(pcamatrix a, pcamatrix b);

HEADER_PREFIX real
norm2_amatrix(pcamatrix A);

HEADER_PREFIX real
normfrob_amatrix(pcamatrix a);

HEADER_PREFIX real
normfrob2_amatrix(pcamatrix a);

HEADER_PREFIX real
norm2diff_amatrix(pcamatrix a, pcamatrix b);

HEADER_PREFIX void
addeval_amatrix_avector(field alpha, pcamatrix a, pcavector src, pavector trg);

HEADER_PREFIX void
addevaltrans_amatrix_avector(field alpha, pcamatrix a, pcavector src,
    pavector trg);

HEADER_PREFIX void
mvm_amatrix_avector(field alpha, bool atrans, pcamatrix a, pcavector src,
    pavector trg);

HEADER_PREFIX void
add_amatrix(field alpha, bool atrans, pcamatrix a, pamatrix b);

HEADER_PREFIX void
addmul_amatrix(field alpha, bool atrans, pcamatrix a, bool btrans, pcamatrix b,
    pamatrix c);

HEADER_PREFIX void
bidiagmul_amatrix(field alpha, bool atrans, pamatrix a, pcavector d,
    pcavector l);

#endif