Add a useful package (from Source forge) for octave

[CreaPhase.git] / octave_packages / general-1.3.1 / @dict / get.m

diff --git a/octave_packages/general-1.3.1/@dict/get.m b/octave_packages/general-1.3.1/@dict/get.m
new file mode 100644 (file)
index 0000000..b455c3a
--- /dev/null
+++ b/octave_packages/general-1.3.1/@dict/get.m
@@ -0,0 +1,56 @@
+## Copyright (C) 2009 VZLU Prague, a.s., Czech Republic
+##
+## 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 3 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, see <http://www.gnu.org/licenses/>.
+
+## -*- texinfo -*-
+## @deftypefn{Function File} {} get (d, key, defv)
+## Queries for the values of specified key(s). Unlike indexing, however,
+## this does not throw an error if a key is missing but rather substitutes
+## a default value. If @var{key} is a cell array, @var{defv} should be either
+## a cell array of the same shape as @var{key}, or a singleton cell.
+## Non-cell values will be converted to a singleton cell.
+## @end deftypefn
+
+## Author: Jaroslav Hajek <highegg@gmail.com>
+
+function val = get (d, key, defv = [])
+  if (nargin < 2 || nargin > 3)
+    print_usage ();
+  endif
+
+  if (ischar (key))
+    i = lookup (d.keys, key, "m");
+    if (i)
+      val = d.values{i};
+    else
+      val = defv;
+    endif
+  elseif (iscellstr (key))
+    if (! iscell (defv))
+      val = repmat ({defv}, size (key));
+    elseif (numel (defv) == 1)
+      val = repmat (defv, size (key));
+    elseif (size_equal (key, defv))
+      val = defv;
+    else
+      error ("get: sizes of key & defv must match");
+    endif
+    i = lookup (d.keys, key, "m");
+    mask = i != 0;
+    val(mask) = d.values(i(mask));
+  else
+    error ("get: invalid key value");
+  endif
+endfunction
+