## 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{x} =} raylinv (@var{p}, @var{sigma})
##
## Inverse of the Rayleigh cumulative distribution function (iCDF).
##
## For each element of @var{p}, compute the quantile (the inverse of the CDF) of
## the Rayleigh distribution with scale parameter @var{sigma}.  The size of
## @var{x} is the common size of @var{p} and @var{sigma}.  A scalar input
## functions as a constant matrix of the same size as the other inputs.
##
## 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{raylcdf, raylpdf, raylrnd, raylfit, rayllike, raylstat}
## @end deftypefn

function x = raylinv (p, sigma)

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

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

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

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

  ## Calculate Rayleigh iCDF
  x = sqrt (-2 .* log (1 - p) .* sigma .^ 2);

  ## Check for valid parameter and support
  k = find (p == 1);
  if (any (k))
    x(k) = Inf;
  endif

  k = find (! (p >= 0) | ! (p <= 1) | ! (sigma > 0));
  if (any (k))
    x(k) = NaN;
  endif

endfunction

%!demo
%! ## Plot various iCDFs from the Rayleigh distribution
%! p = 0.001:0.001:0.999;
%! x1 = raylinv (p, 0.5);
%! x2 = raylinv (p, 1);
%! x3 = raylinv (p, 2);
%! x4 = raylinv (p, 3);
%! x5 = raylinv (p, 4);
%! plot (p, x1, '-b', p, x2, 'g', p, x3, '-r', p, x4, '-m', p, x5, '-k')
%! grid on
%! ylim ([0, 10])
%! legend ({'σ = 0,5', 'σ = 1', 'σ = 2', ...
%!          'σ = 3', 'σ = 4'}, 'location', 'northwest')
%! title ('Rayleigh iCDF')
%! xlabel ('probability')
%! ylabel ('values in x')

## Test output
%!test
%! p = 0:0.1:0.5;
%! sigma = 1:6;
%! x = raylinv (p, sigma);
%! expected_x = [0.0000, 0.9181, 2.0041, 3.3784, 5.0538, 7.0645];
%! assert_equal (x, expected_x, 0.001);
%!test
%! p = 0:0.1:0.5;
%! x = raylinv (p, 0.5);
%! expected_x = [0.0000, 0.2295, 0.3340, 0.4223, 0.5054, 0.5887];
%! assert_equal (x, expected_x, 0.001);

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