001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-2020, by Object Refinery Limited and Contributors.
006 *
007 * Project Info:  http://www.jfree.org/jfreechart/index.html
008 *
009 * This library is free software; you can redistribute it and/or modify it
010 * under the terms of the GNU Lesser General Public License as published by
011 * the Free Software Foundation; either version 2.1 of the License, or
012 * (at your option) any later version.
013 *
014 * This library is distributed in the hope that it will be useful, but
015 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
016 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
017 * License for more details.
018 *
019 * You should have received a copy of the GNU Lesser General Public
020 * License along with this library; if not, write to the Free Software
021 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
022 * USA.
023 *
024 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 
025 * Other names may be trademarks of their respective owners.]
026 *
027 * -----------------------------
028 * MeanAndStandardDeviation.java
029 * -----------------------------
030 * (C) Copyright 2003-2008, by Object Refinery Limited.
031 *
032 * Original Author:  David Gilbert (for Object Refinery Limited);
033 * Contributor(s):   -;
034 *
035 * Changes:
036 * --------
037 * 05-Feb-2002 : Version 1 (DG);
038 * 05-Feb-2005 : Added equals() method and implemented Serializable (DG);
039 * 02-Oct-2007 : Added getMeanValue() and getStandardDeviationValue() methods
040 *               for convenience, and toString() method for debugging (DG);
041 *
042 */
043
044package org.jfree.data.statistics;
045
046import java.io.Serializable;
047import org.jfree.chart.util.ObjectUtils;
048
049/**
050 * A simple data structure that holds a mean value and a standard deviation
051 * value.  This is used in the
052 * {@link org.jfree.data.statistics.DefaultStatisticalCategoryDataset} class.
053 */
054public class MeanAndStandardDeviation implements Serializable {
055
056    /** For serialization. */
057    private static final long serialVersionUID = 7413468697315721515L;
058
059    /** The mean. */
060    private Number mean;
061
062    /** The standard deviation. */
063    private Number standardDeviation;
064
065    /**
066     * Creates a new mean and standard deviation record.
067     *
068     * @param mean  the mean.
069     * @param standardDeviation  the standard deviation.
070     */
071    public MeanAndStandardDeviation(double mean, double standardDeviation) {
072        this(Double.valueOf(mean), Double.valueOf(standardDeviation));
073    }
074
075    /**
076     * Creates a new mean and standard deviation record.
077     *
078     * @param mean  the mean ({@code null} permitted).
079     * @param standardDeviation  the standard deviation ({@code null}
080     *                           permitted.
081     */
082    public MeanAndStandardDeviation(Number mean, Number standardDeviation) {
083        this.mean = mean;
084        this.standardDeviation = standardDeviation;
085    }
086
087    /**
088     * Returns the mean.
089     *
090     * @return The mean.
091     */
092    public Number getMean() {
093        return this.mean;
094    }
095
096    /**
097     * Returns the mean as a double primitive.  If the underlying mean is
098     * {@code null}, this method will return {@code Double.NaN}.
099     *
100     * @return The mean.
101     *
102     * @see #getMean()
103     *
104     * @since 1.0.7
105     */
106    public double getMeanValue() {
107        double result = Double.NaN;
108        if (this.mean != null) {
109            result = this.mean.doubleValue();
110        }
111        return result;
112    }
113
114    /**
115     * Returns the standard deviation.
116     *
117     * @return The standard deviation.
118     */
119    public Number getStandardDeviation() {
120        return this.standardDeviation;
121    }
122
123    /**
124     * Returns the standard deviation as a double primitive.  If the underlying
125     * standard deviation is {@code null}, this method will return
126     * {@code Double.NaN}.
127     *
128     * @return The standard deviation.
129     *
130     * @since 1.0.7
131     */
132    public double getStandardDeviationValue() {
133        double result = Double.NaN;
134        if (this.standardDeviation != null) {
135            result = this.standardDeviation.doubleValue();
136        }
137        return result;
138    }
139
140    /**
141     * Tests this instance for equality with an arbitrary object.
142     *
143     * @param obj  the object ({@code null} permitted).
144     *
145     * @return A boolean.
146     */
147    @Override
148    public boolean equals(Object obj) {
149        if (obj == this) {
150            return true;
151        }
152        if (!(obj instanceof MeanAndStandardDeviation)) {
153            return false;
154        }
155        MeanAndStandardDeviation that = (MeanAndStandardDeviation) obj;
156        if (!ObjectUtils.equal(this.mean, that.mean)) {
157            return false;
158        }
159        if (!ObjectUtils.equal(
160            this.standardDeviation, that.standardDeviation)
161        ) {
162            return false;
163        }
164        return true;
165    }
166
167    /**
168     * Returns a string representing this instance.
169     *
170     * @return A string.
171     *
172     * @since 1.0.7
173     */
174    @Override
175    public String toString() {
176        return "[" + this.mean + ", " + this.standardDeviation + "]";
177    }
178
179}