uniform.h

Go to the documentation of this file.

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

#ifndef UNIFORM_H
#define UNIFORM_H

typedef struct _uniform uniform;

typedef uniform *puniform;

typedef const uniform *pcuniform;

/* C STD LIBRARY */
/* CORE 0 */
#include "settings.h"
/* CORE 1 */
#include "amatrix.h"
/* CORE 2 */
#include "clusterbasis.h"
#include "clusteroperator.h"
#include "rkmatrix.h"
/* CORE 3 */
/* SIMPLE */
/* PARTICLES */
/* BEM */

struct _uniform {
  pclusterbasis rb;
  pclusterbasis cb;
  amatrix S;
  puniform rnext;
  puniform rprev;
  puniform cnext;
  puniform cprev;
};

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

HEADER_PREFIX puniform
new_uniform(pclusterbasis rb, pclusterbasis cb);

HEADER_PREFIX void
del_uniform(puniform u);

/* ------------------------------------------------------------
 * Reference management
 * ------------------------------------------------------------ */

HEADER_PREFIX void
ref_row_uniform(puniform u, pclusterbasis rb);

HEADER_PREFIX void
ref_col_uniform(puniform u, pclusterbasis cb);

HEADER_PREFIX void
unref_row_uniform(puniform u);

HEADER_PREFIX void
unref_col_uniform(puniform u);

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

HEADER_PREFIX size_t
getsize_uniform(pcuniform u);

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

HEADER_PREFIX void
clear_uniform(puniform u);

HEADER_PREFIX void
copy_uniform(bool trans, pcuniform src, puniform trg);

HEADER_PREFIX puniform
clone_uniform(pcuniform src);

HEADER_PREFIX void
scale_uniform(field alpha, puniform u);

HEADER_PREFIX void
random_uniform(puniform u);

// * @brief Computes the euclidean-norm of the coupling matrix and or the product
// * of weight matrices with the coupling matrix.
// *
// * Depending on given row- and column-@ref _clusteroperator "clusteroperators"
// * this functions computed one of the following four values via
// * vector iteration:
// * @f[
// * \lVert S_b \rVert_2, \quad \lVert C_t S_b \rVert_2, \quad
// * \lVert S_b C_s^* \rVert_2 \quad \text{or} \quad \lVert C_t S_b C_s^* \rVert_2
// * @f]
// *
// * @param u @ref _uniform "uniform" object.
// * @param rw Row @ref _clusteroperator "clusteroperator". If <tt>rw == NULL</tt>
// * then @f$ C_t @f$ is omitted in the computation of the norm.
// * @param cw Column @ref _clusteroperator "clusteroperator". If <tt>cw == NULL</tt>
// * then @f$ C_s @f$ is omitted in the computation of the norm.
// *
// * @return Approximation of the euclidean-norm of one of the above mentioned
// * matrices.
// */
//HEADER_PREFIX real
//norm2_fast_uniform(pcuniform u, pcclusteroperator rw, pcclusteroperator cw);
//
// * @brief Computes the frobenius-norm of the coupling matrix and or the product
// * of weight matrices with the coupling matrix.
// *
// * Depending on given row- and column-@ref _clusteroperator "clusteroperators"
// * this functions computed one of the following four values:
// * @f[
// * \lVert S_b \rVert_F, \quad \lVert C_t S_b \rVert_F, \quad
// * \lVert S_b C_s^* \rVert_F \quad \text{or} \quad \lVert C_t S_b C_s^* \rVert_F
// * @f]
// *
// * @param u @ref _uniform "uniform" object.
// * @param rw Row @ref _clusteroperator "clusteroperator". If <tt>rw == NULL</tt>
// * then @f$ C_t @f$ is omitted in the computation of the norm.
// * @param cw Column @ref _clusteroperator "clusteroperator". If <tt>cw == NULL</tt>
// * then @f$ C_s @f$ is omitted in the computation of the norm.
// *
// * @return Approximation of the frobenius-norm of one of the above mentioned
// * matrices.
// */
//HEADER_PREFIX real
//normfrob_fast_uniform(pcuniform u, pcclusteroperator rw, pcclusteroperator cw);

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

HEADER_PREFIX void
mvm_uniform_avector(field alpha, bool trans, pcuniform u, pcavector x, pavector y);

/* ------------------------------------------------------------
 * Conversion operations
 * ------------------------------------------------------------ */

HEADER_PREFIX void
add_projected_uniform(pcuniform u, pcclusteroperator ro, pcclusteroperator co,
    puniform unew);

HEADER_PREFIX void
project_inplace_uniform(puniform u, pclusterbasis rb, pcclusteroperator ro,
    pclusterbasis cb, pcclusteroperator co);

HEADER_PREFIX void
add_rkmatrix_uniform(pcrkmatrix r, puniform unew);

#endif

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

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

#ifdef __GNUC__
INLINE_PREFIX uint
getrows_uniform(pcuniform) __attribute__ ((const,unused));
INLINE_PREFIX uint
getcols_uniform(pcuniform) __attribute__ ((const,unused));
INLINE_PREFIX pamatrix
getS_uniform(puniform) __attribute__ ((unused));
#endif

INLINE_PREFIX uint
getrows_uniform(pcuniform u)
{
  return u->rb->t->size;
}

INLINE_PREFIX uint
getcols_uniform(pcuniform u)
{
  return u->cb->t->size;
}

INLINE_PREFIX pamatrix
getS_uniform(puniform u)
{
  return &u->S;
}

#endif