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 */
017 package org.apache.commons.math.stat.descriptive;
018
019 /**
020 * Weighted evaluation for statistics.
021 *
022 * @since 2.1
023 * @version $Revision: 894474 $ $Date: 2009-12-29 21:02:37 +0100 (mar. 29 d??c. 2009) $
024 */
025 public interface WeightedEvaluation {
026
027 /**
028 * Returns the result of evaluating the statistic over the input array,
029 * using the supplied weights.
030 *
031 * @param values input array
032 * @param weights array of weights
033 * @return the value of the weighted statistic applied to the input array
034 */
035 double evaluate(double[] values, double[] weights);
036
037 /**
038 * Returns the result of evaluating the statistic over the specified entries
039 * in the input array, using corresponding entries in the supplied weights array.
040 *
041 * @param values the input array
042 * @param weights array of weights
043 * @param begin the index of the first element to include
044 * @param length the number of elements to include
045 * @return the value of the weighted statistic applied to the included array entries
046 */
047 double evaluate(double[] values, double[] weights, int begin, int length);
048
049 }