Mercurial > octave
view scripts/elfun/coth.m @ 30560:9ed1cf9e446e
doc: Document output for all functions in elfun/ directory (bug #61681)
* acosd.m, acot.m, acotd.m, acoth.m, acsc.m, acscd.m, acsch.m, asec.m,
asecd.m, asech.m, asind.m, atan2d.m, atand.m, cosd.m, cot.m, cotd.m, coth.m,
csc.m, cscd.m, csch.m, sec.m, secd.m, sech.m, sind.m, tand.m:
Document output for all functions in elfun/ directory (bug #61681)
author | Rik <rik@octave.org> |
---|---|
date | Mon, 27 Dec 2021 20:04:52 -0800 |
parents | 7854d5752dd2 |
children | 83f9f8bda883 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 1994-2021 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## This file is part of Octave. ## ## Octave is free software: you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation, either version 3 of the License, or ## (at your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {@var{y} =} coth (@var{x}) ## Compute the hyperbolic cotangent of each element of @var{x}. ## @seealso{acoth} ## @end deftypefn function y = coth (x) if (nargin < 1) print_usage (); endif y = 1 ./ tanh (x); endfunction %!test %! x = [pi/2*i, 3*pi/2*i]; %! v = [0, 0]; %! assert (coth (x), v, sqrt (eps)); %!error <Invalid call> coth ()