Mercurial > hg > octave-nkf
annotate scripts/statistics/distributions/wblcdf.m @ 10821:693e22af08ae
Grammarcheck documentation of m-files
Add newlines between @item fields for readability.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Mon, 26 Jul 2010 21:25:36 -0700 |
| parents | be55736a0783 |
| children | a4f482e66b65 |
| rev | line source |
|---|---|
| 9245 | 1 ## Copyright (C) 1995, 1996, 1997, 2006, 2007, 2009 Kurt Hornik |
| 5693 | 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. | |
| 5693 | 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/>. | |
| 5693 | 18 |
| 19 ## -*- texinfo -*- | |
| 20 ## @deftypefn {Function File} {} wblcdf (@var{x}, @var{scale}, @var{shape}) | |
| 21 ## Compute the cumulative distribution function (CDF) at @var{x} of the | |
| 22 ## Weibull distribution with shape parameter @var{scale} and scale | |
| 23 ## parameter @var{shape}, which is | |
| 6754 | 24 ## @tex |
| 25 ## $$ 1 - \exp(-(x/shape)^{scale}) $$ | |
| 26 ## for $x\geq 0$. | |
| 27 ## @end tex | |
| 28 ## @ifnottex | |
|
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
29 ## |
| 5693 | 30 ## @example |
| 31 ## 1 - exp(-(x/shape)^scale) | |
| 32 ## @end example | |
|
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
33 ## |
|
10793
be55736a0783
Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents:
10525
diff
changeset
|
34 ## for @var{x} @geq{} 0. |
| 6754 | 35 ## @end ifnottex |
| 5693 | 36 ## @end deftypefn |
| 37 | |
| 38 ## Author: KH <Kurt.Hornik@wu-wien.ac.at> | |
| 39 ## Description: CDF of the Weibull distribution | |
| 40 | |
| 41 function cdf = wblcdf (x, scale, shape) | |
| 42 | |
| 43 if (nargin < 1 || nargin > 3) | |
| 6046 | 44 print_usage (); |
| 5693 | 45 endif |
| 46 | |
| 47 if (nargin < 3) | |
| 48 shape = 1; | |
| 49 endif | |
| 50 | |
| 51 if (nargin < 2) | |
| 52 scale = 1; | |
| 53 endif | |
| 54 | |
| 55 if (!isscalar (shape) || !isscalar (scale)) | |
| 56 [retval, x, shape, scale] = common_size (x, shape, scale); | |
| 57 if (retval > 0) | |
| 58 error ("wblcdf: x, scale and shape must be of common size or scalar"); | |
| 59 endif | |
| 60 endif | |
| 61 | |
|
10525
3306cfcb856e
Replace constructs like "NaN * one()" with "NaN()" and "Inf * ones ()" with "Inf()"
David Bateman <dbateman@free.fr>
parents:
9245
diff
changeset
|
62 cdf = NaN (size (x)); |
| 5693 | 63 |
| 64 ok = ((shape > 0) & (shape < Inf) & (scale > 0) & (scale < Inf)); | |
| 65 | |
| 66 k = find ((x <= 0) & ok); | |
| 67 if (any (k)) | |
| 68 cdf(k) = 0; | |
| 69 endif | |
| 70 | |
| 71 k = find ((x > 0) & (x < Inf) & ok); | |
| 72 if (any (k)) | |
| 73 if (isscalar (shape) && isscalar (scale)) | |
| 74 cdf(k) = 1 - exp (- (x(k) / scale) .^ shape); | |
| 75 else | |
| 76 cdf(k) = 1 - exp (- (x(k) ./ scale(k)) .^ shape(k)); | |
| 77 endif | |
| 78 endif | |
| 79 | |
| 80 k = find ((x == Inf) & ok); | |
| 81 if (any (k)) | |
| 82 cdf(k) = 1; | |
| 83 endif | |
| 84 | |
| 85 endfunction |