modified: myjupyterlab.sh
[GalaxyCodeBases.git] / c_cpp / etc / calc / help / avg
blobf97f7baa069e4f3965e3ba827f7a62d5f17de7b0
1 NAME
2     avg - average (arithmetic) mean of values
4 SYNOPSIS
5     avg(x_1, x_2, ...)
7 TYPES
8     x_1, ...    arithmetic or list
10     return      as determined by types of items averaged
12 DESCRIPTION
13     If there are n non-list arguments x_1, x_2, ..., x_n,
14     for which the required additions and division by n are defined,
15     avg(x_1, x_2, ..., x_n) returns the value of:
17         (x_1 + x_2 + ... + x_n)/n.
19     If the x_i are real, the result will be a real number; if the
20     x_i are real or complex numbers, the result will be a real or complex
21     number.  If the x_i are summable matrices the result will be a matrix
22     of the same size (e.g. if the x_i are all 3 x 4 matrices with real
23     entries, the result will be a 3 x 4 matrix with real entries).
25     If an argument x_i is list-valued, e.g. list(y_1, y_2, ...), this
26     is treated as contributing y_1, y_2, ... to the list of items to
27     be averaged.
29 EXAMPLE
30     ; print avg(1,2,3,4,5), avg(list(1,2,3,4,5)), avg(1,2,list(3,4,5))
31     3 3 3
33     ; mat x[2,2] = {1,2,3,4}
34     ; mat y[2,2] = {1,2,4,8}
35     ; avg(x,y)
37     mat [2,2] (4 elements, 4 nonzero):
38       [0,0] = 1
39       [0,1] = 2
40       [1,0] = 3.5
41       [1,1] = 6
43 LIMITS
44    The number of arguments is not to exceed 1024.
46 LINK LIBRARY
47     none
49 SEE ALSO
50     hmean
52 ## Copyright (C) 1999-2006  Landon Curt Noll
54 ## Calc is open software; you can redistribute it and/or modify it under
55 ## the terms of the version 2.1 of the GNU Lesser General Public License
56 ## as published by the Free Software Foundation.
58 ## Calc is distributed in the hope that it will be useful, but WITHOUT
59 ## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
60 ## or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General
61 ## Public License for more details.
63 ## A copy of version 2.1 of the GNU Lesser General Public License is
64 ## distributed with calc under the filename COPYING-LGPL.  You should have
65 ## received a copy with calc; if not, write to Free Software Foundation, Inc.
66 ## 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
68 ## @(#) $Revision: 30.1 $
69 ## @(#) $Id: avg,v 30.1 2007/03/16 11:10:42 chongo Exp $
70 ## @(#) $Source: /usr/local/src/cmd/calc/help/RCS/avg,v $
72 ## Under source code control:   1994/09/25 20:22:31
73 ## File existed as early as:    1994
75 ## chongo <was here> /\oo/\     http://www.isthe.com/chongo/
76 ## Share and enjoy!  :-)        http://www.isthe.com/chongo/tech/comp/calc/