modified: SpatialOmicsCoord.py
[GalaxyCodeBases.git] / c_cpp / etc / calc / help / abs
blobee802fcb349114a3afc22beccedb305498f3ff84
1 NAME
2     abs - absolute value
4 SYNOPSIS
5     abs(x [,eps])
7 TYPES
8     If x is an object of type xx, the function xx_abs has to have
9         been defined; this will determine the types for x, eps and
10         the returned value.
12     For non-object x and eps:
14     x           number (real or complex)
15     eps         ignored if x is real, nonzero real for complex x,
16                 defaults to epsilon().
18     return      non-negative real
20 DESCRIPTION
21     If x is real, returns the absolute value of x, i.e. x if x >= 0,
22     -x if x < 0.
24     For complex x with zero real part, returns the absolute value of im(x).
26     For other complex x, returns the multiple of eps nearest to the absolute
27     value of x, or in the case of two equally near nearest values, the
28     the nearest even multiple of eps.  In particular, with eps = 10^-n,
29     the result will be the absolute value correct to n decimal places.
31 EXAMPLE
32     ; print abs(3.4), abs(-3.4)
33     3.4 3.4
35     ; print abs(3+4i, 1e-5), abs(4+5i, 1e-5), abs(4+5i, 1e-10)
36     5 6.40312 6.4031242374
38 LIMITS
39     none
41 LINK LIBRARY
42     NUMBER *qqabs(NUMBER *x)
44 SEE ALSO
45     cmp, epsilon, hypot, norm, near, obj
47 ## Copyright (C) 1999  Landon Curt Noll
49 ## Calc is open software; you can redistribute it and/or modify it under
50 ## the terms of the version 2.1 of the GNU Lesser General Public License
51 ## as published by the Free Software Foundation.
53 ## Calc is distributed in the hope that it will be useful, but WITHOUT
54 ## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
55 ## or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General
56 ## Public License for more details.
58 ## A copy of version 2.1 of the GNU Lesser General Public License is
59 ## distributed with calc under the filename COPYING-LGPL.  You should have
60 ## received a copy with calc; if not, write to Free Software Foundation, Inc.
61 ## 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
63 ## @(#) $Revision: 30.1 $
64 ## @(#) $Id: abs,v 30.1 2007/03/16 11:10:42 chongo Exp $
65 ## @(#) $Source: /usr/local/src/cmd/calc/help/RCS/abs,v $
67 ## Under source code control:   1994/03/19 01:40:22
68 ## File existed as early as:    1994
70 ## chongo <was here> /\oo/\     http://www.isthe.com/chongo/
71 ## Share and enjoy!  :-)        http://www.isthe.com/chongo/tech/comp/calc/