Mercurial > hg > octave-nkf
annotate scripts/deprecated/lognormal_pdf.m @ 7693:8e5371d47da6
note version when functions were deprecated
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Thu, 03 Apr 2008 21:56:23 -0400 |
| parents | a1dbe9d80eee |
| children | 0a362fa8f3c8 |
| rev | line source |
|---|---|
| 7017 | 1 ## Copyright (C) 1995, 1996, 1997, 2005, 2006, 2007 Kurt Hornik |
| 5411 | 2 ## |
| 3 ## This file is part of Octave. | |
| 4 ## | |
| 5 ## Octave is free software; you can redistribute it and/or modify it | |
| 6 ## under the terms of the GNU General Public License as published by | |
| 7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
| 8 ## your option) any later version. | |
| 5411 | 9 ## |
| 10 ## Octave is distributed in the hope that it will be useful, but | |
| 11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 ## General Public License for more details. | |
| 14 ## | |
| 15 ## You should have received a copy of the GNU General Public License | |
| 7016 | 16 ## along with Octave; see the file COPYING. If not, see |
| 17 ## <http://www.gnu.org/licenses/>. | |
| 5411 | 18 |
| 19 ## -*- texinfo -*- | |
| 20 ## @deftypefn {Function File} {} lognormal_pdf (@var{x}, @var{a}, @var{v}) | |
| 21 ## For each element of @var{x}, compute the probability density function | |
| 22 ## (PDF) at @var{x} of the lognormal distribution with parameters | |
| 23 ## @var{a} and @var{v}. If a random variable follows this distribution, | |
| 24 ## its logarithm is normally distributed with mean @code{log (@var{a})} | |
| 25 ## and variance @var{v}. | |
| 26 ## | |
| 27 ## Default values are @var{a} = 1, @var{v} = 1. | |
| 28 ## @end deftypefn | |
| 29 | |
| 5428 | 30 ## Author: KH <Kurt.Hornik@wu-wien.ac.at> |
| 5411 | 31 ## Description: PDF of the log normal distribution |
| 32 | |
|
7693
8e5371d47da6
note version when functions were deprecated
John W. Eaton <jwe@octave.org>
parents:
7017
diff
changeset
|
33 ## Deprecated in version 3.0 |
|
8e5371d47da6
note version when functions were deprecated
John W. Eaton <jwe@octave.org>
parents:
7017
diff
changeset
|
34 |
| 5411 | 35 function pdf = lognormal_pdf (varargin) |
| 36 | |
| 5692 | 37 if (nargin > 1) |
| 38 a = varargin{2}; | |
| 39 idx = a >= 0; | |
| 40 a(idx) = log (a(idx)); | |
| 41 a(!idx) = NaN; | |
| 42 varargin{2} = a; | |
| 43 endif | |
| 44 | |
| 45 if (nargin > 2) | |
| 46 v = varargin{3}; | |
| 47 idx = v >= 0; | |
| 48 v(idx) = sqrt (v(idx)); | |
| 49 v(!idx) = NaN; | |
| 50 varargin{3} = v; | |
| 51 endif | |
| 52 | |
| 53 pdf = lognpdf (varargin{:}); | |
| 5411 | 54 |
| 55 endfunction |