octave_packages/statistics-1.1.3/gamstat.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}] =} gamstat (@var{a}, @var{b})
  18 ## Compute mean and variance of the gamma distribution.
  19 ##
  20 ## @subheading Arguments
  21 ##
  22 ## @itemize @bullet
  23 ## @item
  24 ## @var{a} is the first parameter of the gamma distribution. @var{a} must be
  25 ## positive
  26 ##
  27 ## @item
  28 ## @var{b} is the second parameter of the gamma distribution. @var{b} must be
  29 ## positive
  30 ## @end itemize
  31 ## @var{a} and @var{b} must be of common size or one of them must be scalar
  32 ##
  33 ## @subheading Return values
  34 ##
  35 ## @itemize @bullet
  36 ## @item
  37 ## @var{m} is the mean of the gamma distribution
  38 ##
  39 ## @item
  40 ## @var{v} is the variance of the gamma distribution
  41 ## @end itemize
  42 ##
  43 ## @subheading Examples
  44 ##
  45 ## @example
  46 ## @group
  47 ## a = 1:6;
  48 ## b = 1:0.2:2;
  49 ## [m, v] = gamstat (a, b)
  50 ## @end group
  51 ##
  52 ## @group
  53 ## [m, v] = gamstat (a, 1.5)
  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 gamma distribution
  73
  74 function [m, v] = gamstat (a, b)
  75
  76   # Check arguments
  77   if (nargin != 2)
  78     print_usage ();
  79   endif
  80
  81   if (! isempty (a) && ! ismatrix (a))
  82     error ("gamstat: a must be a numeric matrix");
  83   endif
  84   if (! isempty (b) && ! ismatrix (b))
  85     error ("gamstat: b must be a numeric matrix");
  86   endif
  87
  88   if (! isscalar (a) || ! isscalar (b))
  89     [retval, a, b] = common_size (a, b);
  90     if (retval > 0)
  91       error ("gamstat: a and b must be of common size or scalar");
  92     endif
  93   endif
  94
  95   # Calculate moments
  96   m = a .* b;
  97   v = a .* (b .^ 2);
  98
  99   # Continue argument check
 100   k = find (! (a > 0) | ! (a < Inf) | ! (b > 0) | ! (b < Inf));
 101   if (any (k))
 102     m(k) = NaN;
 103     v(k) = NaN;
 104   endif
 105
 106 endfunction
 107
 108 %!test
 109 %! a = 1:6;
 110 %! b = 1:0.2:2;
 111 %! [m, v] = gamstat (a, b);
 112 %! expected_m = [1.00, 2.40, 4.20,  6.40,  9.00, 12.00];
 113 %! expected_v = [1.00, 2.88, 5.88, 10.24, 16.20, 24.00];
 114 %! assert (m, expected_m, 0.001);
 115 %! assert (v, expected_v, 0.001);
 116
 117 %!test
 118 %! a = 1:6;
 119 %! [m, v] = gamstat (a, 1.5);
 120 %! expected_m = [1.50, 3.00, 4.50, 6.00,  7.50,  9.00];
 121 %! expected_v = [2.25, 4.50, 6.75, 9.00, 11.25, 13.50];
 122 %! assert (m, expected_m, 0.001);
 123 %! assert (v, expected_v, 0.001);