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 20 /** 21 * Base interface implemented by all statistics. 22 * 23 * @version $Revision: 811685 $ $Date: 2009-09-05 19:36:48 +0200 (sam. 05 sept. 2009) $ 24 */ 25 public interface UnivariateStatistic { 26 27 /** 28 * Returns the result of evaluating the statistic over the input array. 29 * 30 * @param values input array 31 * @return the value of the statistic applied to the input array 32 */ evaluate(double[] values)33 double evaluate(double[] values); 34 35 /** 36 * Returns the result of evaluating the statistic over the specified entries 37 * in the input array. 38 * 39 * @param values the input array 40 * @param begin the index of the first element to include 41 * @param length the number of elements to include 42 * @return the value of the statistic applied to the included array entries 43 */ evaluate(double[] values, int begin, int length)44 double evaluate(double[] values, int begin, int length); 45 46 /** 47 * Returns a copy of the statistic with the same internal state. 48 * 49 * @return a copy of the statistic 50 */ copy()51 UnivariateStatistic copy(); 52 53 } 54