Mercurial > hg > octave-lyh
annotate scripts/statistics/distributions/cauchy_cdf.m @ 11523:fd0a3ac60b0e
update copyright notices
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Fri, 14 Jan 2011 05:47:45 -0500 |
| parents | 1740012184f9 |
| children | c792872f8942 |
| rev | line source |
|---|---|
| 11523 | 1 ## Copyright (C) 1995-2011 Kurt Hornik |
| 3426 | 2 ## |
| 3922 | 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. | |
| 3426 | 9 ## |
| 3922 | 10 ## Octave is distributed in the hope that it will be useful, but |
| 3191 | 11 ## WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 3426 | 13 ## General Public License for more details. |
| 14 ## | |
| 3191 | 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/>. | |
| 3191 | 18 |
| 3456 | 19 ## -*- texinfo -*- |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10525
diff
changeset
|
20 ## @deftypefn {Function File} {} cauchy_cdf (@var{x}, @var{location}, @var{scale}) |
| 3456 | 21 ## For each element of @var{x}, compute the cumulative distribution |
| 22 ## function (CDF) at @var{x} of the Cauchy distribution with location | |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10525
diff
changeset
|
23 ## parameter @var{location} and scale parameter @var{scale}. Default |
|
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10525
diff
changeset
|
24 ## values are @var{location} = 0, @var{scale} = 1. |
| 3456 | 25 ## @end deftypefn |
| 3191 | 26 |
| 5428 | 27 ## Author: KH <Kurt.Hornik@wu-wien.ac.at> |
| 3456 | 28 ## Description: CDF of the Cauchy distribution |
| 3191 | 29 |
| 30 function cdf = cauchy_cdf (x, location, scale) | |
| 3426 | 31 |
| 3456 | 32 if (! (nargin == 1 || nargin == 3)) |
| 6046 | 33 print_usage (); |
| 3191 | 34 endif |
| 3426 | 35 |
| 3191 | 36 if (nargin == 1) |
| 37 location = 0; | |
| 38 scale = 1; | |
| 39 endif | |
| 3426 | 40 |
| 4854 | 41 if (!isscalar (location) || !isscalar (scale)) |
| 42 [retval, x, location, scale] = common_size (x, location, scale); | |
| 43 if (retval > 0) | |
|
11472
1740012184f9
Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents:
11469
diff
changeset
|
44 error ("cauchy_cdf: X, LOCATION and SCALE must be of common size or scalar"); |
| 4854 | 45 endif |
| 3191 | 46 endif |
| 47 | |
| 4854 | 48 sz = size (x); |
|
10525
3306cfcb856e
Replace constructs like "NaN * one()" with "NaN()" and "Inf * ones ()" with "Inf()"
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
49 cdf = NaN (sz); |
| 3191 | 50 |
| 3426 | 51 k = find ((x > -Inf) & (x < Inf) & (location > -Inf) & |
| 52 (location < Inf) & (scale > 0) & (scale < Inf)); | |
| 3456 | 53 if (any (k)) |
| 4854 | 54 if (isscalar (location) && isscalar (scale)) |
| 55 cdf(k) = 0.5 + atan ((x(k) - location) ./ scale) / pi; | |
| 56 else | |
| 57 cdf(k) = 0.5 + atan ((x(k) - location(k)) ./ scale(k)) / pi; | |
| 58 endif | |
| 3191 | 59 endif |
| 3426 | 60 |
| 3191 | 61 endfunction |