block.h

Go to the documentation of this file.

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

#ifndef BLOCK_H
#define BLOCK_H

typedef struct _block block;

typedef block *pblock;

typedef const block *pcblock;

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

#include "cluster.h"
#include "settings.h"

struct _block {
  pcluster rc;

  pcluster cc;

  bool a;

  pblock* son;

  uint rsons;

  uint csons;

  uint desc;
};

/* ------------------------------------------------------------
 * Admissibility condition
 * ------------------------------------------------------------ */

typedef bool (*admissible)(pcluster rc, pcluster cc, void *data);

HEADER_PREFIX bool
admissible_2_cluster(pcluster rc, pcluster cc, void* data);

HEADER_PREFIX bool
admissible_max_cluster(pcluster rc, pcluster cc, void* data);

HEADER_PREFIX bool
admissible_sphere_cluster(pcluster rc, pcluster cc, void* data);

HEADER_PREFIX bool
admissible_2_min_cluster(pcluster rc, pcluster cc, void* data);

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

HEADER_PREFIX pblock
new_block(pcluster rc, pcluster cc, bool a, uint rsons, uint csons);

HEADER_PREFIX void
del_block(pblock b);

HEADER_PREFIX void
update_block(pblock b);

/* ------------------------------------------------------------
 Block clustering strategies
 ------------------------------------------------------------ */

HEADER_PREFIX pblock
build_nonstrict_block(pcluster rc, pcluster cc, void *data, admissible admis);

HEADER_PREFIX pblock
build_nonstrict_lower_block(pcluster rc, pcluster cc, void *data, admissible admis);

HEADER_PREFIX pblock
build_strict_block(pcluster rc, pcluster cc, void *data, admissible admis);

HEADER_PREFIX pblock
build_strict_lower_block(pcluster rc, pcluster cc, void *data, admissible admis);

/* ------------------------------------------------------------
 * Drawing block trees
 * ------------------------------------------------------------ */

#ifdef USE_CAIRO

HEADER_PREFIX void
draw_cairo_block(cairo_t *cr, pcblock b, int levels);
#endif

/* ------------------------------------------------------------
 * Interactive visualization
 * ------------------------------------------------------------ */

HEADER_PREFIX void
view_block(pcblock b);

/* ------------------------------------------------------------
 * Hierarchical iterators
 * ------------------------------------------------------------ */

typedef struct _blockentry blockentry;

typedef blockentry *pblockentry;

typedef const blockentry *pcblockentry;

struct _blockentry {
  pcblock b;
  uint bname;
  uint rname;
  uint cname;
  pcblockentry father;
  pblockentry next;
};

HEADER_PREFIX void
iterate_block(pcblock b, uint bname, uint rname, uint cname,
    void (*pre)(pcblock b, uint bname, uint rname, uint cname, uint pardepth,
        void *data),
    void (*post)(pcblock b, uint bname, uint rname, uint cname, uint pardepth,
        void *data), void *data);

HEADER_PREFIX void
iterate_rowlist_block(pcblock b, uint bname, uint rname, uint cname,
    uint pardepth, void (*pre)(pcblockentry pb, uint pardepth, void *data),
    void (*post)(pcblockentry pb, uint pardepth, void *data), void *data);

HEADER_PREFIX void
iterate_collist_block(pcblock b, uint bname, uint rname, uint cname,
    uint pardepth, void (*pre)(pcblockentry pb, uint pardepth, void *data),
    void (*post)(pcblockentry pb, uint pardepth, void *data), void *data);

HEADER_PREFIX void
iterate_byrow_block(pcblock b, uint bname, uint rname, uint cname,
    uint pardepth,
    void (*pre)(pcblock b, uint bname, uint rname, uint cname, uint pardepth,
        void *data),
    void (*post)(pcblock b, uint bname, uint rname, uint cname, uint pardepth,
        void *data), void *data);

HEADER_PREFIX void
iterate_bycol_block(pcblock b, uint bname, uint rname, uint cname,
    uint pardepth,
    void (*pre)(pcblock b, uint bname, uint rname, uint cname, uint pardepth,
        void *data),
    void (*post)(pcblock b, uint bname, uint rname, uint cname, uint pardepth,
        void *data), void *data);

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

HEADER_PREFIX pblock *
enumerate_block(pblock t);

HEADER_PREFIX uint*
enumerate_level_block(pblock t);

/* ------------------------------------------------------------
 * Utility functions
 * ------------------------------------------------------------ */

HEADER_PREFIX uint
getdepth_block(pcblock b);

HEADER_PREFIX uint
compute_csp_block(pcblock b);

#endif