membership.hpp

Go to the documentation of this file.

/*  Copyright (C) 2004-2015
    ANTONIO JAVIER BARRAGAN, antonio.barragan@diesia.uhu.es
    http://uhu.es/antonio.barragan

    Collaborators:
    JOSE MANUEL ANDUJAR, andujar@diesia.uhu.es

    DPTO. DE ING. ELECTRONICA, DE SISTEMAS INFORMATICOS Y AUTOMATICA
    ETSI, UNIVERSITY OF HUELVA (SPAIN)

    For more information, please contact with authors.
    
    This software 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.

    This software 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, see <http://www.gnu.org/licenses/>.
*/

#ifndef _MEMBERSHIP_HPP_
#define _MEMBERSHIP_HPP_

#include <math.h>

#include <tnt/tnt_array1d.h> // Template Numerical Toolkit, http://math.nist.gov/tnt
#include <tnt/tnt_array2d.h>

#include <flt/messages.h>

namespace FLT // Use the FTL (Fuzzy Logic Tools) namespace
{
  #define M_EPS 1e-16 
  #define MAX_SIZE_TYPE_NAME 16 


  inline int sign(double x)
  {
    if (x > 0.0)
      return 1;
    else if (x < 0.0)
      return -1;
    else
      return 0;
  }

  enum TYPE_MF // Implemented Membership functions
  {
    ANYMF = 0,
    CONSTMF,
    GAUSSMF,
    GAUSS2MF,
    GBELLMF,
    PIMF,
    PSIGMF,
    SMF,
    SIGMF,
    SIG2MF,
    TRAPMF,
    TRIMF,
    ZMF
  };

  static const char *MF_NAMES[]=
  {// Names of TYPE_MF Membership Functions - UPPERCASE
    "ANYMF",
    "CONSTMF",
    "GAUSSMF",
    "GAUSS2MF",
    "GBELLMF",
    "PIMF",
    "PSIGMF",
    "SMF",
    "SIGMF",
    "SIG2MF",
    "TRAPMF",
    "TRIMF",
    "ZMF"
  };

  static const size_t MF_PARAM_NUMBER[] =
  {
    0, // \var ANYMF
    1, // CONSTMF
    2, // GAUSSMF
    4, // GAUSS2MF
    3, // GBELLMF
    4, // PIMF
    4, // PSIGMF
    2, // SMF
    2, // SIGMF
    4, // SIG2MF
    4, // TRAPMF
    3, // TRIMF
    2  // ZMF
  };

  // Declarations ################################################################

  class Membership // -Parent class-
  {
  protected:
    double *param; 
    size_t n;  
    TYPE_MF type_mf; 
  public:
    virtual double eval(double x) const = 0;
    
    virtual double evalder(double x) const = 0;
    
    virtual double paramder(size_t parameter,
                            double x) const = 0;
    
    virtual int test(void) const;
    
    size_t num_params(void) const;
    
    TYPE_MF type(void) const;
    
    int type(TYPE_MF type_mf);
    
    int edit(size_t index,
             double value);

    void edit(const double* const parameters);
    
    double read(size_t index) const;
    
    TNT::Array1D<double> read(void) const;

    Membership &operator=(const Membership &P);
    Membership(const Membership &P);
    Membership(); 
    ~Membership();
};

  Membership *createMF(TYPE_MF t);
  
  // Anymf ########################################################################
  class Anymf:public Membership // This Membership function don't exist in MATLAB©.
  { // This type is used to initializate Rules
   public:
    double eval(double x) const;
    double evalder(double x) const;
    double paramder(size_t parameter,
                    double x) const;
    Anymf(void);
  };

  // Constmf ######################################################################
  class Constmf:public Membership // This Membership function don't exist in MATLAB© by default. It is 'constmf.m'
  {
   public:
    double eval(double x) const;
    double evalder(double x) const;
    double paramder(size_t parameter,
                    double x) const;
    Constmf(double c = 1.0);
  };

