modified: myjupyterlab.sh
[GalaxyCodeBases.git] / c_cpp / etc / calc / help / sum
blob549c10e867fed17a0a20382fd83035bf464bf3c0
1 NAME
2     sum - sum, or sum of defined sums
4 SYNOPSIS
5     sum(x_1, x_2, ...)
7 TYPES
8     x_1, x_2, ...       any
10     return              any
12 DESCRIPTION
13     If an argument x_i is a list with elements e_1, e_2, ..., e_n, it
14     is treated as if x_i were replaced by e_1, e_2, ..., e_n; this may
15     continue recurively if any of the e_j is a list.
17     If an argument x_i is an object of type xx, then x_i is replaced by
18     xx_sum(x_i) if the function xx_sum() has been defined.  If the
19     type xx has been defined by:
21                 obj xx = {x, y, z},
23     an appropriate definition of xx_sum(a) is sometimes a.x + a.y + a.z.
24     sum(a) then returns the sum of the elements of a.
26     If x_i has the null value, it is ignored.  Thus, sum(a, , b, , c)
27     will return the same as sum(a, b, c).
29     Assuming the above replacements, and that the x_1, x_2, ..., are
30     of types for which addition is defined, sum(x_1, x_2, ...) returns
31     the sum of the arguments.
33 EXAMPLE
34     ; print sum(2), sum(5, 3, 7, 2, 9), sum(3.2, -0.5, 8.7, -1.2, 2.5)
35     2 26 12.7
37     ; print sum(list(3,5), 7, list(6, list(7,8), 2))
38     38
41     ; obj point {x, y}
42     ; define point_add(a,b) = obj point = {a.x + b.x, a.y + b.y}
43     ; obj point A = {1, 5}
44     ; obj point B = {1, 4}
45     ; obj point C = {3, 3}
46     ; print sum(A, B, C)
47     obj point {5, 12}
49     ; define point_sum(a) = a.x
50     ; print sum(A, B, C)
51     5
53 LIMITS
54     The number of arguments is not to exceed 1024.
56 LINK LIBRARY
58 SEE ALSO
59     max, min, obj, ssq
61 ## Copyright (C) 1999-2006  Landon Curt Noll
63 ## Calc is open software; you can redistribute it and/or modify it under
64 ## the terms of the version 2.1 of the GNU Lesser General Public License
65 ## as published by the Free Software Foundation.
67 ## Calc is distributed in the hope that it will be useful, but WITHOUT
68 ## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
69 ## or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General
70 ## Public License for more details.
72 ## A copy of version 2.1 of the GNU Lesser General Public License is
73 ## distributed with calc under the filename COPYING-LGPL.  You should have
74 ## received a copy with calc; if not, write to Free Software Foundation, Inc.
75 ## 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
77 ## @(#) $Revision: 30.1 $
78 ## @(#) $Id: sum,v 30.1 2007/03/16 11:10:42 chongo Exp $
79 ## @(#) $Source: /usr/local/src/cmd/calc/help/RCS/sum,v $
81 ## Under source code control:   1997/03/10 03:59:59
82 ## File existed as early as:    1997
84 ## chongo <was here> /\oo/\     http://www.isthe.com/chongo/
85 ## Share and enjoy!  :-)        http://www.isthe.com/chongo/tech/comp/calc/