* Bug 16097 fixed: tanh() & coth() improved
[scilab.git] / scilab / modules / elementary_functions / macros / coth.sci
1 // Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
2 // Copyright (C) INRIA
3 // Copyright (C) 2012 - 2016 - Scilab Enterprises
4 // Copyright (C) 2019 - Samuel GOUGEON
5 //
6 // This file is hereby licensed under the terms of the GNU GPL v2.0,
7 // pursuant to article 5.3.4 of the CeCILL v.2.1.
8 // This file was originally licensed under the terms of the CeCILL v2.1,
9 // and continues to be available under such terms.
10 // For more information, see the COPYING file which you should have received
11 // along with this program.
12
13 function t = coth(x)
14     //Syntax : t=coth(x)
15     //
16     // hyperbolic co-tangent of x
17
18     if argn(2) <> 1 then
19         error(msprintf(gettext("%s: Wrong number of input argument(s): %d expected.\n"),"coth",1));
20     end
21
22     if and(type(x) <> [1 5]) then
23         error(msprintf(gettext("%s: Wrong type for input argument #%d: Real or complex matrix expected.\n"),"coth",1));
24     end
25     // ( coth(0) => +/- Inf ) => (sparse => full)
26     t = 1 ./ tanh(full(x))
27 endfunction