GreedyKCenters.h
1 /*********************************************************************
2 * Software License Agreement (BSD License)
3 *
4 * Copyright (c) 2011, Rice University
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above
14 * copyright notice, this list of conditions and the following
15 * disclaimer in the documentation and/or other materials provided
16 * with the distribution.
17 * * Neither the name of the Rice University nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 * POSSIBILITY OF SUCH DAMAGE.
33 *********************************************************************/
34 
35 /* Author: Mark Moll */
36 
37 #ifndef OMPL_DATASTRUCTURES_GREEDY_K_CENTERS_
38 #define OMPL_DATASTRUCTURES_GREEDY_K_CENTERS_
39 
40 #include "ompl/util/RandomNumbers.h"
41 #include <functional>
42 #include <boost/numeric/ublas/matrix.hpp>
43 
44 namespace ompl
45 {
49  template<typename _T>
51  {
52  public:
54  typedef std::function<double(const _T&, const _T&)> DistanceFunction;
56  typedef boost::numeric::ublas::matrix<double> Matrix;
57 
59  {
60  }
61 
62  virtual ~GreedyKCenters()
63  {
64  }
65 
68  {
69  distFun_ = distFun;
70  }
71 
74  {
75  return distFun_;
76  }
77 
86  void kcenters(const std::vector<_T>& data, unsigned int k,
87  std::vector<unsigned int>& centers, Matrix& dists)
88  {
89  // array containing the minimum distance between each data point
90  // and the centers computed so far
91  std::vector<double> minDist(data.size(), std::numeric_limits<double>::infinity());
92 
93  centers.clear();
94  centers.reserve(k);
95  if (dists.size1() < data.size() || dists.size2() < k)
96  dists.resize(std::max(2 * dists.size1() + 1, data.size()), k, false);
97  // first center is picked randomly
98  centers.push_back(rng_.uniformInt(0, data.size() - 1));
99  for (unsigned i=1; i<k; ++i)
100  {
101  unsigned ind;
102  const _T& center = data[centers[i - 1]];
103  double maxDist = -std::numeric_limits<double>::infinity();
104  for (unsigned j=0; j<data.size(); ++j)
105  {
106  if ((dists(j, i - 1) = distFun_(data[j], center)) < minDist[j])
107  minDist[j] = dists(j, i - 1);
108  // the j-th center is the one furthest away from center 0,..,j-1
109  if (minDist[j] > maxDist)
110  {
111  ind = j;
112  maxDist = minDist[j];
113  }
114  }
115  // no more centers available
116  if (maxDist < std::numeric_limits<double>::epsilon()) break;
117  centers.push_back(ind);
118  }
119 
120  const _T& center = data[centers.back()];
121  unsigned i = centers.size() - 1;
122  for (unsigned j = 0; j < data.size(); ++j)
123  dists(j, i) = distFun_(data[j], center);
124  }
125 
126  protected:
129 
132  };
133 }
134 
135 #endif
DistanceFunction distFun_
The used distance function.
An instance of this class can be used to greedily select a given number of representatives from a set...
std::function< double(const _T &, const _T &)> DistanceFunction
The definition of a distance function.
const DistanceFunction & getDistanceFunction() const
Get the distance function used.
Random number generation. An instance of this class cannot be used by multiple threads at once (membe...
Definition: RandomNumbers.h:58
void kcenters(const std::vector< _T > &data, unsigned int k, std::vector< unsigned int > &centers, Matrix &dists)
Greedy algorithm for selecting k centers.
void setDistanceFunction(const DistanceFunction &distFun)
Set the distance function to use.
boost::numeric::ublas::matrix< double > Matrix
A matrix type for storing distances between points and centers.
int uniformInt(int lower_bound, int upper_bound)
Generate a random integer within given bounds: [lower_bound, upper_bound].
Definition: RandomNumbers.h:82