Blame internal/ceres/single_linkage_clustering.h

Packit ea1746
// Ceres Solver - A fast non-linear least squares minimizer
Packit ea1746
// Copyright 2015 Google Inc. All rights reserved.
Packit ea1746
// http://ceres-solver.org/
Packit ea1746
//
Packit ea1746
// Redistribution and use in source and binary forms, with or without
Packit ea1746
// modification, are permitted provided that the following conditions are met:
Packit ea1746
//
Packit ea1746
// * Redistributions of source code must retain the above copyright notice,
Packit ea1746
//   this list of conditions and the following disclaimer.
Packit ea1746
// * Redistributions in binary form must reproduce the above copyright notice,
Packit ea1746
//   this list of conditions and the following disclaimer in the documentation
Packit ea1746
//   and/or other materials provided with the distribution.
Packit ea1746
// * Neither the name of Google Inc. nor the names of its contributors may be
Packit ea1746
//   used to endorse or promote products derived from this software without
Packit ea1746
//   specific prior written permission.
Packit ea1746
//
Packit ea1746
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Packit ea1746
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Packit ea1746
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
Packit ea1746
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
Packit ea1746
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
Packit ea1746
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
Packit ea1746
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
Packit ea1746
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
Packit ea1746
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
Packit ea1746
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
Packit ea1746
// POSSIBILITY OF SUCH DAMAGE.
Packit ea1746
//
Packit ea1746
// Author: sameeragarwal@google.com (Sameer Agarwal)
Packit ea1746
Packit ea1746
#ifndef CERES_INTERNAL_SINGLE_LINKAGE_CLUSTERING_H_
Packit ea1746
#define CERES_INTERNAL_SINGLE_LINKAGE_CLUSTERING_H_
Packit ea1746
Packit ea1746
#include "ceres/collections_port.h"
Packit ea1746
#include "ceres/graph.h"
Packit ea1746
Packit ea1746
namespace ceres {
Packit ea1746
namespace internal {
Packit ea1746
Packit ea1746
struct SingleLinkageClusteringOptions {
Packit ea1746
  SingleLinkageClusteringOptions()
Packit ea1746
      : min_similarity(0.99) {
Packit ea1746
  }
Packit ea1746
Packit ea1746
  // Graph edges with edge weight less than min_similarity are ignored
Packit ea1746
  // during the clustering process.
Packit ea1746
  double min_similarity;
Packit ea1746
};
Packit ea1746
Packit ea1746
// Compute a partitioning of the vertices of the graph using the
Packit ea1746
// single linkage clustering algorithm. Edges with weight less than
Packit ea1746
// SingleLinkageClusteringOptions::min_similarity will be ignored.
Packit ea1746
//
Packit ea1746
// membership upon return will contain a mapping from the vertices of
Packit ea1746
// the graph to an integer indicating the identity of the cluster that
Packit ea1746
// it belongs to.
Packit ea1746
//
Packit ea1746
// The return value of this function is the number of clusters
Packit ea1746
// identified by the algorithm.
Packit ea1746
int ComputeSingleLinkageClustering(
Packit ea1746
    const SingleLinkageClusteringOptions& options,
Packit ea1746
    const WeightedGraph<int>& graph,
Packit ea1746
    HashMap<int, int>* membership);
Packit ea1746
Packit ea1746
}  // namespace internal
Packit ea1746
}  // namespace ceres
Packit ea1746
Packit ea1746
#endif  // CERES_INTERNAL_SINGLE_LINKAGE_CLUSTERING_H_