octave_packages/m/statistics/base/cloglog.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} {} cloglog (@var{x})
  21 ## Return the complementary log-log function of @var{x}, defined as
  22 ## @tex
  23 ## $$
  24 ## {\rm cloglog}(x) = - \log (- \log (x))
  25 ## $$
  26 ## @end tex
  27 ## @ifnottex
  28 ##
  29 ## @example
  30 ## cloglog (x) = - log (- log (@var{x}))
  31 ## @end example
  32 ##
  33 ## @end ifnottex
  34 ## @end deftypefn
  35
  36 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
  37 ## Description: Complementary log-log function
  38
  39 function y = cloglog (x)
  40
  41   if (nargin != 1)
  42     print_usage ();
  43   endif
  44
  45   y = - log (- log (x));
  46
  47 endfunction
  48
  49 %!assert(cloglog(0), -Inf)
  50 %!assert(cloglog(1), Inf)
  51 %!assert(cloglog(1/e), 0)
  52
  53 %% Test input validation
  54 %!error cloglog ()
  55 %!error cloglog (1, 2)