Add a useful package (from Source forge) for octave

[CreaPhase.git] / octave_packages / miscellaneous-1.1.0 / clip.m

diff --git a/octave_packages/miscellaneous-1.1.0/clip.m b/octave_packages/miscellaneous-1.1.0/clip.m
new file mode 100644 (file)
index 0000000..16b7618
--- /dev/null
+++ b/octave_packages/miscellaneous-1.1.0/clip.m
@@ -0,0 +1,66 @@
+## Copyright (C) 1999 Paul Kienzle <pkienzle@users.sf.net>
+##
+## 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} {@var{x} =} clip (@var{x})
+## @deftypefnx {Function File} {@var{x} =} clip (@var{x}, @var{hi})
+## @deftypefnx {Function File} {@var{x} =} clip (@var{x}, [@var{lo}, @var{hi}])
+## Clip @var{x} values outside the range.to the value at the boundary of the
+## range.
+##
+## Range boundaries, @var{lo} and @var{hi}, default to 0 and 1 respectively.
+##
+## @var{x} = clip (@var{x})
+##   Clip to range [0, 1]
+##
+## @var{x} = clip (@var{x}, @var{hi})
+##   Clip to range [0, @var{hi}]
+##
+## @var{x} = clip (@var{x}, [@var{lo}, @var{hi}])
+##   Clip to range [@var{lo}, @var{hi}]
+## @end deftypefn
+
+## TODO: more clip modes, such as three level clip(X, [lo, mid, hi]), which
+## TODO: sends everything above hi to hi, below lo to lo and between to
+## TODO: mid; or infinite peak clipping, which sends everything above mid
+## TODO: to hi and below mid to lo.
+
+function x = clip (x, range = [0, 1])
+
+  if (nargin < 1 || nargin > 2)
+    print_usage;
+  else
+    if (numel (range) == 2)
+      ## do nothing, it's good
+    elseif (numel (range) == 1)
+      range = [0, range];
+    else
+      print_usage;
+    endif
+  endif
+
+  x (x > range (2)) = range (2);
+  x (x < range (1)) = range (1);
+
+endfunction
+
+%!error clip
+%!error clip(1,2,3)
+%!assert (clip(pi), 1)
+%!assert (clip(-pi), 0)
+%!assert (clip([-1.5, 0, 1.5], [-1, 1]), [-1, 0, 1]);
+%!assert (clip([-1.5, 0, 1.5]', [-1, 1]'), [-1, 0, 1]');
+%!assert (clip([-1.5, 1; 0, 1.5], [-1, 1]), [-1, 1; 0, 1]);
+%!assert (isempty(clip([],1)));