h2matrix.h

Go to the documentation of this file.

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

#ifndef H2MATRIX_H
#define H2MATRIX_H

typedef struct _h2matrix h2matrix;

typedef h2matrix *ph2matrix;

typedef const h2matrix *pch2matrix;

#ifdef USE_CAIRO
#include <cairo/cairo.h>
#endif

#include "amatrix.h"
#include "krylov.h"
#include "block.h"
#include "hmatrix.h"
#include "uniform.h"
#include "clusterbasis.h"
#include "settings.h"

struct _h2matrix {
  pclusterbasis rb;
  pclusterbasis cb;

  puniform u;

  pamatrix f;

  ph2matrix *son;
  uint rsons;
  uint csons;

  uint refs;
  uint desc;
};

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

HEADER_PREFIX ph2matrix
new_h2matrix(pclusterbasis rb, pclusterbasis cb);

HEADER_PREFIX ph2matrix
new_uniform_h2matrix(pclusterbasis rb, pclusterbasis cb);

HEADER_PREFIX ph2matrix
new_full_h2matrix(pclusterbasis rb, pclusterbasis cb);

HEADER_PREFIX ph2matrix
new_super_h2matrix(pclusterbasis rb, pclusterbasis cb, uint rsons, uint csons);

HEADER_PREFIX ph2matrix
new_zero_h2matrix(pclusterbasis rb, pclusterbasis cb);

HEADER_PREFIX ph2matrix
clonestructure_h2matrix(pch2matrix h2, pclusterbasis rb, pclusterbasis cb);

/* clones a h2matrix, should be in the module h2matrix */
HEADER_PREFIX ph2matrix
clone_h2matrix(pch2matrix h2, pclusterbasis rb, pclusterbasis cb);

HEADER_PREFIX void
update_h2matrix(ph2matrix h2);

HEADER_PREFIX void
del_h2matrix(ph2matrix h2);

/* ------------------------------------------------------------
 * Reference counting
 * ------------------------------------------------------------ */

HEADER_PREFIX void
ref_h2matrix(ph2matrix *ptr, ph2matrix h2);

HEADER_PREFIX void
unref_h2matrix(ph2matrix h2);

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

HEADER_PREFIX size_t
getsize_h2matrix(pch2matrix h2);

HEADER_PREFIX size_t
gettotalsize_h2matrix(pch2matrix h2);

HEADER_PREFIX size_t
getnearsize_h2matrix(pch2matrix h2);

HEADER_PREFIX size_t
getfarsize_h2matrix(pch2matrix h2);

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

HEADER_PREFIX void
clear_h2matrix(ph2matrix h2);

void
scale_h2matrix(field alpha, ph2matrix h2);

void
random_h2matrix(ph2matrix h2);

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

HEADER_PREFIX ph2matrix
build_from_block_h2matrix(pcblock b, pclusterbasis rb, pclusterbasis cb);

/* ------------------------------------------------------------
 * Build block tree from H^2-matrix
 * ------------------------------------------------------------ */

HEADER_PREFIX pblock
build_from_h2matrix_block(pch2matrix G);

/* ------------------------------------------------------------
 * Enumeration by block number
 * ------------------------------------------------------------ */

HEADER_PREFIX ph2matrix *
enumerate_h2matrix( ph2matrix h2);

/* ------------------------------------------------------------
 * Hierarchical iterators
 * ------------------------------------------------------------ */

typedef struct _h2matrixlist h2matrixlist;

typedef h2matrixlist *ph2matrixlist;

typedef const h2matrixlist *pch2matrixlist;

struct _h2matrixlist {
  ph2matrix G;

  uint mname;

  uint rname;

  uint cname;

  pch2matrixlist father;

  ph2matrixlist next;
};

typedef void (*h2matrix_callback_t)(ph2matrix G,
            uint mname, uint rname, uint cname,
            uint pardepth, void *data);

typedef void (*h2matrixlist_callback_t)(pccluster t,
          uint tname,
          uint pardepth,
          pch2matrixlist hl,
          void *data);

HEADER_PREFIX void
iterate_h2matrix(ph2matrix G, uint mname, uint rname, uint cname,
     uint pardepth,
     h2matrix_callback_t pre, h2matrix_callback_t post,
     void *data);

HEADER_PREFIX void
iterate_rowlist_h2matrix(ph2matrix G, uint mname, uint rname, uint cname,
       uint pardepth,
       h2matrixlist_callback_t pre,
       h2matrixlist_callback_t post, void *data);

