~ubuntu-branches/ubuntu/hoary/scilab/hoary

« back to all changes in this revision

Viewing changes to man/eng/statistics/harmean.xml

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2005-01-09 22:58:21 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050109225821-473xr8vhgugxxx5j
Tags: 3.0-12
changed configure.in to build scilab's own malloc.o, closes: #255869

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
 
2
<!DOCTYPE MAN SYSTEM "../../manrev.dtd">
 
3
<MAN>
 
4
  <LANGUAGE>eng</LANGUAGE>
 
5
  <TITLE>harmean</TITLE>
 
6
  <TYPE>  </TYPE>
 
7
  <DATE>March 2001</DATE>
 
8
  <SHORT_DESCRIPTION name="harmean"> harmonic mean</SHORT_DESCRIPTION>
 
9
  <CALLING_SEQUENCE>
 
10
    <CALLING_SEQUENCE_ITEM>hm=harmean(x)  </CALLING_SEQUENCE_ITEM>
 
11
    <CALLING_SEQUENCE_ITEM>hm=harmean(x,'r')(or,  equivalently,   hm=harmean(x,1))  </CALLING_SEQUENCE_ITEM>
 
12
    <CALLING_SEQUENCE_ITEM>hm=harmean(x,'c')(or,   equivalently,  hm=harmean(x,2))  </CALLING_SEQUENCE_ITEM>
 
13
  </CALLING_SEQUENCE>
 
14
  <PARAM>
 
15
    <PARAM_INDENT>
 
16
      <PARAM_ITEM>
 
17
        <PARAM_NAME>x</PARAM_NAME>
 
18
        <PARAM_DESCRIPTION>
 
19
          <SP>: real or complex vector or matrix</SP>
 
20
        </PARAM_DESCRIPTION>
 
21
      </PARAM_ITEM>
 
22
    </PARAM_INDENT>
 
23
  </PARAM>
 
24
  <DESCRIPTION>
 
25
    <P>
 
26
    This function  computes the harmonic  mean of a  vector or
 
27
    matrix <VERB> x</VERB>.  For a vector or matrix  <VERB> x</VERB>, <VERB>
 
28
    hm=harmean(x)  </VERB>  returns  in  scalar  <VERB>  hm</VERB>  the
 
29
    harmonic mean of all the entries of <VERB> x</VERB>.</P>
 
30
    <P><VERB>   hm=harmean(x,'r')   </VERB>   (or,   equivalently,   <VERB>
 
31
    hm=harmean(x,1)  </VERB> ) returns  in each  entry of  the row
 
32
    vector <VERB> hm</VERB> the  harmonic mean of each column of <VERB>
 
33
    x</VERB>.</P>
 
34
    <P><VERB>   hm=harmean(x,'c')   </VERB>   (or,   equivalently,   <VERB>
 
35
    hm=harmean(x,2) </VERB> ) returns  in each entry of the column
 
36
    vector <VERB> hm</VERB> the harmonic mean of each  row of <VERB> x
 
37
    </VERB>.</P>
 
38
  </DESCRIPTION>
 
39
  <AUTHOR> Carlos Klimann</AUTHOR>
 
40
  <BIBLIO>
 
41
    <P>
 
42
    Wonacott, T.H. &amp; Wonacott, R.J.; Introductory Statistics, fifth edition, J.Wiley &amp; Sons, 1990.</P>
 
43
  </BIBLIO>
 
44
</MAN>