X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?p=CreaPhase.git;a=blobdiff_plain;f=octave_packages%2Fcontrol-2.3.52%2Foptions.m;fp=octave_packages%2Fcontrol-2.3.52%2Foptions.m;h=702155907e40e566f3b040cc1762836a0395658e;hp=0000000000000000000000000000000000000000;hb=f5f7a74bd8a4900f0b797da6783be80e11a68d86;hpb=1705066eceaaea976f010f669ce8e972f3734b05 diff --git a/octave_packages/control-2.3.52/options.m b/octave_packages/control-2.3.52/options.m new file mode 100644 index 0000000..7021559 --- /dev/null +++ b/octave_packages/control-2.3.52/options.m @@ -0,0 +1,83 @@ +## Copyright (C) 2011 Lukas F. Reichlin +## +## This file is part of LTI Syncope. +## +## LTI Syncope 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. +## +## LTI Syncope 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 LTI Syncope. If not, see . + +## -*- texinfo -*- +## @deftypefn{Function File} {@var{opt} =} options (@var{"key1"}, @var{value1}, @var{"key2"}, @var{value2}, @dots{}) +## Create options struct @var{opt} from a number of key and value pairs. +## For use with order reduction commands. +## +## @strong{Inputs} +## @table @var +## @item key, property +## The name of the property. +## @item value +## The value of the property. +## @end table +## +## @strong{Outputs} +## @table @var +## @item opt +## Struct with fields for each key. +## @end table +## +## @strong{Example} +## @example +## @group +## octave:1> opt = options ("method", "spa", "tol", 1e-6) +## opt = +## +## scalar structure containing the fields: +## +## method = spa +## tol = 1.0000e-06 +## +## @end group +## @end example +## @example +## @group +## octave:2> save filename opt +## octave:3> # save the struct 'opt' to file 'filename' for later use +## octave:4> load filename +## octave:5> # load struct 'opt' from file 'filename' +## @end group +## @end example +## +## @end deftypefn + +## Author: Lukas Reichlin +## Created: November 2011 +## Version: 0.1 + +function opt = options (varargin) + + if (nargin == 0) + print_usage (); + endif + + if (rem (nargin, 2)) + error ("options: properties and values must come in pairs"); + endif + + ## alternative: opt = struct (varargin{:}); + + key = reshape (varargin(1:2:end-1), [], 1); + val = reshape (varargin(2:2:end), [], 1); + + opt = cell2struct (val, key, 1); + opt = orderfields (opt); + +endfunction \ No newline at end of file