clustering_goptics.h

Go to the documentation of this file.

/* 
 * This file is part of biomcmc-lib, a low-level library for phylogenomic analysis.
 * Copyright (C) 2019-today  Leonardo de Oliveira Martins [ leomrtns at gmail.com;  http://www.leomartins.org ]
 *
 * biomcmc is free software; you can redistribute it and/or modify it under the terms of the GNU General Public
 * License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later
 * version.
 *
 * Copyright (C) 2019-today  Leonardo de Oliveira Martins [ leomrtns at gmail.com;  http://www.leomartins.org ]
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied 
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more 
 * details (file "COPYING" or http://www.gnu.org/copyleft/gpl.html).
 */

#ifndef _biomcmc_clustering_goptics_h_
#define _biomcmc_clustering_goptics_h_

#include "distance_generator.h"

typedef struct goptics_cluster_struct* goptics_cluster;

struct goptics_cluster_struct
{
  int *Va_i, *Va_n; // Va_i[pts] where starts at Ea_ids and Ea_dist list; va_n[pts] = number of neighbours <both opaque>
  double epsilon; 
  int min_points, num_edges, n_clusters; // minpts from user, num_edges = number of dists < epsilon 
  int *order, n_order, *cluster; // samples sorted by reachability order, and cluster= ordered cluster number (i.e. cluster[i] corresponds to seq[i])
  double *core_distance, *reach_distance, max_distance; // max_dist is a convenience number to replace DBL_MAX in output
  bool *core;
  void *Ea, *heap, *points; // void b/c I don't want to expose local structs
  double timing_secs;
  distance_generator d; // d->n_samples 
};

goptics_cluster new_goptics_cluster (distance_generator dg, int min_points, double epsilon);
goptics_cluster new_goptics_cluster_run (distance_generator dg, int min_points, double epsilon);
void del_goptics_cluster (goptics_cluster gop);
void assign_goptics_clusters (goptics_cluster gop, double cluster_eps);

#endif