modified: diffout.py
[GalaxyCodeBases.git] / c_cpp / etc / calc / help / hmean
blob39966bf4e09bbfdb8b9be8ec2bbee8eb9a766a6b
1 NAME
2     hmean - harmonic mean of a number of values
4 SYNOPSIS
5     hmean(x_1, x_2, ...)
7 TYPES
8     x_1, ...    arithmetic or list
10     return      determined by types of arguments, or null
12 DESCRIPTION
13     The null value is returned if there are no arguments.
15     If there are n non-list arguments x_1, x_2, ... and the
16     required operations are defined, hmean(x_1, x_2, ...) returns the
17     value of:
19         n/(inverse(x_1) + inverse(x_2) + ... + inverse(x_n)).
21     If an argument x_i is a list as defined by list(y_1, ..., y_m)
22     this is treated as if in (x_1, x_2, ...), x_i is replaced by
23     y_1, ..., y_m.
26 EXAMPLE
27     ; c = config("mode", "frac")
28     ; print hmean(1), hmean(1,2), hmean(1,2,3), hmean(1,2,3,4), hmean(1,2,0,3)
29     1 4/3 18/11 48/25 0
31 LIMITS
32     The number of arguments is not to exceed 1024.
34 LINK LIBRARY
35     none
37 SEE ALSO
38     avg
40 ## Copyright (C) 1999-2006  Landon Curt Noll
42 ## Calc is open software; you can redistribute it and/or modify it under
43 ## the terms of the version 2.1 of the GNU Lesser General Public License
44 ## as published by the Free Software Foundation.
46 ## Calc is distributed in the hope that it will be useful, but WITHOUT
47 ## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
48 ## or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General
49 ## Public License for more details.
51 ## A copy of version 2.1 of the GNU Lesser General Public License is
52 ## distributed with calc under the filename COPYING-LGPL.  You should have
53 ## received a copy with calc; if not, write to Free Software Foundation, Inc.
54 ## 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
56 ## @(#) $Revision: 30.1 $
57 ## @(#) $Id: hmean,v 30.1 2007/03/16 11:10:42 chongo Exp $
58 ## @(#) $Source: /usr/local/src/cmd/calc/help/RCS/hmean,v $
60 ## Under source code control:   1995/12/18 03:30:59
61 ## File existed as early as:    1995
63 ## chongo <was here> /\oo/\     http://www.isthe.com/chongo/
64 ## Share and enjoy!  :-)        http://www.isthe.com/chongo/tech/comp/calc/