Add a useful package (from Source forge) for octave

[CreaPhase.git] / octave_packages / financial-0.4.0 / datefind.m

diff --git a/octave_packages/financial-0.4.0/datefind.m b/octave_packages/financial-0.4.0/datefind.m
new file mode 100644 (file)
index 0000000..30a97a2
--- /dev/null
+++ b/octave_packages/financial-0.4.0/datefind.m
@@ -0,0 +1,44 @@
+## Copyright (C) 2008 Bill Denney <bill@denney.ws>
+##
+## 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} {indices =} datefind (subset, superset, tol)
+##
+## Find any instances of the @code{subset} in the @code{superset} with
+## the @code{tol}erance.  @code{tol} is 0 by default.
+##
+## @seealso{date, datenum}
+## @end deftypefn
+
+function idx = datefind (subset, superset, tol=0)
+
+  if (nargin < 2 || nargin > 3)
+    print_usage ();
+  elseif ! isscalar (tol)
+    error ("datefind: tol must be a scalar")
+  endif
+
+  idx = [];
+  for i = 1:numel (superset)
+    if any (subset(:) - tol <= superset(i) & superset(i) <= subset(:) + tol)
+      idx(end+1, 1) = i;
+    endif
+  endfor
+
+endfunction
+
+## Tests
+%!assert (datefind (datenum (1999, 7, [10;20]), datenum (1999, 7, 1:31)), [10;20])
+%!assert (datefind (datenum (1999, 7, [10;20]), datenum (1999, 7, 1:31), 1), [9;10;11;19;20;21])