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.fitting;
18
19 /**
20 * This class is a simple container for weighted observed point in
21 * {@link AbstractCurveFitter curve fitting}.
22 * <p>Instances of this class are guaranteed to be immutable.</p>
23 * @since 2.0
24 */
25 public class WeightedObservedPoint {
26 /** Weight of the measurement in the fitting process. */
27 private final double weight;
28 /** Abscissa of the point. */
29 private final double x;
30 /** Observed value of the function at x. */
31 private final double y;
32
33 /**
34 * Simple constructor.
35 *
36 * @param weight Weight of the measurement in the fitting process.
37 * @param x Abscissa of the measurement.
38 * @param y Ordinate of the measurement.
39 */
40 public WeightedObservedPoint(final double weight, final double x, final double y) {
41 this.weight = weight;
42 this.x = x;
43 this.y = y;
44 }
45
46 /**
47 * Gets the weight of the measurement in the fitting process.
48 *
49 * @return the weight of the measurement in the fitting process.
50 */
51 public double getWeight() {
52 return weight;
53 }
54
55 /**
56 * Gets the abscissa of the point.
57 *
58 * @return the abscissa of the point.
59 */
60 public double getX() {
61 return x;
62 }
63
64 /**
65 * Gets the observed value of the function at x.
66 *
67 * @return the observed value of the function at x.
68 */
69 public double getY() {
70 return y;
71 }
72 }