Mercurial > octave-nkf
annotate scripts/statistics/distributions/cauchy_inv.m @ 11587:c792872f8942
all script files: untabify and strip trailing whitespace
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Thu, 20 Jan 2011 17:35:29 -0500 |
parents | fd0a3ac60b0e |
children | 19b9f17d22af |
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_inv (@var{x}, @var{location}, @var{scale}) |
3456 | 21 ## For each element of @var{x}, compute the quantile (the inverse of the |
22 ## 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
|
23 ## @var{location} and scale parameter @var{scale}. Default values are |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
24 ## @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: Quantile function of the Cauchy distribution |
3191 | 29 |
30 function inv = cauchy_inv (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 |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
41 if (!isscalar (location) || !isscalar (scale)) |
4854 | 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_inv: X, LOCATION and SCALE must be of common size or scalar"); |
4854 | 45 endif |
3191 | 46 endif |
3426 | 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 inv = NaN (sz); |
3426 | 50 |
3191 | 51 ok = ((location > -Inf) & (location < Inf) & |
52 (scale > 0) & (scale < Inf)); | |
3426 | 53 |
3191 | 54 k = find ((x == 0) & ok); |
3456 | 55 if (any (k)) |
4854 | 56 inv(k) = -Inf; |
3191 | 57 endif |
3426 | 58 |
3191 | 59 k = find ((x > 0) & (x < 1) & ok); |
3456 | 60 if (any (k)) |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
61 if (isscalar (location) && isscalar (scale)) |
4854 | 62 inv(k) = location - scale .* cot (pi * x(k)); |
63 else | |
64 inv(k) = location(k) - scale(k) .* cot (pi * x(k)); | |
65 endif | |
3191 | 66 endif |
3426 | 67 |
3191 | 68 k = find ((x == 1) & ok); |
3456 | 69 if (any (k)) |
4854 | 70 inv(k) = Inf; |
3191 | 71 endif |
3426 | 72 |
3191 | 73 endfunction |