clusterbasis.h

Go to the documentation of this file.

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

#ifndef CLUSTERBASIS_H
#define CLUSTERBASIS_H

typedef struct _clusterbasis clusterbasis;

typedef clusterbasis *pclusterbasis;

typedef const clusterbasis *pcclusterbasis;

#include "cluster.h"
#include "clusteroperator.h"
#include "uniform.h"
#include "amatrix.h"

struct _clusterbasis {
  pccluster t;

  uint k;
  uint ktree;
  uint kbranch;

  amatrix V;
  amatrix E;

  uint sons;
  pclusterbasis *son;

  pamatrix Z;

  uint refs;

  puniform rlist;
  puniform clist;
};

/* Now the "clusterbasis" type is completely defined */
#define CLUSTERBASIS_TYPE_COMPLETE

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

HEADER_PREFIX pclusterbasis
init_clusterbasis(pclusterbasis cb, pccluster t);

HEADER_PREFIX pclusterbasis
init_leaf_clusterbasis(pclusterbasis cb, pccluster t);

HEADER_PREFIX pclusterbasis
init_sub_clusterbasis(pclusterbasis cb, pclusterbasis src, pccluster t,
          uint off);

HEADER_PREFIX void
uninit_clusterbasis(pclusterbasis cb);

HEADER_PREFIX pclusterbasis
new_clusterbasis(pccluster t);

HEADER_PREFIX pclusterbasis
new_leaf_clusterbasis(pccluster t);

HEADER_PREFIX void
del_clusterbasis(pclusterbasis cb);

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

HEADER_PREFIX void
ref_clusterbasis(pclusterbasis *ptr, pclusterbasis cb);

HEADER_PREFIX void
unref_clusterbasis(pclusterbasis cb);

/* ------------------------------------------------------------
 * Low-level management
 * ------------------------------------------------------------ */

HEADER_PREFIX void
update_clusterbasis(pclusterbasis cb);

HEADER_PREFIX void
update_tree_clusterbasis(pclusterbasis cb);

HEADER_PREFIX void
resize_clusterbasis(pclusterbasis cb, uint k);

HEADER_PREFIX void
setrank_clusterbasis(pclusterbasis cb, uint k);

/* ------------------------------------------------------------
 * Build clusterbasis based on cluster
 * ------------------------------------------------------------ */

HEADER_PREFIX pclusterbasis
build_from_cluster_clusterbasis(pccluster t);

/* ------------------------------------------------------------
 * Clone a cluster basis
 * ------------------------------------------------------------ */

HEADER_PREFIX pclusterbasis
clone_clusterbasis(pcclusterbasis cb);

HEADER_PREFIX pclusterbasis
clonestructure_clusterbasis(pcclusterbasis cb);

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

HEADER_PREFIX uint
getactives_clusterbasis();

HEADER_PREFIX size_t
getsize_clusterbasis(pcclusterbasis cb);

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

HEADER_PREFIX void
clear_weight_clusterbasis(pclusterbasis cb);

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

HEADER_PREFIX void
iterate_clusterbasis(pcclusterbasis cb, uint cbname,
         void (*pre)(pcclusterbasis cb, uint cbname, void *data),
         void (*post)(pcclusterbasis cb, uint cbname, void *data),
         void *data);

HEADER_PREFIX void
iterate_parallel_clusterbasis(pcclusterbasis cb, uint cbname, uint pardepth,
            void (*pre)(pcclusterbasis cb, uint cbname, void *data),
            void (*post)(pcclusterbasis cb, uint cbname, void *data),
            void *data);

/* ------------------------------------------------------------
 * Enumeration by cluster number
 * ------------------------------------------------------------ */

HEADER_PREFIX pclusterbasis *
enumerate_clusterbasis(pccluster t, pclusterbasis cb);

/* ------------------------------------------------------------
 * Forward and backward transformation
 * ------------------------------------------------------------ */

HEADER_PREFIX pavector
new_coeffs_clusterbasis_avector(pcclusterbasis cb);

HEADER_PREFIX void
forward_clusterbasis_avector(pcclusterbasis cb, pcavector x, pavector xt);

HEADER_PREFIX void
forward_parallel_clusterbasis_avector(pcclusterbasis cb, pcavector x, pavector xt,
            uint pardepth);

HEADER_PREFIX void
forward_nopermutation_clusterbasis_avector(pcclusterbasis cb, pcavector xp,
           pavector xt);

