xmmKMeansParameters.hpp

Go to the documentation of this file.

/*
 * xmmKMeansParameters.hpp
 *
 * Parameters of the K-Means clustering Algorithm
 *
 * Contact:
 * - Jules Francoise <jules.francoise@ircam.fr>
 *
 * This code has been initially authored by Jules Francoise
 * <http://julesfrancoise.com> during his PhD thesis, supervised by Frederic
 * Bevilacqua <href="http://frederic-bevilacqua.net>, in the Sound Music
 * Movement Interaction team <http://ismm.ircam.fr> of the
 * STMS Lab - IRCAM, CNRS, UPMC (2011-2015).
 *
 * Copyright (C) 2015 UPMC, Ircam-Centre Pompidou.
 *
 * This File is part of XMM.
 *
 * XMM is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * XMM is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with XMM.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef xmmKMeansParameters_hpp
#define xmmKMeansParameters_hpp

#include "../../core/model/xmmModelParameters.hpp"

namespace xmm {
class KMeans;

template <>
class ClassParameters<KMeans> : public Writable {
  public:
    ClassParameters();

    ClassParameters(ClassParameters<KMeans> const& src);

    explicit ClassParameters(Json::Value const& root);

    ClassParameters& operator=(ClassParameters<KMeans> const& src);

    virtual ~ClassParameters() {}


    Json::Value toJson() const;

    virtual void fromJson(Json::Value const& root);


    bool changed = false;

    Attribute<unsigned int> clusters;

    Attribute<unsigned int> max_iterations;

    Attribute<float> relative_distance_threshold;

  protected:
    virtual void onAttributeChange(AttributeBase* attr_pointer);
};
}

#endif