  // Gaussmf #####################################################################
  class Gaussmf:public Membership // In MATLAB© is 'gaussmf'
  {
   public:
    double eval(double x) const;
    double evalder(double x) const;
    double paramder(size_t parameter,
                    double x) const;
    int test(void) const; // If the parameters of the Membership function are valid returns 0
    Gaussmf(double Center = 0.5,
        double Beta = 0.3); // Sigma_MATLAB = Beta/sqrt(2);
  };

  // Gauss2mf ####################################################################
   class Gauss2mf:public Membership // In MATLAB© is 'gauss2mf'
  {
   public:
    double eval(double x) const;
    double evalder(double x) const;
    double paramder(size_t parameter,
                    double x) const;
    int test(void) const; // Modify the parameters to be correct
    Gauss2mf(double Center1 = 0.45,
         double Beta1 = 0.25,
         double Center2 = 0.55,
         double Beta2 = 0.25); // Sigma_MATLAB = Beta/sqrt(2);
  };

  // GBellmf ######################################################################
   class GBellmf:public Membership // In MATLAB© is 'gbellmf'
  {
   public:
    double eval(double x) const;
    double evalder(double x) const;
    double paramder(size_t parameter,
                    double x) const;
    int test(void) const; // Modify the parameters to be correct
    GBellmf(double a = 0.25,
            double b = 2.5,
        double c = 0.5);
  };

  // Pimf ########################################################################
   class Pimf:public Membership // In MATLAB© is 'pimf'
  {
   public:
    double eval(double x) const;
    double evalder(double x) const;
    double paramder(size_t parameter,
                    double x) const;
    Pimf(double a = 0.05,
       double b = 0.45,
       double c = 0.55,
       double d = 0.95);
  };

  // PSigmf ################################################################
   class PSigmf:public Membership // In MATLAB© is 'psigmf'
  {
   public:
    double eval(double x) const;
    double evalder(double x) const;
    double paramder(size_t parameter,
                    double x) const;
    PSigmf(double a1 = 11,
           double c1 = 0.25,
         double a2 = -11,
         double c2 = 0.75);
  };

  // Smf #########################################################################
   class Smf:public Membership // In MATLAB© is 'smf'
  {
   public:
    double eval(double x) const;
    double evalder(double x) const;
    double paramder(size_t parameter,
                    double x) const;
    Smf(double a = 0.05,
        double b = 0.45);
  };

  // Sigmf #################################################################
   class Sigmf:public Membership // In MATLAB© is 'sigmf'
  {
   public:
    double eval(double x) const;
    double evalder(double x) const;
    double paramder(size_t parameter,
                    double x) const;
    Sigmf(double a = 14,
          double c = 0.25);
  };

  // Sig2mf ################################################################
   class Sig2mf:public Membership // In MATLAB© is 'dsigmf'
  {
   public:
    double eval(double x) const;
    double evalder(double x) const;
    double paramder(size_t parameter,
                    double x) const;
    Sig2mf(double a1 = 11,
           double c1 = 0.25,
         double a2 = 11,
         double c2 = 0.75);
  };

  // Trapmf ###############################################################
   class Trapmf:public Membership // In MATLAB© is 'trapmf'
  {
   public:
    double eval(double x) const;
    double evalder(double x) const;
    double paramder(size_t parameter,
                    double x) const;
    int test(void) const; // Modify the parameters to be correct
    Trapmf(double a = 0.05,
           double b = 0.45,
         double c = 0.55,
         double d = 0.95);
  };

  // Trimf ################################################################
   class Trimf:public Membership // In MATLAB© is 'trimf'
  {
   public:
    double eval(double x) const;
    double evalder(double x) const;
    double paramder(size_t parameter,
                    double x) const;
    int test(void) const; // Modify the parameters to be correct
    Trimf(double a = 0.0,
          double b = 0.5,
        double c = 1.0);
  };

  // Zmf #########################################################################
   class Zmf:public Membership // In MATLAB© is 'zmf'
  {
   public:
    double eval(double x) const;
    double evalder(double x) const;
    double paramder(size_t parameter,
                    double x) const;
    Zmf(double a = 0.55,
        double b = 0.95);
  };
  
} // FLT namespace

#endif