summaryrefslogtreecommitdiff
path: root/src/main/java/org/apache/commons/math/stat/descriptive/package.html
blob: 981fda408a7ccb57cc8e0c7df4d7b057180d3701 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
<html>
<!--
   Licensed to the Apache Software Foundation (ASF) under one or more
  contributor license agreements.  See the NOTICE file distributed with
  this work for additional information regarding copyright ownership.
  The ASF licenses this file to You under the Apache License, Version 2.0
  (the "License"); you may not use this file except in compliance with
  the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
  -->
    <!-- $Revision: 811685 $ $Date: 2009-09-05 19:36:48 +0200 (sam. 05 sept. 2009) $ -->
    <body>
        Generic univariate summary statistic objects.

        <h3>UnivariateStatistic API Usage Examples:</h3>
        <h4>UnivariateStatistic:</h4>
        <code>/* evaluation approach */<br/> double[] values = new double[] { 1, 2,
            3, 4, 5 };<br/> <span style="font-weight: bold;">UnivariateStatistic stat
            = new Mean();</span><br/> System.out.println("mean = " + <span
            style="font-weight: bold;">stat.evaluate(values)</span>);<br/> </code>
        <h4>StorelessUnivariateStatistic:</h4>
        <code>/* incremental approach */<br/> double[] values = new double[] { 1, 2,
            3, 4, 5 };<br/> <span style="font-weight: bold;">
            StorelessUnivariateStatistic stat = new Mean();</span><br/>
            System.out.println("mean before adding a value is NaN = " + <span
            style="font-weight: bold;">stat.getResult()</span>);<br/> for (int i = 0;
            i &lt; values.length; i++) {<br/> &nbsp;&nbsp;&nbsp; <span
            style="font-weight: bold;">stat.increment(values[i]);</span><br/> &nbsp;&nbsp;&nbsp;
            System.out.println("current mean = " + <span style="font-weight: bold;">
            stat2.getResult()</span>);<br/> }<br/> <span style="font-weight: bold;">
            stat.clear();</span><br/> System.out.println("mean after clear is NaN = "
            + <span style="font-weight: bold;">stat.getResult()</span>);</code>
    </body>
</html>