internal/ceres/single_linkage_clustering.h

   1 // Ceres Solver - A fast non-linear least squares minimizer
   2 // Copyright 2015 Google Inc. All rights reserved.
   3 // http://ceres-solver.org/
   4 //
   5 // Redistribution and use in source and binary forms, with or without
   6 // modification, are permitted provided that the following conditions are met:
   7 //
   8 // * Redistributions of source code must retain the above copyright notice,
   9 //   this list of conditions and the following disclaimer.
  10 // * Redistributions in binary form must reproduce the above copyright notice,
  11 //   this list of conditions and the following disclaimer in the documentation
  12 //   and/or other materials provided with the distribution.
  13 // * Neither the name of Google Inc. nor the names of its contributors may be
  14 //   used to endorse or promote products derived from this software without
  15 //   specific prior written permission.
  16 //
  17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  18 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20 // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  21 // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  22 // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  23 // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  25 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  26 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  27 // POSSIBILITY OF SUCH DAMAGE.
  28 //
  29 // Author: sameeragarwal@google.com (Sameer Agarwal)
  30
  31 #ifndef CERES_INTERNAL_SINGLE_LINKAGE_CLUSTERING_H_
  32 #define CERES_INTERNAL_SINGLE_LINKAGE_CLUSTERING_H_
  33
  34 #include "ceres/collections_port.h"
  35 #include "ceres/graph.h"
  36
  37 namespace ceres {
  38 namespace internal {
  39
  40 struct SingleLinkageClusteringOptions {
  41   SingleLinkageClusteringOptions()
  42       : min_similarity(0.99) {
  43   }
  44
  45   // Graph edges with edge weight less than min_similarity are ignored
  46   // during the clustering process.
  47   double min_similarity;
  48 };
  49
  50 // Compute a partitioning of the vertices of the graph using the
  51 // single linkage clustering algorithm. Edges with weight less than
  52 // SingleLinkageClusteringOptions::min_similarity will be ignored.
  53 //
  54 // membership upon return will contain a mapping from the vertices of
  55 // the graph to an integer indicating the identity of the cluster that
  56 // it belongs to.
  57 //
  58 // The return value of this function is the number of clusters
  59 // identified by the algorithm.
  60 int ComputeSingleLinkageClustering(
  61     const SingleLinkageClusteringOptions& options,
  62     const WeightedGraph<int>& graph,
  63     HashMap<int, int>* membership);
  64
  65 }  // namespace internal
  66 }  // namespace ceres
  67
  68 #endif  // CERES_INTERNAL_SINGLE_LINKAGE_CLUSTERING_H_