Home | History | Annotate | Download | only in ceres
      1 // Ceres Solver - A fast non-linear least squares minimizer
      2 // Copyright 2013 Google Inc. All rights reserved.
      3 // http://code.google.com/p/ceres-solver/
      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 (at) google.com (Sameer Agarwal)
     30 
     31 #ifndef CERES_INTERNAL_SINGLE_LINKAGE_CLUSTERING_H_
     32 #define CERES_INTERNAL_SINGLE_LINKAGE_CLUSTERING_H_
     33 
     34 // This include must come before any #ifndef check on Ceres compile options.
     35 #include "ceres/internal/port.h"
     36 
     37 #ifndef CERES_NO_SUITESPARSE
     38 
     39 #include "ceres/collections_port.h"
     40 #include "ceres/graph.h"
     41 
     42 namespace ceres {
     43 namespace internal {
     44 
     45 struct SingleLinkageClusteringOptions {
     46   SingleLinkageClusteringOptions()
     47       : min_similarity(0.99) {
     48   }
     49 
     50   // Graph edges with edge weight less than min_similarity are ignored
     51   // during the clustering process.
     52   double min_similarity;
     53 };
     54 
     55 // Compute a partitioning of the vertices of the graph using the
     56 // single linkage clustering algorithm. Edges with weight less than
     57 // SingleLinkageClusteringOptions::min_similarity will be ignored.
     58 //
     59 // membership upon return will contain a mapping from the vertices of
     60 // the graph to an integer indicating the identity of the cluster that
     61 // it belongs to.
     62 //
     63 // The return value of this function is the number of clusters
     64 // identified by the algorithm.
     65 int ComputeSingleLinkageClustering(
     66     const SingleLinkageClusteringOptions& options,
     67     const Graph<int>& graph,
     68     HashMap<int, int>* membership);
     69 
     70 }  // namespace internal
     71 }  // namespace ceres
     72 
     73 #endif  // CERES_NO_SUITESPARSE
     74 #endif  // CERES_INTERNAL_SINGLE_LINKAGE_CLUSTERING_H_
     75