Home | History | Annotate | Download | only in descriptive
      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  * Weighted evaluation for statistics.
     21  *
     22  * @since 2.1
     23  * @version $Revision: 894474 $ $Date: 2009-12-29 21:02:37 +0100 (mar. 29 dc. 2009) $
     24  */
     25 public interface WeightedEvaluation {
     26 
     27     /**
     28      * Returns the result of evaluating the statistic over the input array,
     29      * using the supplied weights.
     30      *
     31      * @param values input array
     32      * @param weights array of weights
     33      * @return the value of the weighted statistic applied to the input array
     34      */
     35     double evaluate(double[] values, double[] weights);
     36 
     37     /**
     38      * Returns the result of evaluating the statistic over the specified entries
     39      * in the input array, using corresponding entries in the supplied weights array.
     40      *
     41      * @param values the input array
     42      * @param weights array of weights
     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 weighted statistic applied to the included array entries
     46      */
     47     double evaluate(double[] values, double[] weights, int begin, int length);
     48 
     49 }
     50