HEADER_PREFIX void
iterate_collist_h2matrix(ph2matrix G, uint mname, uint rname, uint cname,
       uint pardepth,
       h2matrixlist_callback_t pre,
       h2matrixlist_callback_t post, void *data);

HEADER_PREFIX void
iterate_byrow_h2matrix(ph2matrix G, uint mname, uint rname, uint cname,
           uint pardepth,
           h2matrix_callback_t pre, h2matrix_callback_t post,
           void *data);

HEADER_PREFIX void
iterate_bycol_h2matrix(ph2matrix G, uint mname, uint rname, uint cname,
           uint pardepth,
           h2matrix_callback_t pre, h2matrix_callback_t post,
           void *data);

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

HEADER_PREFIX void
mvm_h2matrix_avector(field alpha, bool h2trans, pch2matrix h2, pcavector x,
    pavector y);

HEADER_PREFIX void
fastaddeval_h2matrix_avector(field alpha, pch2matrix h2, pavector xt,
    pavector yt);

HEADER_PREFIX void
addeval_h2matrix_avector(field alpha, pch2matrix h2, pcavector x, pavector y);

HEADER_PREFIX void
fastaddevaltrans_h2matrix_avector(field alpha, pch2matrix h2, pavector xt,
    pavector yt);

HEADER_PREFIX void
addevaltrans_h2matrix_avector(field alpha, pch2matrix h2, pcavector x,
    pavector y);

HEADER_PREFIX void
addevalsymm_h2matrix_avector(field alpha, pch2matrix h2, pcavector x,
    pavector y);

/* ------------------------------------------------------------
 * Addmul H2-Matrices and Amatrix
 * ------------------------------------------------------------ */

HEADER_PREFIX void
fastaddmul_h2matrix_amatrix_amatrix(field alpha, bool atrans, pch2matrix A,
    pcamatrix Bt, pamatrix Ct);

HEADER_PREFIX void
addmul_h2matrix_amatrix_amatrix(field alpha, bool atrans, pch2matrix A,
    bool btrans, pcamatrix B, pamatrix C);

HEADER_PREFIX void
addmul_amatrix_h2matrix_amatrix(field alpha, bool atrans, pcamatrix A,
    bool btrans, pch2matrix B, pamatrix C);

/* ------------------------------------------------------------
 * Orthogonal projection
 * ------------------------------------------------------------ */

HEADER_PREFIX void
collectdense_h2matrix(pcamatrix a, pcclusterbasis rb, pcclusterbasis cb,
    pamatrix s);

HEADER_PREFIX void
project_amatrix_h2matrix(ph2matrix h2, pcamatrix a);

HEADER_PREFIX void
project_hmatrix_h2matrix(ph2matrix h2, phmatrix h);

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

HEADER_PREFIX real
norm2_h2matrix(pch2matrix H2);

HEADER_PREFIX real
norm2diff_h2matrix(pch2matrix a, pch2matrix b);

/* ------------------------------------------------------------
 * File I/O
 * ------------------------------------------------------------ */

#ifdef USE_NETCDF

HEADER_PREFIX void
write_cdf_h2matrix(pch2matrix G, const char *name);

HEADER_PREFIX void
write_cdfpart_h2matrix(pch2matrix G, int nc_file, const char *prefix);

HEADER_PREFIX ph2matrix
read_cdf_h2matrix(const char *name, pclusterbasis rb, pclusterbasis cb);

HEADER_PREFIX ph2matrix
read_cdfpart_h2matrix(int nc_file, const char *prefix,
          pclusterbasis rb, pclusterbasis cb);

HEADER_PREFIX void
write_cdfcomplete_h2matrix(pch2matrix G, const char *name);

HEADER_PREFIX ph2matrix
read_cdfcomplete_h2matrix(const char *name);
#endif

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

#ifdef USE_CAIRO

HEADER_PREFIX void
draw_cairo_h2matrix(cairo_t *cr, pch2matrix G, bool storage, uint levels);
#endif

#endif

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

#ifndef H2MATRIX_COMPLETE
#define H2MATRIX_COMPLETE

#ifdef __GNUC__
INLINE_PREFIX uint
getrows_h2matrix(pch2matrix) __attribute__ ((const,unused));
INLINE_PREFIX uint
getcols_h2matrix(pch2matrix) __attribute__ ((const,unused));
#endif

INLINE_PREFIX uint
getrows_h2matrix(pch2matrix h2)
{
  return h2->rb->t->size;
}

INLINE_PREFIX uint
getcols_h2matrix(pch2matrix h2)
{
  return h2->cb->t->size;
}

#endif