org.apache.commons.math3.fitting.WeightedObservedPoint Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of commons-math3 Show documentation

The Apache Commons Math project is a library of lightweight, self-contained mathematics and statistics components addressing the most common practical problems not immediately available in the Java programming language or commons-lang.

The newest version!

/*
 * 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}.
 * 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;
    }

}