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 mutable result container that accumulates a {@link StatisticResult}.
021 *
022 * @param <T> {@link StatisticResult} being accumulated.
023 *
024 * @since 1.1
025 */
026public interface StatisticAccumulator<T extends StatisticResult> {
027
028    /**
029     * Combines the state of the {@code other} statistic into this one.
030     *
031     * @param other Another statistic to be combined.
032     * @return {@code this} instance after combining {@code other}.
033     */
034    T combine(T other);
035}