cluster.h

Go to the documentation of this file.

/* ------------------------------------------------------------
 * This is the file "cluster.h" of the H2Lib package.
 * All rights reserved, Knut Reimer 2009
 * ------------------------------------------------------------ */

#ifndef CLUSTER_H
#define CLUSTER_H

typedef struct _cluster cluster;

typedef cluster* pcluster;

typedef const cluster *pccluster;

#include "settings.h"
#include "clustergeometry.h"

struct _cluster {
  uint size;

  uint *idx;

  uint sons;

  pcluster* son;

  uint dim;

  real *bmin;

  real *bmax;

  uint desc;

  uint type;
};

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

HEADER_PREFIX pcluster
new_cluster(uint size, uint *idx, uint sons, uint dim);

HEADER_PREFIX void
del_cluster(pcluster t);

HEADER_PREFIX void
update_cluster(pcluster t);


/* ------------------------------------------------------------
 Clustering strategies
 ------------------------------------------------------------ */

typedef enum {
  H2_ADAPTIVE,
  H2_REGULAR,
  H2_SIMSUB,
  H2_PCA
} clustermode;

HEADER_PREFIX pcluster
build_adaptive_cluster(pclustergeometry cf, uint size, uint *idx, uint clf);

HEADER_PREFIX pcluster
build_regular_cluster(pclustergeometry cf, uint size, uint *idx, uint clf,
    uint direction);

HEADER_PREFIX pcluster
build_simsub_cluster(pclustergeometry cf, uint size, uint *idx, uint clf);

HEADER_PREFIX pcluster
build_pca_cluster(pclustergeometry cf, uint size, uint* idx, uint clf);

HEADER_PREFIX pcluster
build_cluster(pclustergeometry cf, uint size, uint *idx, uint clf,
    clustermode mode);



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

HEADER_PREFIX uint
getdepth_cluster(pccluster t);

HEADER_PREFIX uint
getmindepth_cluster(pccluster t);

/* ------------------------------------------------------------
 * Structure Adaptation
 * ------------------------------------------------------------ */

HEADER_PREFIX void
extend_cluster(pcluster t, uint depth);

HEADER_PREFIX void
cut_cluster(pcluster t, uint depth);

HEADER_PREFIX void
balance_cluster(pcluster t, uint depth);

HEADER_PREFIX void
coarsen_cluster(pcluster t, uint minsize);

HEADER_PREFIX void
setsons_cluster(pcluster t, uint sons);

/* ------------------------------------------------------------
 * Bounding box
 * ------------------------------------------------------------ */

HEADER_PREFIX real
getdiam_2_cluster(pccluster t);

HEADER_PREFIX real
getdist_2_cluster(pccluster t, pccluster s);

HEADER_PREFIX real
getdiam_max_cluster(pccluster t);

HEADER_PREFIX real
getdist_max_cluster(pccluster t, pccluster s);

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

HEADER_PREFIX void
iterate_cluster(pccluster t, uint tname,
    void (*pre)(pccluster t, uint tname, void *data),
    void (*post)(pccluster t, uint tname, void *data), void *data);

HEADER_PREFIX void
iterate_parallel_cluster(pccluster t, uint tname, uint pardepth,
    void (*pre)(pccluster t, uint tname, void *data),
    void (*post)(pccluster t, uint tname, void *data), void *data);

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

HEADER_PREFIX pcluster *
enumerate_cluster(pcluster t);

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

#ifdef USE_NETCDF

HEADER_PREFIX void
write_cdf_cluster(pccluster t, const char *name);

HEADER_PREFIX void
write_cdfpart_cluster(pccluster t, int nc_file, const char *prefix);

HEADER_PREFIX pcluster
read_cdf_cluster(const char *name);

HEADER_PREFIX pcluster
read_cdfpart_cluster(int nc_file, const char *prefix);
#endif

#endif