fuzzy_code_book.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'
 ***************************************************************************/
//-----------------------------------------------------------------------------
// xmippFuzzyCodeBook.hh
// Implements a set of fuzzy code vectors, that is a Fuzzy code book.
//-----------------------------------------------------------------------------

#ifndef XMIPPFUZZYCB_H
#define XMIPPFUZZYCB_H

#include "code_book.h"

class FuzzyCodeBook : public CodeBook
{
public:

    typedef std::vector< std::vector< floatFeature > > MM;
    //typedef ClassificationTrainingSet<std::vector<Feature>,Label> TS;  // Alias for a Training set
    typedef ClassicTrainingVectors TS;
    typedef ClassificationTrainingSet<std::vector<floatFeature>, floatFeature > FV;

    // Fuzzy membership matrix
    MM memb;

    FuzzyCodeBook(const bool& _calib = false) : CodeBook(_calib)
    {};



    FuzzyCodeBook(unsigned _n, unsigned _size, unsigned _data, bool _cal = false);


    FuzzyCodeBook(unsigned _n, unsigned _size, unsigned _data, double _lower = 0, double _upper = 1, bool _cal = false);

    FuzzyCodeBook(unsigned _n, const ClassicTrainingVectors& _ts, const bool _use_rand_cvs = false);

    /*
     * Constructs a fuzzy code book given a stream
     * Parameter: _is  The input stream
     * Parameter: _size Size of code vectors (number of data points)
     */

    FuzzyCodeBook(std::istream& _is, const unsigned _size = 0);

    virtual ~FuzzyCodeBook()
    {};


#ifdef UNUSED // detected as unused 29.6.2018

    floatFeature membAt(unsigned _di, unsigned _ci) const;
#endif

    floatFeature& membAt(unsigned _di, unsigned _ci);


    unsigned membClusters() const;
    unsigned membVectors() const;


    virtual FeatureVector& fuzzyTest(unsigned _in) const;

    virtual unsigned fuzzyTestIndex(unsigned _in) const;

#ifdef UNUSED // detected as unused 29.6.2018

    virtual Label fuzzyApply(unsigned _in) const;


    virtual void fuzzyCalibrate(ClassicTrainingVectors& _ts, Label _def = Label());
#endif

    virtual unsigned fuzzyWinner(unsigned _in) const;

    virtual unsigned fuzzyOutput(unsigned _in) const;

    virtual void classify(const ClassicTrainingVectors* _ts);

#ifdef UNUSED // detected as unused 29.6.2018

    virtual void hardPartition();
#endif

    virtual TS alphaCore(TS _ts, double _alpha, unsigned _cluster) const;

    virtual void writeMembership(std::ostream& _os) const;

    virtual void readMembership(std::istream& _is);


    virtual void saveObject(std::ostream& _os) const;


    virtual void loadObject(std::istream& _is);


    virtual void readSelf(std::istream& _is, const unsigned _size = 0);

#ifdef UNUSED // detected as unused 29.6.2018

    virtual void printDensity(std::ostream& _os) const;
#endif

private:

    // Dimensions of the membership matrix
    unsigned numClusters;
    unsigned numVectors;

};


//-----------------------------------------------------------------------------

#endif//XMIPPFUZZYCB_H