summaryrefslogtreecommitdiff
path: root/src/main/java/org/apache/commons/math3/fitting/WeightedObservedPoint.java
blob: ec887470c198ba451e46e572bc9f769c41cb1ea6 (plain)
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
/*
 * 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;

/**
 * This class is a simple container for weighted observed point in {@link CurveFitter curve
 * fitting}.
 *
 * <p>Instances of this class are guaranteed to be immutable.
 *
 * @since 2.0
 */
public class WeightedObservedPoint implements Serializable {
    /** Serializable version id. */
    private static final long serialVersionUID = 5306874947404636157L;

    /** Weight of the measurement in the fitting process. */
    private final double weight;

    /** Abscissa of the point. */
    private final double x;

    /** Observed value of the function at x. */
    private final double y;

    /**
     * Simple constructor.
     *
     * @param weight Weight of the measurement in the fitting process.
     * @param x Abscissa of the measurement.
     * @param y Ordinate of the measurement.
     */
    public WeightedObservedPoint(final double weight, final double x, final double y) {
        this.weight = weight;
        this.x = x;
        this.y = y;
    }

    /**
     * Gets the weight of the measurement in the fitting process.
     *
     * @return the weight of the measurement in the fitting process.
     */
    public double getWeight() {
        return weight;
    }

    /**
     * Gets the abscissa of the point.
     *
     * @return the abscissa of the point.
     */
    public double getX() {
        return x;
    }

    /**
     * Gets the observed value of the function at x.
     *
     * @return the observed value of the function at x.
     */
    public double getY() {
        return y;
    }
}