dh2matrix.h

Go to the documentation of this file.

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

#ifndef DH2MATRIX_H
#define DH2MATRIX_H

typedef struct _dh2matrix dh2matrix;

typedef dh2matrix *pdh2matrix;

typedef const dh2matrix *pcdh2matrix;

#include "settings.h"
#include "amatrix.h"
#include "krylov.h"
#include "h2matrix.h"
#include "dblock.h"
#include "duniform.h"
#include "dclusterbasis.h"
#include "dclusteroperator.h"

struct _dh2matrix {
  pdclusterbasis rb;
  pdclusterbasis cb;

  pduniform u;
  pamatrix f;

  pdh2matrix *son;
  uint rsons;
  uint csons;

  uint desc;
};

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

HEADER_PREFIX pdh2matrix
new_dh2matrix(pdclusterbasis rb, pdclusterbasis cb);

HEADER_PREFIX pdh2matrix
new_uniform_dh2matrix(pdclusterbasis rb, uint rd, pdclusterbasis cb, uint cd);

HEADER_PREFIX pdh2matrix
new_full_dh2matrix(pdclusterbasis rb, pdclusterbasis cb);

HEADER_PREFIX pdh2matrix
new_super_dh2matrix(pdclusterbasis rb, pdclusterbasis cb,
        uint rsons, uint csons);

HEADER_PREFIX void
update_dh2matrix(pdh2matrix h2);

HEADER_PREFIX void
del_dh2matrix(pdh2matrix h2);

HEADER_PREFIX pdh2matrix
clone_dh2matrix(pcdh2matrix dh2, pdclusterbasis rb, pdclusterbasis cb);

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

HEADER_PREFIX size_t
getsize_dh2matrix(pcdh2matrix h2);

HEADER_PREFIX size_t
getnearsize_dh2matrix(pcdh2matrix h2);

HEADER_PREFIX size_t
getfarsize_dh2matrix(pcdh2matrix h2);

HEADER_PREFIX size_t
gettotalsize_dh2matrix(pcdh2matrix h2);

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

#ifdef __GNUC__
INLINE_PREFIX uint
getrows_dh2matrix(pcdh2matrix h2) __attribute__ ((const,unused));
INLINE_PREFIX uint
getcols_dh2matrix(pcdh2matrix h2) __attribute__ ((const,unused));
#endif

INLINE_PREFIX uint
getrows_dh2matrix(pcdh2matrix h2)
{
  return h2->rb->t->size;
}

INLINE_PREFIX uint
getcols_dh2matrix(pcdh2matrix h2)
{
  return h2->cb->t->size;
}

/* ------------------------------------------------------------
 * Build directional H^2-matrix based on directional block tree
 * ------------------------------------------------------------ */

HEADER_PREFIX pdh2matrix
buildfromblock_dh2matrix(pcdblock b, pdclusterbasis rb, pdclusterbasis cb);

/* ------------------------------------------------------------
 * Copy nearfield matrices from a given dense matrix
 * ------------------------------------------------------------ */

HEADER_PREFIX void
copynear_dh2matrix(pcamatrix G, pdh2matrix Gh);

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

HEADER_PREFIX void
fastaddeval_dh2matrix_avector(field alpha, pcdh2matrix h2,
            pcavector xt, pavector yt);

HEADER_PREFIX void
fastaddevaltrans_dh2matrix_avector(field alpha, pcdh2matrix h2,
           pcavector xt, pavector yt);

HEADER_PREFIX void
addeval_dh2matrix_avector(field alpha, pcdh2matrix h2,
        pcavector x, pavector y);

HEADER_PREFIX void
addevaltrans_dh2matrix_avector(field alpha, pcdh2matrix h2,
             pcavector x, pavector y);

HEADER_PREFIX void
mvm_dh2matrix_avector(field alpha, bool h2trans, pcdh2matrix h2,
          pcavector x, pavector y);

/* ------------------------------------------------------------
 * Matrix-vector multiplication based on the
 * dclusterbasis parallel iterator
 * ------------------------------------------------------------ */

HEADER_PREFIX void
addeval_parallel_dh2matrix_avector(field alpha, pcdh2matrix h2,
           pcavector x, pavector y);

HEADER_PREFIX void
addevaltrans_parallel_dh2matrix_avector(field alpha, pcdh2matrix h2,
          pcavector x, pavector y);

/* ------------------------------------------------------------
 * Slow direct matrix-vector multiplication,
 * for debugging purposes
 * ------------------------------------------------------------ */

HEADER_PREFIX void
slowaddeval_dh2matrix_avector(field alpha, pcdh2matrix h2,
            pcavector x, pavector y);

HEADER_PREFIX void
slowaddevaltrans_dh2matrix_avector(field alpha, pcdh2matrix h2,
           pcavector x, pavector y);


/* ------------------------------------------------------------
 * Conversion to a full matrix
 * ------------------------------------------------------------ */

HEADER_PREFIX void
expand_dh2matrix(field alpha, pcdh2matrix h2, pamatrix G);

/* ------------------------------------------------------------
 * Hierarchical iterator
 * ------------------------------------------------------------ */

HEADER_PREFIX pdh2matrix *
enumerate_dh2matrix(pdh2matrix h2);

HEADER_PREFIX void
iterate_dh2matrix(pdh2matrix G, uint mname, uint rname, uint cname,
      uint pardepth,
      void (*pre)(pdh2matrix G, uint mname,
            uint rname, uint cname, uint pardepth,
            void *data),
      void (*post)(pdh2matrix G, uint mname,
             uint rname, uint cname, uint pardepth,
             void *data), void *data);

/* ------------------------------------------------------------
 * Matrix norms
 * ------------------------------------------------------------ */

HEADER_PREFIX real
norm2_dh2matrix(pcdh2matrix DH2);

HEADER_PREFIX real
norm2diff_dh2matrix(pcdh2matrix a, pcdh2matrix b);

/* ------------------------------------------------------------
 * Drawing
 * ------------------------------------------------------------ */

#ifdef USE_CAIRO

HEADER_PREFIX void
draw_cairo_dh2matrix(cairo_t * cr, pcdh2matrix G, bool storage,
         bool ranks, uint levels);
#endif

/* -----------------------------------------------------------
 * Resize, projection and recompression
 * ----------------------------------------------------------- */

HEADER_PREFIX void
resize_coupling_dh2matrix(pdh2matrix A, pdclusteroperator ro, pdclusteroperator co);

HEADER_PREFIX pdh2matrix
build_projected_dh2matrix(pcdh2matrix dh2, pdclusterbasis rb, pdclusterbasis cb, pdclusteroperator ro, pdclusteroperator co);

HEADER_PREFIX pdh2matrix
compress_dh2matrix_dh2matrix(pcdh2matrix G, bool rbortho, bool cbortho, pctruncmode tm, real eps);

HEADER_PREFIX void
truncate_dclusterbasis(pdclusterbasis cold, pdclusterbasis cnew, pdclusteroperator co, pdclusteroperator bco, pctruncmode tm, real eps);

#endif