clusterer.cc

   1 /*
   2  *  clueless-kmean is a variant of k-mean which enforces balanced
   3  *  distribution of classes in every cluster
   4  *
   5  *  Copyright (c) 2013 Idiap Research Institute, http://www.idiap.ch/
   6  *  Written by Francois Fleuret <francois.fleuret@idiap.ch>
   7  *
   8  *  This file is part of clueless-kmean.
   9  *
  10  *  clueless-kmean is free software: you can redistribute it and/or
  11  *  modify it under the terms of the GNU General Public License
  12  *  version 3 as published by the Free Software Foundation.
  13  *
  14  *  clueless-kmean is distributed in the hope that it will be useful,
  15  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  *  General Public License for more details.
  18  *
  19  *  You should have received a copy of the GNU General Public License
  20  *  along with selector.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  */
  23
  24 #include "clusterer.h"
  25 #include <glpk.h>
  26
  27 Clusterer::Clusterer() {
  28   _cluster_means = 0;
  29   _cluster_var = 0;
  30 }
  31
  32 Clusterer::~Clusterer() {
  33   deallocate_array<scalar_t>(_cluster_means);
  34   deallocate_array<scalar_t>(_cluster_var);
  35 }
  36
  37 scalar_t Clusterer::distance_to_centroid(scalar_t *x, int k) {
  38   // We take the variance into account + the normalization term. This
  39   // is between k-mean and EM with a diagonal covariance
  40   scalar_t dist = 0;
  41   for(int d = 0; d < _dim; d++) {
  42     dist += sq(_cluster_means[k][d] - x[d]) / (2 * _cluster_var[k][d]);
  43     dist += 0.5 * log(_cluster_var[k][d]);
  44     ASSERT(!isnan(dist) && !isinf(dist));
  45   }
  46   return dist;
  47 }
  48
  49 void Clusterer::initialize_clusters(int nb_points, scalar_t **points) {
  50   int *used = new int[nb_points];
  51   for(int k = 0; k < nb_points; k++) { used[k] = 0; }
  52   for(int k = 0; k < _nb_clusters; k++) {
  53     int l;
  54     do { l = int(drand48() * nb_points); } while(used[l]);
  55     for(int d = 0; d < _dim; d++) {
  56       _cluster_means[k][d] = points[l][d];
  57       _cluster_var[k][d] = 1.0;
  58     }
  59     used[l] = 1;
  60   }
  61   delete[] used;
  62 }
  63
  64 scalar_t Clusterer::baseline_cluster_association(int nb_points, scalar_t **points,
  65                                                  int nb_classes, int *labels,
  66                                                  scalar_t **gamma)  {
  67   int *associated_clusters = new int[nb_points];
  68   scalar_t total_dist = 0;
  69
  70   for(int n = 0; n < nb_points; n++) {
  71     scalar_t lowest_dist = 0;
  72     for(int k = 0; k < _nb_clusters; k++) {
  73       scalar_t dist = distance_to_centroid(points[n], k);
  74       if(k == 0 || dist <= lowest_dist) {
  75         lowest_dist = dist;
  76         associated_clusters[n] = k;
  77       }
  78     }
  79
  80     total_dist += lowest_dist;
  81   }
  82
  83   for(int n = 0; n < nb_points; n++) {
  84     for(int k = 0; k < _nb_clusters; k++) {
  85       gamma[n][k] = 0.0;
  86     }
  87     gamma[n][associated_clusters[n]] = 1.0;
  88   }
  89
  90   delete[] associated_clusters;
  91
  92   return total_dist;
  93 }
  94
  95 scalar_t Clusterer::baseline_lp_cluster_association(int nb_points, scalar_t **points,
  96                                                     int nb_classes, int *labels,
  97                                                     scalar_t **gamma)  {
  98   glp_prob *lp;
  99
 100   int *coeff_row = new int[nb_points * _nb_clusters + 1];
 101   int *coeff_col = new int[nb_points * _nb_clusters + 1];
 102   scalar_t *coeff_wgt = new scalar_t[nb_points * _nb_clusters + 1];
 103
 104   lp = glp_create_prob();
 105
 106   glp_set_prob_name(lp, "baseline_lp_cluster_association");
 107   glp_set_obj_dir(lp, GLP_MIN);
 108
 109   glp_add_rows(lp, nb_points);
 110
 111   for(int n = 1; n <= nb_points; n++) {
 112     glp_set_row_bnds(lp, n, GLP_FX, 1.0, 1.0);
 113   }
 114
 115   glp_add_cols(lp, nb_points * _nb_clusters);
 116   for(int k = 1; k <= _nb_clusters; k++) {
 117     for(int n = 1; n <= nb_points; n++) {
 118       int i = n + nb_points * (k - 1);
 119       glp_set_obj_coef(lp, i, distance_to_centroid(points[n-1], k-1));
 120       glp_set_col_bnds(lp, i, GLP_DB, 0.0, 1.0);
 121     }
 122   }
 123
 124   int n_coeff = 1;
 125
 126   for(int n = 1; n <= nb_points; n++) {
 127     for(int k = 1; k <= _nb_clusters; k++) {
 128       coeff_row[n_coeff] = n;
 129       coeff_col[n_coeff] = n + nb_points * (k - 1);
 130       coeff_wgt[n_coeff] = 1.0;
 131       n_coeff++;
 132     }
 133   }
 134
 135   glp_load_matrix(lp, nb_points * _nb_clusters, coeff_row, coeff_col, coeff_wgt);
 136
 137   glp_simplex(lp, NULL);
 138
 139   scalar_t total_dist = glp_get_obj_val(lp);
 140
 141   for(int k = 1; k <= _nb_clusters; k++) {
 142     for(int n = 1; n <= nb_points; n++) {
 143       int i = n + nb_points * (k - 1);
 144       gamma[n-1][k-1] = glp_get_col_prim(lp, i);
 145     }
 146   }
 147
 148   delete[] coeff_row;
 149   delete[] coeff_col;
 150   delete[] coeff_wgt;
 151
 152   glp_delete_prob(lp);
 153
 154   return total_dist;
 155 }
 156
 157 scalar_t Clusterer::uninformative_lp_cluster_association(int nb_points, scalar_t **points,
 158                                                          int nb_classes, int *labels,
 159                                                          scalar_t **gamma)  {
 160   // N points
 161   // K clusters
 162   // dist(n,k) distance of samples n to cluster k
 163   //
 164   // We want to optimize the
 165   //
 166   // \gamma(n,k) is the association of point n to cluster k
 167   //
 168   // to minimize
 169   //
 170   // \sum_{n,k} \gamma(n,k) dist(n,k)
 171   //
 172   // under
 173   //
 174   // (A) \forall n, k, \gamma(n, k) >= 0
 175   // (B) \forall n, \sum_k \gamma(n,k) = 1
 176   // (C) \forall k, \sum_n \gamma(n,k) = N/K
 177
 178   glp_prob *lp;
 179
 180   // The coefficients for the constraints are passed to the glpk
 181   // functions with a sparse representation.
 182
 183   // ** GLPK USES INDEXES STARTING AT 1, NOT 0. **
 184
 185   int nb_coeffs = nb_points * _nb_clusters + nb_points * _nb_clusters;
 186
 187   int *coeff_row = new int[nb_coeffs + 1];
 188   int *coeff_col = new int[nb_coeffs + 1];
 189   scalar_t *coeff_wgt = new scalar_t[nb_coeffs + 1];
 190
 191   int n_coeff = 1;
 192
 193   scalar_t *nb_samples_per_class = new scalar_t[nb_classes];
 194   for(int c = 0; c < nb_classes; c++) {
 195     nb_samples_per_class[c] = 0.0;
 196   }
 197
 198   for(int n = 0; n < nb_points; n++) {
 199     nb_samples_per_class[labels[n]] += 1.0;
 200   }
 201
 202   lp = glp_create_prob();
 203
 204   glp_set_prob_name(lp, "uninformative_lp_cluster_association");
 205   glp_set_obj_dir(lp, GLP_MIN);
 206
 207   // We have one column per coefficient gamma
 208
 209   glp_add_cols(lp, nb_points * _nb_clusters);
 210
 211   // The constraints (A) will be expressed by putting directly bounds
 212   // on the variables (i.e. one per column). So we need one row per
 213   // (B) constraint, and one per (C) constraint.
 214
 215   glp_add_rows(lp, nb_points + _nb_clusters * nb_classes);
 216
 217   // First, we set the weights for the objective function, and the
 218   // constraint on the individual gammas
 219
 220   for(int k = 1; k <= _nb_clusters; k++) {
 221     for(int n = 1; n <= nb_points; n++) {
 222       int col = n + nb_points * (k - 1);
 223
 224       // The LP weight on the gammas for the global loss is the
 225       // normalized distance of that sample to the centroid of that
 226       // cluster
 227
 228       glp_set_obj_coef(lp, col, distance_to_centroid(points[n-1], k-1));
 229
 230       // The (A) constraints: Each column correspond to one of the
 231       // gamma, and it has to be in [0,1]
 232
 233       glp_set_col_bnds(lp, col, GLP_DB, 0.0, 1.0);
 234     }
 235   }
 236
 237   // The (B) constraints: for each point, the sum of its gamma is
 238   // equal to 1.0
 239
 240   for(int n = 1; n <= nb_points; n++) {
 241     int row = n;
 242     glp_set_row_bnds(lp, row, GLP_FX, 1.0, 1.0);
 243     for(int k = 1; k <= _nb_clusters; k++) {
 244       coeff_row[n_coeff] = row;
 245       coeff_col[n_coeff] = nb_points * (k - 1) + n;
 246       coeff_wgt[n_coeff] = 1.0;
 247       n_coeff++;
 248     }
 249   }
 250
 251   // The (C) constraints: For each pair cluster/class, the sum of the
 252   // gammas for this cluster and this class is equal to the number of
 253   // sample of that class, divided by the number of clusters
 254
 255   for(int k = 1; k <= _nb_clusters; k++) {
 256     for(int c = 1; c <= nb_classes; c++) {
 257       int row = nb_points + (k - 1) * nb_classes + c;
 258       scalar_t tau = nb_samples_per_class[c-1] / scalar_t(_nb_clusters);
 259       glp_set_row_bnds(lp, row, GLP_FX, tau, tau);
 260       for(int n = 1; n <= nb_points; n++) {
 261         if(labels[n-1] == c - 1) {
 262           coeff_row[n_coeff] = row;
 263           coeff_col[n_coeff] = (k-1)  * nb_points + n;
 264           coeff_wgt[n_coeff] = 1.0;
 265           n_coeff++;
 266         }
 267       }
 268     }
 269   }
 270
 271   ASSERT(n_coeff == nb_coeffs + 1);
 272
 273   glp_load_matrix(lp, nb_coeffs, coeff_row, coeff_col, coeff_wgt);
 274
 275   // Now a miracle occurs
 276
 277   glp_simplex(lp, NULL);
 278
 279   // We retrieve the result
 280
 281   scalar_t total_dist = glp_get_obj_val(lp);
 282
 283   for(int k = 1; k <= _nb_clusters; k++) {
 284     for(int n = 1; n <= nb_points; n++) {
 285       int i = n + nb_points * (k - 1);
 286       gamma[n-1][k-1] = glp_get_col_prim(lp, i);
 287     }
 288   }
 289
 290   delete[] nb_samples_per_class;
 291   delete[] coeff_row;
 292   delete[] coeff_col;
 293   delete[] coeff_wgt;
 294   glp_delete_prob(lp);
 295
 296   return total_dist;
 297 }
 298
 299 void Clusterer::update_clusters(int nb_points, scalar_t **points, scalar_t **gamma)  {
 300   for(int k = 0; k < _nb_clusters; k++) {
 301
 302     for(int d = 0; d < _dim; d++) {
 303       _cluster_means[k][d] = 0.0;
 304       _cluster_var[k][d] = 0.0;
 305     }
 306
 307     scalar_t sum_gamma = 0;
 308     for(int n = 0; n < nb_points; n++) {
 309       sum_gamma += gamma[n][k];
 310       for(int d = 0; d < _dim; d++) {
 311         _cluster_means[k][d] += gamma[n][k] * points[n][d];
 312         _cluster_var[k][d] += gamma[n][k] * sq(points[n][d]);
 313       }
 314     }
 315
 316     ASSERT(sum_gamma >= 1);
 317
 318     for(int d = 0; d < _dim; d++) {
 319       if(sum_gamma >= 2) {
 320         _cluster_var[k][d] =
 321           (_cluster_var[k][d] - sq(_cluster_means[k][d]) / sum_gamma) / (sum_gamma - 1);
 322         _cluster_var[k][d] = max(scalar_t(min_cluster_variance), _cluster_var[k][d]);
 323       } else {
 324         _cluster_var[k][d] = 1;
 325       }
 326
 327       _cluster_means[k][d] /= sum_gamma;
 328     }
 329   }
 330 }
 331
 332 void Clusterer::train(int mode,
 333                       int nb_clusters, int dim,
 334                       int nb_points, scalar_t **points,
 335                       int nb_classes, int *labels,
 336                       int *cluster_associations) {
 337   deallocate_array<scalar_t>(_cluster_means);
 338   deallocate_array<scalar_t>(_cluster_var);
 339   _nb_clusters = nb_clusters;
 340   _dim = dim;
 341   _cluster_means = allocate_array<scalar_t>(_nb_clusters, _dim);
 342   _cluster_var = allocate_array<scalar_t>(_nb_clusters, _dim);
 343
 344   scalar_t **gammas = allocate_array<scalar_t>(nb_points, _nb_clusters);
 345
 346   if(nb_clusters > nb_points) abort();
 347
 348   initialize_clusters(nb_points, points);
 349
 350   scalar_t pred_total_distance, total_distance = FLT_MAX;
 351   int nb_rounds = 0;
 352
 353   do {
 354     pred_total_distance = total_distance;
 355
 356     switch(mode) {
 357
 358     case STANDARD_ASSOCIATION:
 359     total_distance =
 360       baseline_cluster_association(nb_points, points, nb_classes, labels, gammas);
 361       break;
 362
 363     case STANDARD_LP_ASSOCIATION:
 364     total_distance =
 365       baseline_lp_cluster_association(nb_points, points, nb_classes, labels, gammas);
 366       break;
 367
 368     case UNINFORMATIVE_LP_ASSOCIATION:
 369     total_distance =
 370       uninformative_lp_cluster_association(nb_points, points, nb_classes, labels, gammas);
 371       break;
 372
 373     default:
 374       cerr << "Unknown sample-cluster association mode." << endl;
 375       abort();
 376     }
 377
 378     cout << "TRAIN " << nb_rounds << " " << total_distance << endl;
 379     update_clusters(nb_points, points, gammas);
 380     nb_rounds++;
 381   } while(total_distance < min_iteration_improvement * pred_total_distance &&
 382           nb_rounds < max_nb_iterations);
 383
 384   if(cluster_associations) {
 385     for(int n = 0; n < nb_points; n++) {
 386       for(int k = 0; k < _nb_clusters; k++) {
 387         if(k == 0 || gammas[n][k] > gammas[n][cluster_associations[n]]) {
 388           cluster_associations[n] = k;
 389         }
 390       }
 391     }
 392   }
 393
 394   deallocate_array<scalar_t>(gammas);
 395 }
 396
 397 int Clusterer::cluster(scalar_t *point) {
 398   scalar_t lowest_dist = 0;
 399   int associated_cluster = -1;
 400
 401   for(int k = 0; k < _nb_clusters; k++) {
 402     scalar_t dist = 0;
 403
 404     for(int d = 0; d < _dim; d++) {
 405       dist += sq(_cluster_means[k][d] - point[d]) / (2 * _cluster_var[k][d]);
 406       dist += 0.5 * log(_cluster_var[k][d]);
 407       ASSERT(!isnan(dist) && !isinf(dist));
 408     }
 409
 410     if(k == 0 || dist <= lowest_dist) {
 411       lowest_dist = dist;
 412       associated_cluster = k;
 413     }
 414   }
 415
 416   ASSERT(associated_cluster >= 0);
 417
 418   return associated_cluster;
 419 }