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.math4.legacy.stat.descriptive;
18
19 import org.apache.commons.math4.legacy.exception.MathIllegalArgumentException;
20
21 /**
22 * Weighted evaluation for statistics.
23 *
24 * @since 2.1
25 */
26 public interface WeightedEvaluation {
27
28 /**
29 * Returns the result of evaluating the statistic over the input array,
30 * using the supplied weights.
31 *
32 * @param values input array
33 * @param weights array of weights
34 * @return the value of the weighted statistic applied to the input array
35 * @throws MathIllegalArgumentException if either array is null, lengths
36 * do not match, weights contain NaN, negative or infinite values, or
37 * weights does not include at least on positive value
38 */
39 double evaluate(double[] values, double[] weights) throws MathIllegalArgumentException;
40
41 /**
42 * Returns the result of evaluating the statistic over the specified entries
43 * in the input array, using corresponding entries in the supplied weights array.
44 *
45 * @param values the input array
46 * @param weights array of weights
47 * @param begin the index of the first element to include
48 * @param length the number of elements to include
49 * @return the value of the weighted statistic applied to the included array entries
50 * @throws MathIllegalArgumentException if either array is null, lengths
51 * do not match, indices are invalid, weights contain NaN, negative or
52 * infinite values, or weights does not include at least on positive value
53 */
54 double evaluate(double[] values, double[] weights, int begin, int length)
55 throws MathIllegalArgumentException;
56 }