clusteroperator.h

Go to the documentation of this file.

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

#ifndef CLUSTEROPERATOR_H
#define CLUSTEROPERATOR_H

typedef struct _clusteroperator clusteroperator;

typedef clusteroperator *pclusteroperator;

typedef const clusteroperator *pcclusteroperator;

#include "cluster.h"
#include "clusterbasis.h"
#include "amatrix.h"

struct _clusteroperator
{
  pccluster t;
        
  uint krow;
  uint kcol;
       
  amatrix C;
        
  uint sons;
  pclusteroperator *son;

  uint refs;
};

#define CLUSTEROPERATOR_TYPE_COMPLETE

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

HEADER_PREFIX pclusteroperator
init_clusteroperator(pclusteroperator co, pccluster t);

HEADER_PREFIX pclusteroperator
init_leaf_clusteroperator(pclusteroperator co, pccluster t);

HEADER_PREFIX void
uninit_clusteroperator(pclusteroperator co);

HEADER_PREFIX pclusteroperator
new_clusteroperator(pccluster t);

HEADER_PREFIX pclusteroperator
new_leaf_clusteroperator(pccluster t);

HEADER_PREFIX void
del_clusteroperator(pclusteroperator co);

HEADER_PREFIX void
removesons_clusteroperator(pclusteroperator co);

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

HEADER_PREFIX void
ref_clusteroperator(pclusteroperator *ptr, pclusteroperator co);

HEADER_PREFIX void
unref_clusteroperator(pclusteroperator co);

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

HEADER_PREFIX void
update_clusteroperator(pclusteroperator co);

HEADER_PREFIX void
resize_clusteroperator(pclusteroperator co, uint krow, uint kcol);

HEADER_PREFIX pclusteroperator
identify_son_clusterweight_clusteroperator(pcclusteroperator cwf, pccluster t);

/* ------------------------------------------------------------
   Build cluster operator based on cluster tree of cluster basis
   ------------------------------------------------------------ */

HEADER_PREFIX pclusteroperator
build_from_cluster_clusteroperator(pccluster t);

HEADER_PREFIX pclusteroperator
build_from_clusterbasis_clusteroperator(pcclusterbasis cb);

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

HEADER_PREFIX uint
getactives_clusteroperator();

HEADER_PREFIX size_t
getsize_clusteroperator(pcclusteroperator co);

/* ------------------------------------------------------------
   Debugging
   ------------------------------------------------------------ */

HEADER_PREFIX void
print_tree_clusteroperator(pcclusteroperator co);

HEADER_PREFIX void
norm2diff_clusteroperator(pcclusteroperator co1, pcclusteroperator co2);

HEADER_PREFIX real
compareweights_clusteroperator(pcclusteroperator co1, pcclusteroperator co2);

/* ------------------------------------------------------------
   Enumeration
   ------------------------------------------------------------ */

HEADER_PREFIX pclusteroperator *
enumerate_clusteroperator(pccluster t, pclusteroperator co);

/* ------------------------------------------------------------
   Cluster basis product
   ------------------------------------------------------------ */

HEADER_PREFIX void
basisproduct_clusteroperator(pcclusterbasis cb1, pcclusterbasis cb2,
           pclusteroperator pr);

#endif

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

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

#ifdef __GNUC__
INLINE_PREFIX pamatrix
getC_clusteroperator(pclusteroperator) __attribute__ ((unused));
#endif

/* @brief Get the coefficient matrix @f$C@f$ of a @ref clusteroperator.
 *
 * @param co Cluster operator.
 * @returns Coefficient matrix @f$C@f$ */
INLINE_PREFIX pamatrix
getC_clusteroperator(pclusteroperator co)
{
  return &co->C;
}

#endif