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 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568
|
## 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{retval} =} getfis (@var{fis})
## @deftypefnx {Function File} {@var{retval} =} getfis (@var{fis}, @var{property})
## @deftypefnx {Function File} {@var{retval} =} getfis (@var{fis}, @var{in_or_out}, @var{var_index})
## @deftypefnx {Function File} {@var{retval} =} getfis (@var{fis}, @var{in_or_out}, @var{var_index}, @var{var_property})
## @deftypefnx {Function File} {@var{retval} =} getfis (@var{fis}, @var{in_or_out}, @var{var_index}, @var{mf}, @var{mf_index})
## @deftypefnx {Function File} {@var{retval} =} getfis (@var{fis}, @var{in_or_out}, @var{var_index}, @var{mf}, @var{mf_index}, @var{mf_property})
##
## Return or print the property (field) values of an FIS structure
## specified by the arguments.
##
## There are six forms of getfis:
##
## @multitable @columnfractions .20 .70
## @headitem Number of Arguments @tab Action Taken
## @item 1
## @tab Print (some) properties of an FIS structure on standard output.
## Return the empty set.
## @item 2
## @tab Return a specified property of the FIS structure. The properties
## that may be specified are: name, type, version, numinputs,
## numoutputs, numinputmfs, numoutputmfs, numrules, andmethod,
## ormethod, impmethod, addmethod, defuzzmethod, inlabels, outlabels,
## inrange, outrange, inmfs, outmfs, inmflabels, outmflabels,
## inmftypes, outmftypes, inmfparams, outmfparams, and rulelist.
## @item 3
## @tab Print the properties of a specified input or output variable
## of the FIS structure. Return the empty set.
## @item 4
## @tab Return a specified property of an input or output variable.
## The properties that may be specified are: name, range, nummfs,
## and mflabels.
## @item 5
## @tab Print the properties of a specified membership function of the
## FIS structure. Return the empty set.
## @item 6
## @tab Return a specified property of a membership function. The
## properties that may be specified are: name, type, and params.
## @end multitable
## @sp 1
## The types/values of the arguments are expected to be:
##
## @multitable @columnfractions .20 .70
## @headitem Argument @tab Expected Type or Value
## @item @var{fis}
## @tab an FIS structure
## @item @var{property}
## @tab a string; one of: 'name', 'type', 'version', 'numinputs',
## 'numoutputs', 'numinputmfs', 'numoutputmfs',
## 'numrules', 'andmethod', 'ormethod', 'impmethod',
## 'addmethod', 'defuzzmethod' 'inlabels', 'outlabels',
## 'inrange', 'outrange', 'inmfs', 'outmfs',
## 'inmflabels', 'outmflabels', 'inmftypes',
## 'outmftypes', 'inmfparams', 'outmfparams', and
## 'rulelist' (case-insensitive)
## @item @var{in_or_out}
## @tab either 'input' or 'output' (case-insensitive)
## @item @var{var_index}
## @tab a valid integer index of an input or output FIS variable
## @item @var{var_property}
## @tab a string; one of: 'name', 'range', 'nummfs', and 'mflabels'
## @item @var{mf}
## @tab the string 'mf'
## @item @var{mf_index}
## @tab a valid integer index of a membership function
## @item @var{mf_property}
## @tab a string; one of 'name', 'type', or 'params'
## @end multitable
## @sp 1
## Note that all of the strings representing properties above are case
## insensitive.
##
## @seealso{setfis, showfis}
## @end deftypefn
## Author: L. Markowsky
## Keywords: fuzzy-logic-toolkit fuzzy inference system fis
## Directory: fuzzy-logic-toolkit/inst/
## Filename: getfis.m
## Last-Modified: 13 Jun 2024
##----------------------------------------------------------------------
function retval = getfis (fis, arg2 = 'dummy', arg3 = 'dummy', ...
arg4 = 'dummy', arg5 = 'dummy', ...
arg6 = 'dummy')
switch (nargin)
case 1 retval = getfis_one_arg (fis);
case 2 retval = getfis_two_args (fis, arg2);
case 3 retval = getfis_three_args (fis, arg2, arg3);
case 4 retval = getfis_four_args (fis, arg2, arg3, arg4);
case 5 retval = getfis_five_args (fis, arg2, arg3, arg4, arg5);
case 6 retval = getfis_six_args (fis, arg2, arg3, arg4, arg5, ...
arg6);
otherwise
error ("getfis requires 1-6 arguments\n");
endswitch
endfunction
##----------------------------------------------------------------------
## Function: getfis_one_arg
## Purpose: Handle calls to getfis that have 1 argument. See the
## comment at the top of this file for more complete info.
##----------------------------------------------------------------------
function retval = getfis_one_arg (fis)
## If the argument does not have the correct type, print an error
## message and halt.
if (!is_fis (fis))
error ("the first argument to getfis must be an FIS structure\n");
endif
## Print (some) properties of the FIS structure. Return the empty set.
printf ("Name = %s\n", fis.name);
printf ("Type = %s\n", fis.type);
printf ("NumInputs = %d\n", columns(fis.input));
printf ("InLabels = \n");
for i = 1 : columns (fis.input)
printf ("\t%s\n", fis.input(i).name);
endfor
printf ("NumOutputs = %d\n", columns(fis.output));
printf ("OutLabels = \n");
for i = 1 : columns (fis.output)
printf ("\t%s\n", fis.output(i).name);
endfor
printf ("NumRules = %d\n", columns(fis.rule));
printf ("AndMethod = %s\n", fis.andMethod);
printf ("OrMethod = %s\n", fis.orMethod);
printf ("ImpMethod = %s\n", fis.impMethod);
printf ("AggMethod = %s\n", fis.aggMethod);
printf ("DefuzzMethod = %s\n", fis.defuzzMethod);
retval = [];
endfunction
##----------------------------------------------------------------------
## Function: getfis_two_args
## Purpose: Handle calls to getfis that have 2 arguments. See the
## comment at the top of this file for more complete info.
##----------------------------------------------------------------------
function retval = getfis_two_args (fis, arg2)
## If not all of the arguments have the correct types, print an error
## message and halt.
if (!is_fis (fis))
error ("the first argument to getfis must be an FIS structure\n");
elseif (!(is_string (arg2) && ismember (tolower (arg2), {'name', ...
'type', 'version', 'numinputs', 'numoutputs', ...
'numinputmfs', 'numoutputmfs', 'numrules', 'andmethod', ...
'ormethod', 'impmethod', 'aggmethod', 'defuzzmethod', ...
'inlabels', 'outlabels', 'inrange', 'outrange', 'inmfs', ...
'outmfs', 'inmflabels', 'outmflabels', 'inmftypes', ...
'outmftypes', 'inmfparams', 'outmfparams', 'rulelist'})))
error ("unknown second argument to getfis\n");
endif
## Return the specified property of the FIS structure.
switch (tolower (arg2))
case 'name' retval = fis.name;
case 'type' retval = fis.type;
case 'version' retval = fis.version;
case 'numinputs' retval = columns (fis.input);
case 'numoutputs' retval = columns (fis.output);
case 'numrules' retval = columns(fis.rule);
case 'andmethod' retval = fis.andMethod;
case 'ormethod' retval = fis.orMethod;
case 'impmethod' retval = fis.impMethod;
case 'aggmethod' retval = fis.aggMethod;
case 'defuzzmethod' retval = fis.defuzzMethod;
case 'numinputmfs'
retval = [];
for i = 1 : columns (fis.input)
if (i == 1)
retval = columns(fis.input(i).mf);
else
retval = [retval columns(fis.input(i).mf)];
endif
endfor
case 'numoutputmfs'
retval = [];
for i = 1 : columns (fis.output)
if (i == 1)
retval = columns(fis.output(i).mf);
else
retval = [retval columns(fis.output(i).mf)];
endif
endfor
case 'inlabels'
retval = [];
for i = 1 : columns (fis.input)
if (i == 1)
retval = fis.input(i).name;
else
retval = [retval; fis.input(i).name];
endif
endfor
case 'outlabels'
retval = [];
for i = 1 : columns (fis.output)
if (i == 1)
retval = fis.output(i).name;
else
retval = [retval; fis.output(i).name];
endif
endfor
case 'inrange'
retval = [];
for i = 1 : columns (fis.input)
if (i == 1)
retval = fis.input(i).range;
else
retval = [retval; fis.input(i).range];
endif
endfor
case 'outrange'
retval = [];
for i = 1 : columns (fis.output)
if (i == 1)
retval = fis.output(i).range;
else
retval = [retval; fis.output(i).range];
endif
endfor
case 'inmfs'
retval = [];
for i = 1 : columns (fis.input)
if (i == 1)
retval = columns(fis.input(i).mf);
else
retval = [retval columns(fis.input(i).mf)];
endif
endfor
case 'outmfs'
retval = [];
for i = 1 : columns (fis.output)
if (i == 1)
retval = columns(fis.output(i).mf);
else
retval = [retval columns(fis.output(i).mf)];
endif
endfor
case 'inmflabels'
retval = [];
for i = 1 : columns (fis.input)
for j = 1 : columns (fis.input(i).mf)
if (i == 1 && y == 1)
retval = fis.input(i).mf(j).name;
else
retval = [retval; fis.input(i).mf(j).name];
endif
endfor
endfor
case 'outmflabels'
retval = [];
for i = 1 : columns (fis.output)
for j = 1 : columns (fis.output(i).mf)
if (i == 1 && y == 1)
retval = fis.output(i).mf(j).name;
else
retval = [retval; fis.output(i).mf(j).name];
endif
endfor
endfor
case 'inmftypes'
retval = [];
for i = 1 : columns (fis.input)
for j = 1 : columns (fis.input(i).mf)
if (i == 1 && y == 1)
retval = fis.input(i).mf(j).type;
else
retval = [retval; fis.input(i).mf(j).type];
endif
endfor
endfor
case 'outmftypes'
retval = [];
for i = 1 : columns (fis.output)
for j = 1 : columns (fis.output(i).mf)
if (i == 1 && y == 1)
retval = fis.output(i).mf(j).type;
else
retval = [retval; fis.output(i).mf(j).type];
endif
endfor
endfor
case 'inmfparams'
## Determine the dimensions of the matrix to return.
max_len = 0;
num_inputs = columns (fis.input);
num_mfs = 0;
for i = 1 : num_inputs
num_var_i_mfs = columns (fis.input(i).mf);
num_mfs += num_var_i_mfs;
for j = 1 : num_var_i_mfs
max_len = max (max_len, length (fis.input(i).mf(j).params));
endfor
endfor
## Assemble the matrix of params to return. Pad with zeros.
retval = zeros (num_mfs, max_len);
for i = 1 : num_inputs
for j = 1 : columns (fis.input(i).mf)
next_row_index = (i - 1) * max_len + j;
next_row = fis.input(i).mf(j).params;
retval(next_row_index, 1 : length (next_row)) = next_row;
endfor
endfor
case 'outmfparams'
## Determine the dimensions of the matrix to return.
max_len = 0;
num_outputs = columns (fis.output);
num_mfs = 0;
for i = 1 : num_outputs
num_var_i_mfs = columns (fis.output(i).mf);
num_mfs += num_var_i_mfs;
for j = 1 : num_var_i_mfs
max_len = max (max_len, length (fis.output(i).mf(j).params));
endfor
endfor
## Assemble the matrix of params to return. Pad with zeros.
retval = zeros (num_mfs, max_len);
for i = 1 : num_outputs
for j = 1 : columns (fis.output(i).mf)
next_row_index = (i - 1) * max_len + j;
next_row = fis.output(i).mf(j).params;
retval(next_row_index, 1 : length (next_row)) = next_row;
endfor
endfor
case 'rulelist'
## Determine the dimensions of the matrix to return.
num_inputs = columns (fis.input);
num_outputs = columns (fis.output);
num_rules = columns (fis.rule);
## Assemble the matrix of rules to return.
retval = zeros (num_rules, num_inputs + num_outputs + 2);
for i = 1 : num_rules
retval(i, 1:num_inputs) = fis.rule(i).antecedent;
retval(i, num_inputs+1:num_inputs+num_outputs) = ...
fis.rule(i).consequent;
retval(i, num_inputs+num_outputs+1) = fis.rule(i).weight;
retval(i, num_inputs+num_outputs+2) = fis.rule(i).connection;
endfor
otherwise
error ("internal error in getfis_two_args");
endswitch
endfunction
##----------------------------------------------------------------------
## Function: getfis_three_args
## Purpose: Handle calls to getfis that have 3 arguments. See the
## comment at the top of this file for more complete info.
##----------------------------------------------------------------------
function retval = getfis_three_args (fis, arg2, arg3)
## If not all of the arguments have the correct types, print an error
## message and halt.
if (!is_fis (fis))
error ("the first argument to getfis must be an FIS structure\n");
elseif (!(is_string (arg2) && ...
ismember (tolower (arg2), {'input','output'})))
error ("incorrect second argument to getfis\n");
elseif (!is_var_index (fis, arg2, arg3))
error ("incorrect third argument to getfis\n");
endif
## Print the properties of a specified input or output variable of the
## FIS structure. Return the empty set.
var_str = ["fis." tolower(arg2) "(" num2str(arg3) ")"];
var_mf_str = [var_str ".mf"];
num_mfs = columns (eval (var_mf_str));
printf ("Name = %s\n", eval ([var_str ".name"]));
printf ("NumMFs = %d\n", num_mfs);
printf ("MFLabels = \n");
for i = 1 : num_mfs
printf ("\t%s\n", eval ([var_mf_str "(" num2str(i) ").name"]));
endfor
printf ("Range = %s\n", mat2str (eval ([var_str ".range"])));
retval = [];
endfunction
##----------------------------------------------------------------------
## Function: getfis_four_args
## Purpose: Handle calls to getfis that have 4 arguments. See the
## comment at the top of this file for more complete info.
##----------------------------------------------------------------------
function retval = getfis_four_args (fis, arg2, arg3, arg4)
## If not all of the arguments have the correct types, print an error
## message and halt.
if (!is_fis (fis))
error ("the first argument to getfis must be an FIS structure\n");
elseif (!(is_string (arg2) && ...
ismember (tolower (arg2), {'input','output'})))
error ("incorrect second argument to getfis\n");
elseif (!is_var_index (fis, arg2, arg3))
error ("incorrect third argument to getfis\n");
elseif (!(is_string (arg4) && ismember (tolower (arg4), ...
{'name', 'range', 'nummfs', 'mflabels'})))
error ("incorrect fourth argument to getfis\n");
endif
## Return the specified property of the FIS input or output variable.
arg2 = tolower (arg2);
arg4 = tolower (arg4);
if (ismember (arg4, {'name', 'range'}))
retval = eval (["fis." arg2 "(" num2str(arg3) ")." arg4]);
elseif (strcmp (arg4, 'nummfs'))
retval = columns (eval (["fis." arg2 "(" num2str(arg3) ").mf"]));
elseif (strcmp (arg2, 'input') && strcmp (arg4, 'mflabels'))
retval = [];
for i = 1 : columns (fis.input)
for j = 1 : columns (fis.input(i).mf)
retval = [retval; fis.input(i).mf(j).name];
endfor
endfor
elseif (strcmp (arg2, 'output') && strcmp (arg4, 'mflabels'))
retval = [];
for i = 1 : columns (fis.output)
for j = 1 : columns (fis.output(i).mf)
retval = [retval; fis.output(i).mf(j).name];
endfor
endfor
endif
endfunction
##----------------------------------------------------------------------
## Function: getfis_five_args
## Purpose: Handle calls to getfis that have 5 arguments. See the
## comment at the top of this file for more complete info.
##----------------------------------------------------------------------
function retval = getfis_five_args (fis, arg2, arg3, arg4, arg5)
## If not all of the arguments have the correct types, print an error
## message and halt.
if (!is_fis (fis))
error ("the first argument to getfis must be an FIS structure\n");
elseif (!(is_string(arg2) && ...
ismember(tolower(arg2), {'input','output'})))
error ("incorrect second argument to getfis\n");
elseif (!is_var_index(fis, arg2, arg3))
error ("incorrect third argument to getfis\n");
elseif (!(is_string(arg4) && isequal(tolower(arg4), 'mf')))
error ("incorrect fourth argument to getfis\n");
elseif (!is_mf_index(fis, arg2, arg3, arg5))
error ("incorrect fifth argument to getfis\n");
endif
## Print the properties of a specified membership function of the
## FIS structure. Return the empty set.
var_mf_str = ["fis." tolower(arg2) "(" num2str(arg3) ").mf(" ...
num2str(arg5) ")"];
printf ("Name = %s\n", eval ([var_mf_str ".name"]));
printf ("Type = %s\n", eval ([var_mf_str ".type"]));
printf ("Params = ");
disp (eval ([var_mf_str ".params"]));
retval = [];
endfunction
##----------------------------------------------------------------------
## Function: getfis_six_args
## Purpose: Handle calls to getfis that have 6 arguments. See the
## comment at the top of this file for more complete info.
##----------------------------------------------------------------------
function retval = getfis_six_args (fis, arg2, arg3, arg4, arg5, arg6)
## If not all of the arguments have the correct types, print an error
## message and halt.
if (!is_fis (fis))
error ("the first argument to getfis must be an FIS structure\n");
elseif (!(is_string (arg2) && ...
ismember (tolower (arg2), {'input','output'})))
error ("incorrect second argument to getfis\n");
elseif (!is_var_index (fis, arg2, arg3))
error ("incorrect third argument to getfis\n");
elseif (!(is_string (arg4) && isequal (tolower (arg4), 'mf')))
error ("incorrect fourth argument to getfis\n");
elseif (!is_mf_index (fis, arg2, arg3, arg5))
error ("incorrect fifth argument to getfis\n");
elseif (!(is_string (arg6) && ismember (tolower (arg6), ...
{'name', 'type', 'params'})))
error ("incorrect sixth argument to getfis\n");
endif
## Return the specified membership function property.
retval = eval (["fis." tolower(arg2) "(" num2str(arg3) ").mf(" ...
num2str(arg5) ")." tolower(arg6)]);
endfunction
%!shared fis
%! fis = readfis ('mamdani_tip_calculator.fis');
## Test input validation
%!error <getfis requires 1-6 arguments>
%! getfis()
%!error <getfis: function called with too many inputs>
%! getfis(1, 2, 3, 4, 5, 6, 7)
%!error <the first argument to getfis must be an FIS structure>
%! getfis(1, 2, 3, 4, 5, 6)
%!error <incorrect second argument to getfis>
%! getfis(fis, 2, 3, 4, 5, 6)
%!error <incorrect third argument to getfis>
%! getfis(fis, 'input', 3, 4, 5, 6)
%!error <incorrect fourth argument to getfis>
%! getfis(fis, 'input', 1, 4, 5, 6)
%!error <incorrect fifth argument to getfis>
%! getfis(fis, 'input', 1, 'mf', 5, 6)
%!error <incorrect sixth argument to getfis>
%! getfis(fis, 'input', 1, 'mf', 1, 6)
|