octave_packages/m/elfun/acoth.m

   1 ## Copyright (C) 1994-2012 John W. Eaton
   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 {Mapping Function} {} acoth (@var{x})
  21 ## Compute the inverse hyperbolic cotangent of each element of @var{x}.
  22 ## @seealso{coth}
  23 ## @end deftypefn
  24
  25 ## Author: jwe
  26
  27 function y = acoth (x)
  28
  29   if (nargin != 1)
  30     print_usage ();
  31   endif
  32
  33   y = atanh (1 ./ x);
  34
  35 endfunction
  36
  37 %!test
  38 %! rt2 = sqrt (2);
  39 %! rt3 = sqrt (3);
  40 %! v = -i*[pi/6, pi/4, pi/3, -pi/3, -pi/4, -pi/6];
  41 %! x = i*[rt3, 1, rt3/3, -rt3/3, -1, -rt3];
  42 %! assert(all (abs (acoth (x) - v) < sqrt (eps)));
  43
  44 %!error acoth ();
  45
  46 %!error acoth (1, 2);
  47