org.freehep.graphicsbase.util.DoubleWithError Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of freehep-graphicsbase Show documentation

FreeHEP Graphics Base Library

The newest version!

package org.freehep.graphicsbase.util;

/**
 * A class that encapsulates a value and its error.
 * Primarily for use with ScientificFormat
 *
 * @see ScientificFormat
 *
 * @author Tony Johnson
 * @author Mark Donszelmann
 * @version $Id: DoubleWithError.java 8584 2006-08-10 23:06:37Z duns $
 */
public class DoubleWithError
{
    public DoubleWithError(double value, double error)
    {
        this.value = value;
        this.error = error;
        this.asymmetricError = false;
    }
    
    public DoubleWithError(double value, double plusError, double minError)
    {
        this.value = value;
        this.error = plusError;
        this.minError = minError;
        this.asymmetricError = true;
    }
    
    public void setError(double error)
    {
        this.error = error;
        this.asymmetricError = false;
    }
    
    public void setError(double plusError, double minError)
    {
        this.error = plusError;
        this.minError = minError;
        this.asymmetricError = true;
    }
    
    public double getError()
    {
        // FIXME: what do we return here if this has an asymmetric error
        return error;
    }
    
    public double getPlusError()
    {
        return error;
    }
    
    public double getMinError()
    {
        return (asymmetricError) ? minError : error;
    }
    
    public boolean hasAsymmetricError()
    {
        return asymmetricError;
    }
    
    public void setValue(double value)
    {
        this.value = value;
    }
    
    public double getValue()
    {
        return value;
    }
    
    public String toString()
    {
        if (asymmetricError)
        {
            return String.valueOf(value)+plus+error+minus+minError;
        } 
        else
        {
            return String.valueOf(value)+plusorminus+error;
        }
    }
    // Not private because used by scientific format
    final static char plusorminus = '\u00b1';
    final static char plus = '+';
    final static char minus = '-';
    private double value;
    
    private double error;
    private boolean asymmetricError;
    private double minError;
}