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.math3.stat.descriptive;
18
19 import org.apache.commons.math3.exception.MathIllegalArgumentException;
20 import org.apache.commons.math3.util.MathArrays;
21
22
23 /**
24 * Base interface implemented by all statistics.
25 *
26 * @version $Id: UnivariateStatistic.java 1416643 2012-12-03 19:37:14Z tn $
27 */
28 public interface UnivariateStatistic extends MathArrays.Function {
29 /**
30 * Returns the result of evaluating the statistic over the input array.
31 *
32 * @param values input array
33 * @return the value of the statistic applied to the input array
34 * @throws MathIllegalArgumentException if values is null
35 */
36 double evaluate(double[] values) throws MathIllegalArgumentException;
37
38 /**
39 * Returns the result of evaluating the statistic over the specified entries
40 * in the input array.
41 *
42 * @param values the input array
43 * @param begin the index of the first element to include
44 * @param length the number of elements to include
45 * @return the value of the statistic applied to the included array entries
46 * @throws MathIllegalArgumentException if values is null or the indices are invalid
47 */
48 double evaluate(double[] values, int begin, int length) throws MathIllegalArgumentException;
49
50 /**
51 * Returns a copy of the statistic with the same internal state.
52 *
53 * @return a copy of the statistic
54 */
55 UnivariateStatistic copy();
56 }