Accumulator.java
01 /*
02  * Java Genetic Algorithm Library (jenetics-1.6.0).
03  * Copyright (c) 2007-2014 Franz Wilhelmstötter
04  *
05  * Licensed under the Apache License, Version 2.0 (the "License");
06  * you may not use this file except in compliance with the License.
07  * You may obtain a copy of the License at
08  *
09  *      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  * Author:
18  *    Franz Wilhelmstötter (franz.wilhelmstoetter@gmx.at)
19  */
20 package org.jenetics.util;
21 
22 /**
23  * Interface for accumulating values of a given type. Here an usage example:
24  *
25  * [code]
26  * final MinMax<Double> minMax = new MinMax<>();
27  * final Variance<Double> variance = new Variance<>();
28  * final Quantile<Double> quantile = new Quantile<>();
29  *
30  * final List<Double> values = ...;
31  * accumulators.accumulate(values, minMax, variance, quantile);
32  * [/code]
33  *
34  @see accumulators
35  *
36  @author <a href="mailto:franz.wilhelmstoetter@gmx.at">Franz Wilhelmstötter</a>
37  @since 1.0
38  @version 1.0 &mdash; <em>$Date: 2013-08-29 $</em>
39  */
40 public interface Accumulator<T> {
41 
42     /**
43      * Accumulate the given value.
44      *
45      @param value the value to accumulate.
46      */
47     public void accumulate(final T value);
48 
49 }