hmatrix.h

Go to the documentation of this file.

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

#ifndef HMATRIX_H
#define HMATRIX_H

typedef struct _hmatrix hmatrix;

typedef hmatrix *phmatrix;

typedef const hmatrix *pchmatrix;

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

#include "amatrix.h"
#include "krylov.h"
#include "factorizations.h"
#include "block.h"
#include "rkmatrix.h"
#include "settings.h"
#include "eigensolvers.h"
#include "sparsematrix.h"

struct _hmatrix {
  pccluster rc;
  pccluster cc;

  prkmatrix r;

  pamatrix f;

  phmatrix *son;
  uint rsons;
  uint csons;

  uint refs;
  uint desc;
};

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

HEADER_PREFIX phmatrix
init_hmatrix(phmatrix hm, pccluster rc, pccluster cc);

HEADER_PREFIX void
uninit_hmatrix(phmatrix hm);

HEADER_PREFIX phmatrix
new_hmatrix(pccluster rc, pccluster cc);

HEADER_PREFIX phmatrix
new_rk_hmatrix(pccluster rc, pccluster cc, uint k);

HEADER_PREFIX phmatrix
new_full_hmatrix(pccluster rc, pccluster cc);

HEADER_PREFIX phmatrix
new_super_hmatrix(pccluster rc, pccluster cc, uint rsons, uint csons);

HEADER_PREFIX phmatrix
clone_hmatrix(pchmatrix src);

HEADER_PREFIX phmatrix
clonestructure_hmatrix(pchmatrix src);

HEADER_PREFIX void
update_hmatrix(phmatrix hm);

HEADER_PREFIX void
del_hmatrix(phmatrix hm);

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

HEADER_PREFIX void
ref_hmatrix(phmatrix *ptr, phmatrix hm);

HEADER_PREFIX void
unref_hmatrix(phmatrix hm);

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

HEADER_PREFIX size_t
getsize_hmatrix(pchmatrix hm);

HEADER_PREFIX size_t
getnearsize_hmatrix(pchmatrix hm);

HEADER_PREFIX size_t
getfarsize_hmatrix(pchmatrix hm);

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

#ifdef __GNUC__
INLINE_PREFIX uint
getrows_hmatrix(pchmatrix) __attribute__ ((const,unused));
INLINE_PREFIX uint
getcols_hmatrix(pchmatrix) __attribute__ ((const,unused));
#endif

INLINE_PREFIX uint getrows_hmatrix(pchmatrix a) {
  return a->rc->size;
}

INLINE_PREFIX uint getcols_hmatrix(pchmatrix a) {
  return a->cc->size;
}

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

HEADER_PREFIX void
clear_hmatrix(phmatrix hm);

HEADER_PREFIX void
clear_upper_hmatrix(phmatrix hm, bool strict);

HEADER_PREFIX void
copy_hmatrix(pchmatrix src, phmatrix trg);

HEADER_PREFIX void
identity_hmatrix(phmatrix hm);

HEADER_PREFIX void
random_hmatrix(phmatrix hm, uint kmax);

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

HEADER_PREFIX phmatrix
build_from_block_hmatrix(pcblock b, uint k);

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

HEADER_PREFIX pblock
build_from_hmatrix_block(pchmatrix G);

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

HEADER_PREFIX void
mvm_hmatrix_avector(field alpha, bool atrans, pchmatrix a, pcavector x,
    pavector y);

HEADER_PREFIX void
fastaddeval_hmatrix_avector(field alpha, pchmatrix hm, pcavector xp,
    pavector yp);

HEADER_PREFIX void
addeval_hmatrix_avector(field alpha, pchmatrix hm, pcavector x, pavector y);

HEADER_PREFIX void
fastaddevaltrans_hmatrix_avector(field alpha, pchmatrix hm, pcavector xp,
    pavector yp);

HEADER_PREFIX void
addevaltrans_hmatrix_avector(field alpha, pchmatrix hm, pcavector x, pavector y);

HEADER_PREFIX void
fastaddevalsymm_hmatrix_avector(field alpha, pchmatrix hm, pcavector xp,
    pavector yp);

HEADER_PREFIX void
addevalsymm_hmatrix_avector(field alpha, pchmatrix hm, pcavector x, pavector y);

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

HEADER_PREFIX phmatrix *
enumerate_hmatrix(pcblock b, phmatrix hm);

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

HEADER_PREFIX real
norm2_hmatrix(pchmatrix H);

HEADER_PREFIX real
norm2diff_hmatrix(pchmatrix a, pchmatrix b);

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

#ifdef USE_NETCDF

HEADER_PREFIX void
write_cdf_hmatrix(pchmatrix G, const char *name);

HEADER_PREFIX void
write_cdfpart_hmatrix(pchmatrix G, int nc_file, const char *prefix);

HEADER_PREFIX phmatrix
read_cdf_hmatrix(const char *name, pccluster rc, pccluster cc);

HEADER_PREFIX phmatrix
read_cdfpart_hmatrix(int nc_file, const char *prefix,
    pccluster rc, pccluster cc);

HEADER_PREFIX void
write_cdfcomplete_hmatrix(pchmatrix G, const char *name);

HEADER_PREFIX phmatrix
read_cdfcomplete_hmatrix(const char *name);
#endif

HEADER_PREFIX void
write_hlib_hmatrix(pchmatrix G, const char *filename);

HEADER_PREFIX phmatrix
read_hlib_hmatrix(const char *filename);

HEADER_PREFIX phmatrix
read_hlibsymm_hmatrix(const char *filename);

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

#ifdef USE_CAIRO

HEADER_PREFIX void
draw_cairo_hmatrix(cairo_t *cr, pchmatrix hm, bool storage, uint levels);
#endif


/* ------------------------------------------------------------
 * Copy entries of a sparse matrix 
 * ------------------------------------------------------------ */

HEADER_PREFIX void
copy_sparsematrix_hmatrix(psparsematrix sp, phmatrix hm);

#endif