1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.statistics.descriptive;
18
19 /**
20 * A statistic that can be computed on univariate data, for example a stream of
21 * {@code double} values.
22 *
23 * <p>{@code Statistic} is an enum representing the statistics that can be computed
24 * by implementations in the {@code org.apache.commons.statistics.descriptive} package.
25 *
26 * <p><strong>Note</strong>
27 *
28 * <p>Implementations may provide additional parameters to control the computation of
29 * the statistic, for example to compute the population (biased) or sample (unbiased) variance.
30 *
31 * @since 1.1
32 */
33 public enum Statistic {
34 /** Minimum. */
35 MIN,
36 /** Maximum. */
37 MAX,
38 /** Mean, or average. */
39 MEAN,
40 /** Standard deviation. */
41 STANDARD_DEVIATION,
42 /** Variance. */
43 VARIANCE,
44 /** Skewness. */
45 SKEWNESS,
46 /** Kurtosis. */
47 KURTOSIS,
48 /** Product. */
49 PRODUCT,
50 /** Sum. */
51 SUM,
52 /** Sum of the natural logarithm of values. */
53 SUM_OF_LOGS,
54 /** Sum of the squared values. */
55 SUM_OF_SQUARES,
56 /** Geometric mean. */
57 GEOMETRIC_MEAN
58 }