octave_packages/m/statistics/base/probit.m

   1 ## Copyright (C) 1995-2012 Kurt Hornik
   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
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   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
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn {Function File} {} probit (@var{p})
  21 ## For each component of @var{p}, return the probit (the quantile of the
  22 ## standard normal distribution) of @var{p}.
  23 ## @end deftypefn
  24
  25 ## Written by KH <Kurt.Hornik@wu-wien.ac.at> on 1995/02/04
  26 ## Description: Probit transformation
  27
  28 function y = probit (p)
  29
  30
  31   if (nargin != 1)
  32     print_usage ();
  33   endif
  34
  35   y = stdnormal_inv (p);
  36
  37 endfunction
  38
  39 %!assert(probit([-1, 0, 0.5, 1, 2]), [NaN, -Inf, 0, Inf, NaN]);
  40
  41 %% Test input validation
  42 %!error probit ()
  43 %!error probit (1, 2)
  44