Mercurial > octave
annotate scripts/elfun/asech.m @ 29359:7854d5752dd2
maint: merge stable to default.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Wed, 10 Feb 2021 10:10:40 -0500 |
parents | 90fea9cc9caa 0a5b15007766 |
children | 76269aa97398 |
rev | line source |
---|---|
27923
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
1 ######################################################################## |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
2 ## |
29358
0a5b15007766
update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents:
27923
diff
changeset
|
3 ## Copyright (C) 1994-2021 The Octave Project Developers |
27918
b442ec6dda5c
use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents:
27898
diff
changeset
|
4 ## |
27923
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
5 ## See the file COPYRIGHT.md in the top-level directory of this |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
6 ## distribution or <https://octave.org/copyright/>. |
2313 | 7 ## |
8 ## This file is part of Octave. | |
9 ## | |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
24532
diff
changeset
|
10 ## Octave is free software: you can redistribute it and/or modify it |
2313 | 11 ## under the terms of the GNU General Public License as published by |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
24532
diff
changeset
|
12 ## the Free Software Foundation, either version 3 of the License, or |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
13 ## (at your option) any later version. |
2313 | 14 ## |
15 ## Octave is distributed in the hope that it will be useful, but | |
16 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
18 ## GNU General Public License for more details. |
2313 | 19 ## |
20 ## You should have received a copy of the GNU General Public License | |
7016 | 21 ## along with Octave; see the file COPYING. If not, see |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
24532
diff
changeset
|
22 ## <https://www.gnu.org/licenses/>. |
27923
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
23 ## |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
24 ######################################################################## |
2303 | 25 |
3321 | 26 ## -*- texinfo -*- |
20852
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
27 ## @deftypefn {} {} asech (@var{x}) |
3428 | 28 ## Compute the inverse hyperbolic secant of each element of @var{x}. |
9155
ad20b967e1c9
Update section 17.3 (Trigonometry) of arith.txi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
29 ## @seealso{sech} |
3321 | 30 ## @end deftypefn |
2311 | 31 |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
9245
diff
changeset
|
32 function y = asech (x) |
2325 | 33 |
28891
de5f2f9a64ff
maint: Use same coding style when checking for a minimum of 1 input.
Rik <rik@octave.org>
parents:
28886
diff
changeset
|
34 if (nargin < 1) |
6046 | 35 print_usage (); |
713 | 36 endif |
37 | |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
9245
diff
changeset
|
38 y = acosh (1 ./ x); |
2325 | 39 |
713 | 40 endfunction |
7385 | 41 |
14220
5a13a75c2457
Use Octave spacing conventions for scripts in elfun/ directory.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
42 |
24532
a6753fc10731
Mark certain hyperbolic BIST tests as Mac-only failures (bug #52627).
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
43 %!testif ; ! ismac () |
a6753fc10731
Mark certain hyperbolic BIST tests as Mac-only failures (bug #52627).
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
44 %! v = [0, pi*i]; |
a6753fc10731
Mark certain hyperbolic BIST tests as Mac-only failures (bug #52627).
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
45 %! x = [1, -1]; |
a6753fc10731
Mark certain hyperbolic BIST tests as Mac-only failures (bug #52627).
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
46 %! assert (asech (x), v, sqrt (eps)); |
a6753fc10731
Mark certain hyperbolic BIST tests as Mac-only failures (bug #52627).
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
47 |
26946
04e5cb5e2cb3
update bug status in tests
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
48 %!xtest <*52627> |
24532
a6753fc10731
Mark certain hyperbolic BIST tests as Mac-only failures (bug #52627).
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
49 %! ## Same test code as above, but intended only for test statistics on Mac. |
a6753fc10731
Mark certain hyperbolic BIST tests as Mac-only failures (bug #52627).
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
50 %! ## Mac trig/hyperbolic functions have huge tolerances. |
a6753fc10731
Mark certain hyperbolic BIST tests as Mac-only failures (bug #52627).
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
51 %! if (! ismac ()), return; endif |
7385 | 52 %! v = [0, pi*i]; |
53 %! x = [1, -1]; | |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14220
diff
changeset
|
54 %! assert (asech (x), v, sqrt (eps)); |
7385 | 55 |
28896
90fea9cc9caa
test: Add expected error message <Invalid call> to BIST tests for nargin.
Rik <rik@octave.org>
parents:
28891
diff
changeset
|
56 %!error <Invalid call> asech () |