1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.math3.stat.descriptive;
import org.apache.commons.math3.exception.MathIllegalArgumentException;
/**
* Weighted evaluation for statistics.
*
* @since 2.1
*/
public interface WeightedEvaluation {
/**
* Returns the result of evaluating the statistic over the input array,
* using the supplied weights.
*
* @param values input array
* @param weights array of weights
* @return the value of the weighted statistic applied to the input array
* @throws MathIllegalArgumentException if either array is null, lengths
* do not match, weights contain NaN, negative or infinite values, or
* weights does not include at least on positive value
*/
double evaluate(double[] values, double[] weights) throws MathIllegalArgumentException;
/**
* Returns the result of evaluating the statistic over the specified entries
* in the input array, using corresponding entries in the supplied weights array.
*
* @param values the input array
* @param weights array of weights
* @param begin the index of the first element to include
* @param length the number of elements to include
* @return the value of the weighted statistic applied to the included array entries
* @throws MathIllegalArgumentException if either array is null, lengths
* do not match, indices are invalid, weights contain NaN, negative or
* infinite values, or weights does not include at least on positive value
*/
double evaluate(double[] values, double[] weights, int begin, int length)
throws MathIllegalArgumentException;
}
|
