octave_packages/statistics-1.1.3/lognstat.m

   1 ## Copyright (C) 2006, 2007 Arno Onken <asnelt@asnelt.org>
   2 ##
   3 ## This program is free software; you can redistribute it and/or modify it under
   4 ## the terms of the GNU General Public License as published by the Free Software
   5 ## Foundation; either version 3 of the License, or (at your option) any later
   6 ## version.
   7 ##
   8 ## This program is distributed in the hope that it will be useful, but WITHOUT
   9 ## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10 ## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
  11 ## details.
  12 ##
  13 ## You should have received a copy of the GNU General Public License along with
  14 ## this program; if not, see <http://www.gnu.org/licenses/>.
  15
  16 ## -*- texinfo -*-
  17 ## @deftypefn {Function File} {[@var{m}, @var{v}] =} lognstat (@var{mu}, @var{sigma})
  18 ## Compute mean and variance of the lognormal distribution.
  19 ##
  20 ## @subheading Arguments
  21 ##
  22 ## @itemize @bullet
  23 ## @item
  24 ## @var{mu} is the first parameter of the lognormal distribution
  25 ##
  26 ## @item
  27 ## @var{sigma} is the second parameter of the lognormal distribution.
  28 ## @var{sigma} must be positive or zero
  29 ## @end itemize
  30 ## @var{mu} and @var{sigma} must be of common size or one of them must be
  31 ## scalar
  32 ##
  33 ## @subheading Return values
  34 ##
  35 ## @itemize @bullet
  36 ## @item
  37 ## @var{m} is the mean of the lognormal distribution
  38 ##
  39 ## @item
  40 ## @var{v} is the variance of the lognormal distribution
  41 ## @end itemize
  42 ##
  43 ## @subheading Examples
  44 ##
  45 ## @example
  46 ## @group
  47 ## mu = 0:0.2:1;
  48 ## sigma = 0.2:0.2:1.2;
  49 ## [m, v] = lognstat (mu, sigma)
  50 ## @end group
  51 ##
  52 ## @group
  53 ## [m, v] = lognstat (0, sigma)
  54 ## @end group
  55 ## @end example
  56 ##
  57 ## @subheading References
  58 ##
  59 ## @enumerate
  60 ## @item
  61 ## Wendy L. Martinez and Angel R. Martinez. @cite{Computational Statistics
  62 ## Handbook with MATLAB}. Appendix E, pages 547-557, Chapman & Hall/CRC,
  63 ## 2001.
  64 ##
  65 ## @item
  66 ## Athanasios Papoulis. @cite{Probability, Random Variables, and Stochastic
  67 ## Processes}. McGraw-Hill, New York, second edition, 1984.
  68 ## @end enumerate
  69 ## @end deftypefn
  70
  71 ## Author: Arno Onken <asnelt@asnelt.org>
  72 ## Description: Moments of the lognormal distribution
  73
  74 function [m, v] = lognstat (mu, sigma)
  75
  76   # Check arguments
  77   if (nargin != 2)
  78     print_usage ();
  79   endif
  80
  81   if (! isempty (mu) && ! ismatrix (mu))
  82     error ("lognstat: mu must be a numeric matrix");
  83   endif
  84   if (! isempty (sigma) && ! ismatrix (sigma))
  85     error ("lognstat: sigma must be a numeric matrix");
  86   endif
  87
  88   if (! isscalar (mu) || ! isscalar (sigma))
  89     [retval, mu, sigma] = common_size (mu, sigma);
  90     if (retval > 0)
  91       error ("lognstat: mu and sigma must be of common size or scalar");
  92     endif
  93   endif
  94
  95   # Calculate moments
  96   m = exp (mu + (sigma .^ 2) ./ 2);
  97   v = (exp (sigma .^ 2) - 1) .* exp (2 .* mu + sigma .^ 2);
  98
  99   # Continue argument check
 100   k = find (! (sigma >= 0) | ! (sigma < Inf));
 101   if (any (k))
 102     m(k) = NaN;
 103     v(k) = NaN;
 104   endif
 105
 106 endfunction
 107
 108 %!test
 109 %! mu = 0:0.2:1;
 110 %! sigma = 0.2:0.2:1.2;
 111 %! [m, v] = lognstat (mu, sigma);
 112 %! expected_m = [1.0202, 1.3231, 1.7860, 2.5093,  3.6693,   5.5845];
 113 %! expected_v = [0.0425, 0.3038, 1.3823, 5.6447, 23.1345, 100.4437];
 114 %! assert (m, expected_m, 0.001);
 115 %! assert (v, expected_v, 0.001);
 116
 117 %!test
 118 %! sigma = 0.2:0.2:1.2;
 119 %! [m, v] = lognstat (0, sigma);
 120 %! expected_m = [1.0202, 1.0833, 1.1972, 1.3771, 1.6487,  2.0544];
 121 %! expected_v = [0.0425, 0.2036, 0.6211, 1.7002, 4.6708, 13.5936];
 122 %! assert (m, expected_m, 0.001);
 123 %! assert (v, expected_v, 0.001);