File: trapmf.m

package info (click to toggle)
octave-fuzzy-logic-toolkit 0.6.2-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,024 kB
  • sloc: makefile: 147
file content (138 lines) | stat: -rw-r--r-- 4,822 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
## Copyright (C) 2011-2025 L. Markowsky <lmarkowsky@gmail.com>
##
## This file is part of the fuzzy-logic-toolkit.
##
## The fuzzy-logic-toolkit 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.
##
## The fuzzy-logic-toolkit 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 the fuzzy-logic-toolkit; see the file COPYING.  If not,
## see <http://www.gnu.org/licenses/>.

## -*- texinfo -*-
## @deftypefn {Function File} {@var{y} =} trapmf (@var{x}, @var{params})
## @deftypefnx {Function File} {@var{y} =} trapmf (@var{[x1 x2 ... xn]}, @var{[a b c d]})
##
## For a given domain @var{x} and parameters @var{params} (or @var{[a b c d]}),
## return the corresponding @var{y} values for the trapezoidal membership
## function.
##
## The argument @var{x} must be a real number or a non-empty vector of
## strictly increasing real numbers, and parameters @var{a}, @var{b}, @var{c},
## and @var{d} must satisfy the inequalities:
## @var{a} < @var{b} <= @var{c} < @var{d}. None of the parameters @var{a},
## @var{b}, @var{c}, @var{d} are required to be in the domain @var{x}. The
## minimum and maximum values of the trapezoid are assumed to be 0 and 1.
##
## The parameters @var{[a b c d]} correspond to the x values
## of the corners of the trapezoid:
##
## @verbatim
##        1-|      --------
##          |     /        \
##          |    /          \
##          |   /            \
##        0-----------------------
##             a   b      c   d
## @end verbatim
##
## To run the demonstration code, type "@t{demo trapmf}" (without the quotation
## marks) at the Octave prompt.
##
## @seealso{dsigmf, gauss2mf, gaussmf, gbellmf, pimf, psigmf, sigmf, smf, trimf, zmf}
## @end deftypefn

## Author:        L. Markowsky
## Keywords:      fuzzy-logic-toolkit fuzzy membership trapezoidal
## Directory:     fuzzy-logic-toolkit/inst/
## Filename:      trapmf.m
## Last-Modified: 13 Jun 2024

function y = trapmf (x, params)

  ## If the caller did not supply 2 argument values with the correct
  ## types, print an error message and halt.

  if (nargin != 2)
    error ("trapmf requires 2 arguments\n");
  elseif (!is_domain (x))
    error ("trapmf's first argument must be a valid domain\n");
  elseif (!are_mf_params ('trapmf', params))
    error ("trapmf's second argument must be a parameter vector\n");
  endif

  ## Calculate and return the y values of the trapezoid on the domain x.

  a = params(1);
  b = params(2);
  c = params(3);
  d = params(4);

  b_minus_a = b - a;
  d_minus_c = d - c;

  y_val = @(x_val) max (0, min (min (1, (x_val - a) / b_minus_a), ...
                               (d - x_val) / d_minus_c));
  y = arrayfun (y_val, x);

endfunction

%!demo
%! x = 0:100;
%! params = [-1 0 20 40];
%! y1 = trapmf(x, params);
%! params = [20 40 60 80];
%! y2 = trapmf(x, params);
%! params = [60 80 100 101];
%! y3 = trapmf(x, params);
%! figure('NumberTitle', 'off', 'Name', 'trapmf demo');
%! plot(x, y1, 'r;params = [-1 0 20 40];', 'LineWidth', 2)
%! hold on;
%! plot(x, y2, 'b;params = [20 40 60 80];', 'LineWidth', 2)
%! hold on;
%! plot(x, y3, 'g;params = [60 80 100 101];', 'LineWidth', 2)
%! ylim([-0.1 1.2]);
%! xlabel('Crisp Input Value', 'FontWeight', 'bold');
%! ylabel('Degree of Membership', 'FontWeight', 'bold');
%! grid;

%!test
%! x = 0:10;
%! params = [-1 0 2 4];
%! y1 = trapmf(x, params);
%! assert(y1, [1.0 1.0 1.0 0.5 0 0 0 0 0 0 0]);
%! params = [2 4 6 8];
%! y2 = trapmf(x, params);
%! assert(y2, [0 0 0 0.5 1.0 1.0 1.0 0.5 0 0 0]);
%! params = [6 8 10 11];
%! y3 = trapmf(x, params);
%! assert(y3, [0 0 0 0 0 0 0 0.5 1.0 1.0 1.0]);

## Test input validation
%!error <trapmf requires 2 arguments>
%! trapmf()
%!error <trapmf requires 2 arguments>
%! trapmf(1)
%!error <trapmf: function called with too many inputs>
%! trapmf(1, 2, 3)
%!error <trapmf's first argument must be a valid domain>
%! trapmf([1 0], 2)
%!error <trapmf's second argument must be a parameter vector>
%! trapmf(1, 2)
%!error <trapmf's second argument must be a parameter vector>
%! trapmf(0:100, [])
%!error <trapmf's second argument must be a parameter vector>
%! trapmf(0:100, [2])
%!error <trapmf's second argument must be a parameter vector>
%! trapmf(0:100, [2 3])
%!error <trapmf's second argument must be a parameter vector>
%! trapmf(0:100, [90 80 30 20])
%!error <trapmf's second argument must be a parameter vector>
%! trapmf(0:100, [30 80 20 20])