## Copyright (C) 2006, 2007 Arno Onken <asnelt@asnelt.org>
## Copyright (C) 2023 Andreas Bertsatos <abertsatos@biol.uoa.gr>
##
## This file is part of the statistics package for GNU Octave.
##
## 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  {statistics} {@var{p} =} raylcdf (@var{x}, @var{sigma})
## @deftypefnx {statistics} {@var{p} =} raylcdf (@var{x}, @var{sigma}, @qcode{'upper'})
##
## Rayleigh cumulative distribution function (CDF).
##
## For each element of @var{x}, compute the cumulative distribution function
## (CDF) of the Rayleigh distribution with scale parameter @var{sigma}. The
## size of @var{p} is the common size of @var{x} and @var{sigma}.  A scalar
## input functions as a constant matrix of the same size as the other inputs.
##
## @code{@var{p} = raylcdf (@var{x}, @var{sigma}, "upper")} computes the upper
## tail probability of the Rayleigh distribution with parameter @var{sigma}, at
## the values in @var{x}.
##
## Further information about the Rayleigh distribution can be found at
## @url{https://en.wikipedia.org/wiki/Rayleigh_distribution}
##
## Input arguments must be @qcode{double} or @qcode{single}; integer, logical,
## and character arrays are rejected.  MATLAB accepts a character array and
## evaluates it at the character codes, which Octave deliberately does not,
## since a character array is an integer type and integers are refused too.
##
## The @code{prob.RayleighDistribution} class names this same parameter
## @qcode{B}, after MATLAB.
## @seealso{raylinv, raylpdf, raylrnd, raylfit, rayllike, raylstat}
## @end deftypefn

function p = raylcdf (x, sigma, uflag)

  ## Check for valid number of input arguments
  if (nargin < 2)
    error ("raylcdf: function called with too few input arguments.");
  endif

  ## Check for "upper" flag
  if (nargin == 3 && strcmpi (uflag, 'upper'))
    uflag = true;
  elseif (nargin == 3  && ! strcmpi (uflag, 'upper'))
    error ("raylcdf: invalid argument for upper tail.");
  else
    uflag = false;
  endif

  ## Check for common size of X and SIGMA
  if (! isscalar (x) || ! isscalar (sigma))
    [retval, x, sigma] = common_size (x, sigma);
    if (retval > 0)
      error ("raylcdf: X and SIGMA must be of common size or scalars.");
    endif
  endif

  ## Check for X and SIGMA being double or single
  if (! (isfloat (x) && isfloat (sigma)))
    error ("raylcdf: X and SIGMA must be double or single.");
  endif

  ## Check for X and SIGMA being reals
  if (iscomplex (x) || iscomplex (sigma))
    error ("raylcdf: X and SIGMA must not be complex.");
  endif

  ## Check for class type
  if (isa (x, 'single') || isa (sigma, 'single'));
    p = zeros (size (x), 'single');
  else
    p = zeros (size (x));
  endif

  ## Force 1 for upper flag and X <= 0
  k0 = sigma > 0 & x <= 0;
  if (uflag && any (k0(:)))
    p(k0) = 1;
  endif

  ## Calculate Rayleigh CDF for valid parameter and data range
  k = sigma > 0 & x > 0;
  if (any (k(:)))
    if (uflag)
        p(k) = exp (-x(k) .^ 2 ./ (2 * sigma(k) .^ 2));
    else
        p(k) = - expm1 (-x(k) .^ 2 ./ (2 * sigma(k) .^ 2));
    endif
  endif

  ## Continue argument check
  p(! (k0 | k)) = NaN;

endfunction

%!demo
%! ## Plot various CDFs from the Rayleigh distribution
%! x = 0:0.01:10;
%! p1 = raylcdf (x, 0.5);
%! p2 = raylcdf (x, 1);
%! p3 = raylcdf (x, 2);
%! p4 = raylcdf (x, 3);
%! p5 = raylcdf (x, 4);
%! plot (x, p1, '-b', x, p2, 'g', x, p3, '-r', x, p4, '-m', x, p5, '-k')
%! grid on
%! ylim ([0, 1])
%! legend ({'σ = 0.5', 'σ = 1', 'σ = 2', ...
%!          'σ = 3', 'σ = 4'}, 'location', 'southeast')
%! title ('Rayleigh CDF')
%! xlabel ('values in x')
%! ylabel ('probability')

## Test output
%!test
%! x = 0:0.5:2.5;
%! sigma = 1:6;
%! p = raylcdf (x, sigma);
%! expected_p = [0.0000, 0.0308, 0.0540, 0.0679, 0.0769, 0.0831];
%! assert_equal (p, expected_p, 0.001);
%!test
%! x = 0:0.5:2.5;
%! p = raylcdf (x, 0.5);
%! expected_p = [0.0000, 0.3935, 0.8647, 0.9889, 0.9997, 1.0000];
%! assert_equal (p, expected_p, 0.001);
%!shared x, p
%! x = [-1, 0, 1, 2, Inf];
%! p = [0, 0, 0.39346934028737, 0.86466471676338, 1];
%!assert_equal (raylcdf (x, 1), p, 1e-14)
%!assert_equal (raylcdf (x, 1, 'upper'), 1 - p, 1e-14)

## Test input validation
%!error<raylcdf: function called with too few input arguments.> raylcdf ()
%!error<raylcdf: function called with too few input arguments.> raylcdf (1)
%!error<raylcdf: invalid argument for upper tail.> raylcdf (1, 2, 'uper')
%!error<raylcdf: invalid argument for upper tail.> raylcdf (1, 2, 3)
%!error<raylcdf: X and SIGMA must be of common size or scalars.> ...
%! raylcdf (ones (3), ones (2))
%!error<raylcdf: X and SIGMA must be of common size or scalars.> ...
%! raylcdf (ones (2), ones (3))
%!error<raylcdf: X and SIGMA must be double or single.> raylcdf (int32 (2), 2)
%!error<raylcdf: X and SIGMA must be double or single.> raylcdf (true, 2)
%!error<raylcdf: X and SIGMA must be double or single.> raylcdf ('a', 2)
%!error<raylcdf: X and SIGMA must not be complex.> raylcdf (i, 2)
%!error<raylcdf: X and SIGMA must not be complex.> raylcdf (2, i)
