Mercurial > octave-antonio
annotate scripts/statistics/distributions/cauchy_inv.m @ 11472:1740012184f9
Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Sun, 09 Jan 2011 21:33:04 -0800 |
| parents | c776f063fefe |
| children | fd0a3ac60b0e |
| rev | line source |
|---|---|
| 7017 | 1 ## Copyright (C) 1995, 1996, 1997, 1998, 2000, 2002, 2004, 2005, 2006, |
| 2 ## 2007 Kurt Hornik | |
| 3426 | 3 ## |
| 3922 | 4 ## This file is part of Octave. |
| 5 ## | |
| 6 ## Octave is free software; you can redistribute it and/or modify it | |
| 7 ## under the terms of the GNU General Public License as published by | |
| 7016 | 8 ## the Free Software Foundation; either version 3 of the License, or (at |
| 9 ## your option) any later version. | |
| 3426 | 10 ## |
| 3922 | 11 ## Octave is distributed in the hope that it will be useful, but |
| 3191 | 12 ## WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 3426 | 14 ## General Public License for more details. |
| 15 ## | |
| 3191 | 16 ## You should have received a copy of the GNU General Public License |
| 7016 | 17 ## along with Octave; see the file COPYING. If not, see |
| 18 ## <http://www.gnu.org/licenses/>. | |
| 3191 | 19 |
| 3456 | 20 ## -*- 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
|
21 ## @deftypefn {Function File} {} cauchy_inv (@var{x}, @var{location}, @var{scale}) |
| 3456 | 22 ## For each element of @var{x}, compute the quantile (the inverse of the |
| 23 ## CDF) at @var{x} of the Cauchy distribution with location parameter | |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10525
diff
changeset
|
24 ## @var{location} and scale parameter @var{scale}. Default values are |
|
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10525
diff
changeset
|
25 ## @var{location} = 0, @var{scale} = 1. |
| 3456 | 26 ## @end deftypefn |
| 3191 | 27 |
| 5428 | 28 ## Author: KH <Kurt.Hornik@wu-wien.ac.at> |
| 3456 | 29 ## Description: Quantile function of the Cauchy distribution |
| 3191 | 30 |
| 31 function inv = cauchy_inv (x, location, scale) | |
| 3426 | 32 |
| 3456 | 33 if (! (nargin == 1 || nargin == 3)) |
| 6046 | 34 print_usage (); |
| 3191 | 35 endif |
| 3426 | 36 |
| 3191 | 37 if (nargin == 1) |
| 38 location = 0; | |
| 39 scale = 1; | |
| 40 endif | |
| 3426 | 41 |
| 4854 | 42 if (!isscalar (location) || !isscalar (scale)) |
| 43 [retval, x, location, scale] = common_size (x, location, scale); | |
| 44 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
|
45 error ("cauchy_inv: X, LOCATION and SCALE must be of common size or scalar"); |
| 4854 | 46 endif |
| 3191 | 47 endif |
| 3426 | 48 |
| 4854 | 49 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
|
50 inv = NaN (sz); |
| 3426 | 51 |
| 3191 | 52 ok = ((location > -Inf) & (location < Inf) & |
| 53 (scale > 0) & (scale < Inf)); | |
| 3426 | 54 |
| 3191 | 55 k = find ((x == 0) & ok); |
| 3456 | 56 if (any (k)) |
| 4854 | 57 inv(k) = -Inf; |
| 3191 | 58 endif |
| 3426 | 59 |
| 3191 | 60 k = find ((x > 0) & (x < 1) & ok); |
| 3456 | 61 if (any (k)) |
| 4854 | 62 if (isscalar (location) && isscalar (scale)) |
| 63 inv(k) = location - scale .* cot (pi * x(k)); | |
| 64 else | |
| 65 inv(k) = location(k) - scale(k) .* cot (pi * x(k)); | |
| 66 endif | |
| 3191 | 67 endif |
| 3426 | 68 |
| 3191 | 69 k = find ((x == 1) & ok); |
| 3456 | 70 if (any (k)) |
| 4854 | 71 inv(k) = Inf; |
| 3191 | 72 endif |
| 3426 | 73 |
| 3191 | 74 endfunction |