## Copyright (C) 2012 Rik Wehbring
## Copyright (C) 1995-2016 Kurt Hornik
## 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{y} =} lognpdf (@var{x})
## @deftypefnx {statistics} {@var{y} =} lognpdf (@var{x}, @var{mu})
## @deftypefnx {statistics} {@var{y} =} lognpdf (@var{x}, @var{mu}, @var{sigma})
##
## Lognormal probability density function (PDF).
##
## For each element of @var{x}, compute the probability density function (PDF)
## of the lognormal distribution with mean parameter @var{mu} and standard
## deviation parameter @var{sigma}, each corresponding to the associated normal
## distribution.  The size of @var{y} is the common size of @var{p}, @var{mu},
## and @var{sigma}.  A scalar input functions as a constant matrix of the same
## size as the other inputs.
##
## If a random variable follows this distribution, its logarithm is normally
## distributed with mean @var{mu} and standard deviation @var{sigma}.
##
## Default parameter values are @qcode{@var{mu} = 0} and
## @qcode{@var{sigma} = 1}.  Both parameters must be reals and
## @qcode{@var{sigma} > 0}.  For @qcode{@var{sigma} <= 0}, @qcode{NaN} is
## returned.
##
## Further information about the lognormal distribution can be found at
## @url{https://en.wikipedia.org/wiki/Log-normal_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.
##
## @seealso{logncdf, logninv, lognrnd, lognfit, lognlike, lognstat}
## @end deftypefn

function y = lognpdf (x, mu = 0, sigma = 1)

  ## Check for valid number of input arguments
  if (nargin < 1 || nargin > 3)
    print_usage ();
  endif

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

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

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

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

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

  ## Compute lognormal PDF
  k = isnan (x) | ! (sigma > 0) | ! (sigma < Inf);
  y(k) = NaN;

  k = (x > 0) & (x < Inf) & (sigma > 0) & (sigma < Inf);
  if (isscalar (mu) && isscalar (sigma))
    y(k) = normpdf (log (x(k)), mu, sigma) ./ x(k);
  else
    y(k) = normpdf (log (x(k)), mu(k), sigma(k)) ./ x(k);
  endif

endfunction

%!demo
%! ## Plot various PDFs from the log-normal distribution
%! x = 0:0.01:5;
%! y1 = lognpdf (x, 0, 1);
%! y2 = lognpdf (x, 0, 0.5);
%! y3 = lognpdf (x, 0, 0.25);
%! plot (x, y1, '-b', x, y2, '-g', x, y3, '-r')
%! grid on
%! ylim ([0, 2])
%! legend ({'μ = 0, σ = 1', 'μ = 0, σ = 0.5', 'μ = 0, σ = 0.25'}, ...
%!          'location', 'northeast')
%! title ('Log-normal PDF')
%! xlabel ('values in x')
%! ylabel ('density')

## Test output
%!shared x, y
%! x = [-1 0 e Inf];
%! y = [0, 0, 1/(e*sqrt(2*pi)) * exp(-1/2), 0];
%!assert_equal (lognpdf (x, zeros (1,4), ones (1,4)), y, eps)
%!assert_equal (lognpdf (x, 0, ones (1,4)), y, eps)
%!assert_equal (lognpdf (x, zeros (1,4), 1), y, eps)
%!assert_equal (lognpdf (x, [0 1 NaN 0], 1), [0 0 NaN y(4)], eps)
%!assert_equal (lognpdf (x, 0, [0 NaN Inf 1]), [NaN NaN NaN y(4)], eps)
%!assert_equal (lognpdf ([x, NaN], 0, 1), [y, NaN], eps)

## Test class of input preserved
%!assert_equal (lognpdf (single ([x, NaN]), 0, 1), single ([y, NaN]), eps ('single'))
%!assert_equal (lognpdf ([x, NaN], single (0), 1), single ([y, NaN]), eps ('single'))
%!assert_equal (lognpdf ([x, NaN], 0, single (1)), single ([y, NaN]), eps ('single'))

## Test input validation
%!error<lognpdf: X, MU, and SIGMA must be double or single.> lognpdf (int32 (2), 0, 1)
%!error<lognpdf: X, MU, and SIGMA must be double or single.> lognpdf (true, 0, 1)
%!error<lognpdf: X, MU, and SIGMA must be double or single.> lognpdf ('a', 0, 1)
%!error lognpdf ()
%!error lognpdf (1,2,3,4)
%!error lognpdf (ones (3), ones (2), ones (2))
%!error lognpdf (ones (2), ones (3), ones (2))
%!error lognpdf (ones (2), ones (2), ones (3))
%!error lognpdf (i, 2, 2)
%!error lognpdf (2, i, 2)
%!error lognpdf (2, 2, i)
