org.apache.commons.statistics.descriptive.StatisticAccumulator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of commons-statistics-descriptive Show documentation

Descriptive statistics.

The newest version!

/*
 * 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.
 */
package org.apache.commons.statistics.descriptive;

/**
 * A mutable result container that accumulates a {@link StatisticResult}.
 *
 * @param  {@link StatisticResult} being accumulated.
 *
 * @since 1.1
 */
public interface StatisticAccumulator {

    /**
     * Combines the state of the {@code other} statistic into this one.
     *
     * @param other Another statistic to be combined.
     * @return {@code this} instance after combining {@code other}.
     */
    T combine(T other);
}