HEADER_PREFIX void
forward_notransfer_clusterbasis_avector(pcclusterbasis cb, pcavector x, pavector xt);

HEADER_PREFIX void
backward_clusterbasis_avector(pcclusterbasis cb, pavector yt, pavector y);

HEADER_PREFIX void
backward_parallel_clusterbasis_avector(pcclusterbasis cb, pavector yt,
             pavector y, uint pardepth);

HEADER_PREFIX void
backward_nopermutation_clusterbasis_avector(pcclusterbasis cb, pavector yt,
            pavector yp);

HEADER_PREFIX void
backward_notransfer_clusterbasis_avector(pcclusterbasis cb, pavector yt, pavector y);

/* ------------------------------------------------------------
 * Forward and backward transformation for the root only
 * ------------------------------------------------------------ */

HEADER_PREFIX void
compress_clusterbasis_avector(pcclusterbasis cb, pcavector xp, pavector xt);

HEADER_PREFIX void
expand_clusterbasis_avector(pcclusterbasis cb, pavector yt, pavector yp);

HEADER_PREFIX void
compress_clusterbasis_amatrix(pcclusterbasis cb, pcamatrix Xp, pamatrix Xt);

void
compress_parallel_clusterbasis_amatrix(pcclusterbasis cb, pcamatrix Xp,
            pamatrix Xt, uint pardepth);

/* ------------------------------------------------------------
 * Forward and backward transformation for matrices
 * ------------------------------------------------------------ */

HEADER_PREFIX void
forward_clusterbasis_amatrix(pcclusterbasis cb, pcamatrix Xp, pamatrix Xt);

HEADER_PREFIX void
forward_clusterbasis_trans_amatrix(pcclusterbasis cb, pcamatrix Xp, pamatrix Xt);

HEADER_PREFIX void
backward_clusterbasis_amatrix(pcclusterbasis cb, pamatrix Yt, pamatrix Yp);

HEADER_PREFIX void
backward_clusterbasis_trans_amatrix(pcclusterbasis cb, pamatrix Yt, pamatrix Yp);

/* ------------------------------------------------------------
 * Simple computations
 * ------------------------------------------------------------ */

HEADER_PREFIX void
addeval_clusterbasis_avector(field alpha, pcclusterbasis cb,
         pcavector yc, pavector yp);

HEADER_PREFIX void
addevaltrans_clusterbasis_avector(field alpha, pcclusterbasis cb,
        pcavector xp, pavector xc);

/* ------------------------------------------------------------
 * Orthogonalization
 * ------------------------------------------------------------ */

HEADER_PREFIX void
ortho_clusterbasis(pclusterbasis cb, pclusteroperator co);

HEADER_PREFIX real
check_ortho_clusterbasis(pcclusterbasis cb);

HEADER_PREFIX pclusteroperator
weight_clusterbasis_clusteroperator(pcclusterbasis cb, pclusteroperator co);

HEADER_PREFIX pamatrix
weight_enum_clusterbasis_clusteroperator(pcclusterbasis cb);

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

#ifdef USE_NETCDF

HEADER_PREFIX void
write_cdf_clusterbasis(pcclusterbasis cb, const char *name);

HEADER_PREFIX void
write_cdfpart_clusterbasis(pcclusterbasis cb, int nc_file, const char *prefix);

HEADER_PREFIX pclusterbasis
read_cdf_clusterbasis(const char *name, pccluster t);

HEADER_PREFIX pclusterbasis
read_cdfpart_clusterbasis(int nc_file, const char *prefix, pccluster t);
#endif

#endif

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

/* Avoid problems with incomplete type definitions */
#if defined(CLUSTERBASIS_TYPE_COMPLETE) && !defined(CLUSTERBASIS_COMPLETE)
#define CLUSTERBASIS_COMPLETE

#ifdef __GNUC__
INLINE_PREFIX pamatrix
getE_clusterbasis(pclusterbasis) __attribute__ ((unused));
INLINE_PREFIX pamatrix
getV_clusterbasis(pclusterbasis) __attribute__ ((unused));
#endif

INLINE_PREFIX pamatrix
getE_clusterbasis(pclusterbasis cb)
{
  return &cb->E;
}

INLINE_PREFIX pamatrix
getV_clusterbasis(pclusterbasis cb)
{
  return &cb->V;
}

#endif