fcmeans.h

Go to the documentation of this file.

/***************************************************************************
 *
 * Authors:     Alberto Pascual Montano (pascual@cnb.csic.es)
 *
 * Unidad de  Bioinformatica of Centro Nacional de Biotecnologia , CSIC
 *
 * This program 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 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
 * 02111-1307  USA
 *
 *  All comments concerning this program package may be sent to the
 *  e-mail address 'xmipp@cnb.csic.es'
 ***************************************************************************/
//-----------------------------------------------------------------------------
// FuzzyCMeans.hh
// Fuzzy c-means clustering algorithm
//-----------------------------------------------------------------------------

#ifndef _XMIPPFCMEANS_H
#define _XMIPPFCMEANS_H

#include <iostream>
#include <vector>

#include "base_algorithm.h"
#include "fuzzy_code_book.h"

class FuzzyCMeans:  public ClassificationAlgorithm<FuzzyCodeBook >
{

public:

    FuzzyCMeans(double _m, double _epsilon, unsigned _epochs)
            : ClassificationAlgorithm< FuzzyCodeBook >("xmippFCMeans"),
            m(_m), epsilon(_epsilon),
            epochs(_epochs)
    {}
    ;


    /*
     * Ctor from stream
     * Parameter: _is Must have the parameters in the same order than the previous ctor.
     */
    //  FuzzyCMeans( std::istream& _is );


    /*
     * Virtual destructor
     */
    virtual ~FuzzyCMeans()
    {}
    ;


    virtual void train(FuzzyCodeBook& _xmippDS,
                       TS& _examples) const;


    virtual double fuzzyTest(const FuzzyCodeBook& _xmippDS,
                             const TS& _examples) const;


    virtual double test(const FuzzyCodeBook& _xmippDS,
                        const TS& _examples) const;


    double F(const FuzzyCodeBook& _xmippDS) const;

    double H(const FuzzyCodeBook& _xmippDS) const;

#ifdef UNUSED // detected as unused 29.6.2018

    double NFI(const FuzzyCodeBook& _xmippDS) const;
#endif

    double S(const FuzzyCodeBook& _xmippDS, const TS& _examples) const;

protected:

    void printSelf(std::ostream& _os) const ;

    double m;       // Fuzzy constant
    double epsilon;      // Stopping criterion Error < epsilon
    unsigned epochs;                  // Number of presentations of the whole sample
};
#endif//_XMIPPFCMEANS_H