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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
/*
* 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.fitting;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
/**
* Simple container for weighted observed points used in {@link AbstractCurveFitter curve fitting}
* algorithms.
*
* @since 3.3
*/
public class WeightedObservedPoints implements Serializable {
/** Serializable version id. */
private static final long serialVersionUID = 20130813L;
/** Observed points. */
private final List<WeightedObservedPoint> observations = new ArrayList<WeightedObservedPoint>();
/**
* Adds a point to the sample. Calling this method is equivalent to calling {@code add(1.0, x,
* y)}.
*
* @param x Abscissa of the point.
* @param y Observed value at {@code x}. After fitting we should have {@code f(x)} as close as
* possible to this value.
* @see #add(double, double, double)
* @see #add(WeightedObservedPoint)
* @see #toList()
*/
public void add(double x, double y) {
add(1d, x, y);
}
/**
* Adds a point to the sample.
*
* @param weight Weight of the observed point.
* @param x Abscissa of the point.
* @param y Observed value at {@code x}. After fitting we should have {@code f(x)} as close as
* possible to this value.
* @see #add(double, double)
* @see #add(WeightedObservedPoint)
* @see #toList()
*/
public void add(double weight, double x, double y) {
observations.add(new WeightedObservedPoint(weight, x, y));
}
/**
* Adds a point to the sample.
*
* @param observed Observed point to add.
* @see #add(double, double)
* @see #add(double, double, double)
* @see #toList()
*/
public void add(WeightedObservedPoint observed) {
observations.add(observed);
}
/**
* Gets a <em>snapshot</em> of the observed points. The list of stored points is copied in order
* to ensure that modification of the returned instance does not affect this container.
* Conversely, further modification of this container (through the {@code add} or {@code clear}
* methods) will not affect the returned list.
*
* @return the observed points, in the order they were added to this container.
* @see #add(double, double)
* @see #add(double, double, double)
* @see #add(WeightedObservedPoint)
*/
public List<WeightedObservedPoint> toList() {
// The copy is necessary to ensure thread-safety because of the
// "clear" method (which otherwise would be able to empty the
// list of points while it is being used by another thread).
return new ArrayList<WeightedObservedPoint>(observations);
}
/** Removes all observations from this container. */
public void clear() {
observations.clear();
}
}
|
