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.math.stat.descriptive;
18
19 import java.io.Serializable;
20
21 /**
22 * Base evaluation interface implemented by all statistics.
23 * <p>
24 * Includes "stateless" <code>evaluate</code> methods that take
25 * <code>double[]</code> arrays as input and return the value of the statistic
26 * applied to the input values.</p>
27 *
28 * @version $Revision: 617953 $ $Date: 2008-02-02 22:54:00 -0700 (Sat, 02 Feb 2008) $
29 */
30 public interface UnivariateStatistic extends Serializable {
31
32 /**
33 * Returns the result of evaluating the statistic over the input array.
34 *
35 * @param values input array
36 * @return the value of the statistic applied to the input array
37 */
38 double evaluate(double[] values);
39
40 /**
41 * Returns the result of evaluating the statistic over the specified entries
42 * in the input array.
43 *
44 * @param values the input array
45 * @param begin the index of the first element to include
46 * @param length the number of elements to include
47 * @return the value of the statistic applied to the included array entries
48 */
49 double evaluate(double[] values, int begin, int length);
50
51 }