octave-nkf: scripts/statistics/distributions/wblpdf.m annotate

annotate scripts/statistics/distributions/wblpdf.m @ 20595:c1a6c31ac29a

eliminate more simple uses of error_state * ov-classdef.cc: Eliminate simple uses of error_state.

author	John W. Eaton <jwe@octave.org>
date	Tue, 06 Oct 2015 00:20:02 -0400
parents	d9341b422488
children

rev	line source
14138 72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 13171 diff changeset	1 ## Copyright (C) 2012 Rik Wehbring
19731 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	2 ## Copyright (C) 1995-2015 Kurt Hornik
5693 446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	3 ##
446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	4 ## This file is part of Octave.
446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	5 ##
446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	6 ## Octave is free software; you can redistribute it and/or modify it
446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	7 ## under the terms of the GNU General Public License as published by
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6754 diff changeset	8 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6754 diff changeset	9 ## your option) any later version.
5693 446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	10 ##
446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	11 ## Octave is distributed in the hope that it will be useful, but
446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	14 ## General Public License for more details.
446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	15 ##
446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	16 ## You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6754 diff changeset	17 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6754 diff changeset	18 ## <http://www.gnu.org/licenses/>.
5693 446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	19
446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	20 ## -- texinfo --
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	21 ## @deftypefn {Function File} {} wblpdf (@var{x})
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	22 ## @deftypefnx {Function File} {} wblpdf (@var{x}, @var{scale})
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	23 ## @deftypefnx {Function File} {} wblpdf (@var{x}, @var{scale}, @var{shape})
5693 446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	24 ## Compute the probability density function (PDF) at @var{x} of the
20209 d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19867 diff changeset	25 ## Weibull distribution with scale parameter @var{scale} and
d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19867 diff changeset	26 ## shape parameter @var{shape}.
d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19867 diff changeset	27 ##
d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19867 diff changeset	28 ## This is given by
6754 451b346d8c2f [project @ 2007-06-25 17:31:46 by jwe] jwe parents: 6046 diff changeset	29 ## @tex
11128 9cb5c0b7b43b Fix reversed documentation for shape and scale parameters in Weibull family of functions. Rik <octave@nomad.inbox5.com> parents: 10687 diff changeset	30 ## $$ {shape \over scale^{shape}} \cdot x^{shape-1} \cdot e^{-({x \over scale})^{shape}} $$
6754 451b346d8c2f [project @ 2007-06-25 17:31:46 by jwe] jwe parents: 6046 diff changeset	31 ## @end tex
451b346d8c2f [project @ 2007-06-25 17:31:46 by jwe] jwe parents: 6046 diff changeset	32 ## @ifnottex
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10549 diff changeset	33 ##
5693 446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	34 ## @example
14327 4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	35 ## shape * scale^(-shape) * x^(shape-1) * exp (-(x/scale)^shape)
5693 446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	36 ## @end example
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10549 diff changeset	37 ##
6754 451b346d8c2f [project @ 2007-06-25 17:31:46 by jwe] jwe parents: 6046 diff changeset	38 ## @end ifnottex
5693 446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	39 ## @noindent
11563 3c6e8aaa9555 Grammarcheck m-files before 3.4 release. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	40 ## for @var{x} @geq{} 0.
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	41 ##
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	42 ## Default values are @var{scale} = 1, @var{shape} = 1.
5693 446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	43 ## @end deftypefn
446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	44
446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	45 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	46 ## Description: PDF of the Weibull distribution
446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	47
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	48 function pdf = wblpdf (x, scale = 1, shape = 1)
5693 446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	49
446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	50 if (nargin < 1 \|\| nargin > 3)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5693 diff changeset	51 print_usage ();
5693 446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	52 endif
446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	53
19867 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19731 diff changeset	54 if (! isscalar (scale) \|\| ! isscalar (shape))
11128 9cb5c0b7b43b Fix reversed documentation for shape and scale parameters in Weibull family of functions. Rik <octave@nomad.inbox5.com> parents: 10687 diff changeset	55 [retval, x, scale, shape] = common_size (x, scale, shape);
5693 446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	56 if (retval > 0)
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	57 error ("wblpdf: X, SCALE, and SHAPE must be of common size or scalars");
5693 446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	58 endif
446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	59 endif
446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	60
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	61 if (iscomplex (x) \|\| iscomplex (scale) \|\| iscomplex (shape))
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	62 error ("wblpdf: X, SCALE, and SHAPE must not be complex");
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	63 endif
5693 446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	64
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	65 if (isa (x, "single") \|\| isa (scale, "single") \|\| isa (shape, "single"))
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	66 pdf = NaN (size (x), "single");
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	67 else
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	68 pdf = NaN (size (x));
5693 446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	69 endif
446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	70
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	71 ok = ((scale > 0) & (scale < Inf) & (shape > 0) & (shape < Inf));
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	72
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	73 k = (x < 0) & ok;
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	74 pdf(k) = 0;
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	75
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	76 k = (x >= 0) & (x < Inf) & ok;
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	77 if (isscalar (scale) && isscalar (shape))
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	78 pdf(k) = (shape * (scale .^ -shape)
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	79 .* (x(k) .^ (shape - 1))
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	80 .* exp (- (x(k) / scale) .^ shape));
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	81 else
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	82 pdf(k) = (shape(k) .* (scale(k) .^ -shape(k))
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	83 .* (x(k) .^ (shape(k) - 1))
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	84 .* exp (- (x(k) ./ scale(k)) .^ shape(k)));
5693 446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	85 endif
446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	86
446b28529300 [project @ 2006-03-17 18:16:03 by jwe] jwe parents: diff changeset	87 endfunction
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	88
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	89
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	90 %!shared x,y
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	91 %! x = [-1 0 0.5 1 Inf];
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	92 %! y = [0, exp(-x(2:4)), NaN];
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	93 %!assert (wblpdf (x, ones (1,5), ones (1,5)), y)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	94 %!assert (wblpdf (x, 1, ones (1,5)), y)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	95 %!assert (wblpdf (x, ones (1,5), 1), y)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	96 %!assert (wblpdf (x, [0 NaN Inf 1 1], 1), [NaN NaN NaN y(4:5)])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	97 %!assert (wblpdf (x, 1, [0 NaN Inf 1 1]), [NaN NaN NaN y(4:5)])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	98 %!assert (wblpdf ([x, NaN], 1, 1), [y, NaN])
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	99
19867 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19731 diff changeset	100 ## Test class of input preserved
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	101 %!assert (wblpdf (single ([x, NaN]), 1, 1), single ([y, NaN]))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	102 %!assert (wblpdf ([x, NaN], single (1), 1), single ([y, NaN]))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	103 %!assert (wblpdf ([x, NaN], 1, single (1)), single ([y, NaN]))
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	104
19867 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19731 diff changeset	105 ## Test input validation
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	106 %!error wblpdf ()
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	107 %!error wblpdf (1,2,3,4)
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	108 %!error wblpdf (ones (3), ones (2), ones (2))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	109 %!error wblpdf (ones (2), ones (3), ones (2))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	110 %!error wblpdf (ones (2), ones (2), ones (3))
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	111 %!error wblpdf (i, 2, 2)
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	112 %!error wblpdf (2, i, 2)
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	113 %!error wblpdf (2, 2, i)
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 12696 diff changeset	114

Mercurial > octave-nkf

annotate scripts/statistics/distributions/wblpdf.m @ 20595:c1a6c31ac29a