modified: diffout.py
[GalaxyCodeBases.git] / c_cpp / etc / calc / help / norm
blob8cd5154e75f8abf895d55c02c15655f3e3eabeba
1 NAME
2     norm - calculate a norm of a value
4 SYNOPSIS
5     norm(x)
7 TYPES
8     If x is an object of type xx, the function xx_norm has to have been
9     defined; what this does will be determined by the definition.
11     For non-object x:
13     x           number (real or complex)
15     return      real
17 DESCRIPTION
18     For real x, norm(x) returns:
20          x^2.
22     For complex x, norm(x) returns:
24         re(x)^2 + im(x)^2.
26 EXAMPLE
27     ; print norm(3.4), norm(-3.4), norm(3 + 4i), norm(4 - 5i)
28     11.56 11.56 25 41
30 LIMITS
31     none
33 LINK LIBRARY
34     void normvalue(VALUE *x, VALUE *result)
36 SEE ALSO
37     cmp, epsilon, hypot, abs, near, obj
39 ## Copyright (C) 1999  Landon Curt Noll
41 ## Calc is open software; you can redistribute it and/or modify it under
42 ## the terms of the version 2.1 of the GNU Lesser General Public License
43 ## as published by the Free Software Foundation.
45 ## Calc is distributed in the hope that it will be useful, but WITHOUT
46 ## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
47 ## or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General
48 ## Public License for more details.
50 ## A copy of version 2.1 of the GNU Lesser General Public License is
51 ## distributed with calc under the filename COPYING-LGPL.  You should have
52 ## received a copy with calc; if not, write to Free Software Foundation, Inc.
53 ## 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
55 ## @(#) $Revision: 30.1 $
56 ## @(#) $Id: norm,v 30.1 2007/03/16 11:10:42 chongo Exp $
57 ## @(#) $Source: /usr/local/src/cmd/calc/help/RCS/norm,v $
59 ## Under source code control:   1995/10/25 04:03:46
60 ## File existed as early as:    1995
62 ## chongo <was here> /\oo/\     http://www.isthe.com/chongo/
63 ## Share and enjoy!  :-)        http://www.isthe.com/chongo/tech/comp/calc/