001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.statistics.descriptive;
018
019/**
020 * A statistic that can be computed on univariate data, for example a stream of
021 * {@code double} values.
022 *
023 * <p>{@code Statistic} is an enum representing the statistics that can be computed
024 * by implementations in the {@code org.apache.commons.statistics.descriptive} package.
025 *
026 * <p><strong>Note</strong>
027 *
028 * <p>Implementations may provide additional parameters to control the computation of
029 * the statistic, for example to compute the population (biased) or sample (unbiased) variance.
030 *
031 * @since 1.1
032 */
033public enum Statistic {
034    /** Minimum. */
035    MIN,
036    /** Maximum. */
037    MAX,
038    /** Mean, or average. */
039    MEAN,
040    /** Standard deviation. */
041    STANDARD_DEVIATION,
042    /** Variance. */
043    VARIANCE,
044    /** Skewness. */
045    SKEWNESS,
046    /** Kurtosis. */
047    KURTOSIS,
048    /** Product. */
049    PRODUCT,
050    /** Sum. */
051    SUM,
052    /** Sum of the natural logarithm of values. */
053    SUM_OF_LOGS,
054    /** Sum of the squared values. */
055    SUM_OF_SQUARES,
056    /** Geometric mean. */
057    GEOMETRIC_MEAN
058}