Kmeans.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2014 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/
#ifndef IGNITION_MATH_KMEANS_HH_
#define IGNITION_MATH_KMEANS_HH_

#include <vector>
#include <ignition/math/Vector3.hh>
#include <ignition/math/Helpers.hh>
#include <ignition/math/config.hh>

namespace ignition
{
  namespace math
  {
    // Inline bracket to help doxygen filtering.
    inline namespace IGNITION_MATH_VERSION_NAMESPACE {
    //
    // Forward declare private data
    class KmeansPrivate;

    class IGNITION_MATH_VISIBLE Kmeans
    {
      public: explicit Kmeans(const std::vector<Vector3d> &_obs);

      public: virtual ~Kmeans();

      public: std::vector<Vector3d> Observations() const;

      public: bool Observations(const std::vector<Vector3d> &_obs);

      public: bool AppendObservations(const std::vector<Vector3d> &_obs);

      public: bool Cluster(int _k,
                           std::vector<Vector3d> &_centroids,
                           std::vector<unsigned int> &_labels);

      private: unsigned int ClosestCentroid(const Vector3d &_p) const;

      private: KmeansPrivate *dataPtr;
    };
    }
  }
}

#endif