octave_packages/specfun-1.1.0/heaviside.m

   1 ## Copyright (C) 2006   Sylvain Pelissier   <sylvain.pelissier@gmail.com>
   2 ##
   3 ## This program is free software; you can redistribute it and/or modify
   4 ## it under the terms of the GNU General Public License as published by
   5 ## the Free Software Foundation; either version 3 of the License, or
   6 ## (at your option) any later version.
   7 ##
   8 ## This program is distributed in the hope that it will be useful,
   9 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 ## GNU General Public License for more details.
  12 ##
  13 ## You should have received a copy of the GNU General Public License
  14 ## along with this program; If not, see <http://www.gnu.org/licenses/>.
  15
  16 ## -*- texinfo -*-
  17 ## @deftypefn {Function File} {} heaviside(@var{x})
  18 ## @deftypefnx{Function File} {} heaviside(@var{x}, @var{zero_value})
  19 ## Compute the Heaviside step function.
  20 ##
  21 ## The Heaviside function is defined as
  22 ##
  23 ## @example
  24 ##   Heaviside (@var{x}) = 1,   @var{x} > 0
  25 ##   Heaviside (@var{x}) = 0,   @var{x} < 0
  26 ## @end example
  27 ##
  28 ## @noindent
  29 ## The value of the Heaviside function at @var{x} = 0 is by default 0.5,
  30 ## but can be changed via the optional second input argument.
  31 ## @seealso{dirac}
  32 ## @end deftypefn
  33
  34 function y = heaviside (x, zero_value = 0.5)
  35   if (nargin < 1)
  36     print_usage ();
  37   endif
  38
  39   y = cast (x > 0, class (x));
  40   y (x == 0) = zero_value;
  41 endfunction