Documentation API of the 'jhplot.math.ValueErr' Java class
ValueErr
jhplot.math

Class ValueErr

  • All Implemented Interfaces:
    Serializable


    public class ValueErrextends Objectimplements Serializable
    A value represented with the number (value) and associated error. This class contains methods useful for error propagation.
    See Also:
    Serialized Form
    • Constructor Detail

      • ValueErr

        public ValueErr()
        Initialize error propagations
      • ValueErr

        public ValueErr(double value)
        Initialize with value and set error=0
        Parameters:
        value -
      • ValueErr

        public ValueErr(double value,        double error)
        Initialize error propagation
        Parameters:
        value - value
        error - its error
    • Method Detail

      • setVal

        public void setVal(double value)
        Set value
        Parameters:
        value -
      • setErr

        public void setErr(double error)
        Set error
        Parameters:
        error -
      • reset

        public void reset(double value,         double error)
        Set value and errors to 0
        Parameters:
        value -
        error -
      • getVal

        public double getVal()
        Get current value
        Returns:
        value
      • getErr

        public double getErr()
        Get current error
        Returns:
        error
      • oneDarray

        public ValueErr[] oneDarray(int n)
        Create a one dimensional array of ValueErr objects of length n. all values are zero
      • oneDarray

        public ValueErr[] oneDarray(int n,                   ValueErr constant)
        Create a one dimensional array of ValueErr objects of length n and m
      • twoDarray

        public ValueErr[][] twoDarray(int n,                     int m)
        Create a two dimensional array of ValueErr objects of dimensions n and m with zeros
      • copy

        public ValueErr copy()
        Copy a single ValueErr
      • copy

        public ValueErr[][] copy(ValueErr[][] a)
        Deep copy a 2D array of ValueErr numbers
      • minus

        public ValueErr minus(ValueErr a,             double corrCoeff)
        Subtract an ValueErr number from this ValueErr number with correlation
      • minus

        public ValueErr minus(ValueErr a,             ValueErr b,             double corrCoeff)
        Subtract ValueErr number b from ValueErr number a with correlation
      • minus

        public ValueErr minus(ValueErr a)
        Subtract a ValueErr number from this ValueErr number without correlation
      • minus

        public ValueErr minus(ValueErr a,             ValueErr b)
        Subtract ValueErr number b from ValueErr number without correlation
      • minus

        public ValueErr minus(double a)
        Subtract an error free double number from this ValueErr number.
      • minus

        public ValueErr minus(double a,             ValueErr b)
        Subtract a ValueErr number b from an error free double
      • minus

        public ValueErr minus(double a,             double b)
        Subtract an error free double number b from an error free double a and return sum as ValueErr
      • minusEquals

        public void minusEquals(ValueErr a,               double corrCoeff)
        Subtract a ValueErr number to this ValueErr number and replace this with the sum with correlation
      • minusEquals

        public void minusEquals(ValueErr a)
        Subtract a ValueErr number from this ValueErr number and replace this with the sum with no correlation
      • minusEquals

        public void minusEquals(double a)
        Subtract a double number from this ValueErr number and replace this with the sum
      • plus

        public ValueErr plus(ValueErr a,            double corrCoeff)
        Add 2 values with correlation
      • plus

        public ValueErr plus(ValueErr a)
        Add a ValueErr number to this ValueErr number without correlaton
      • plus

        public ValueErr plus(double a)
        Add an error free double number to this ValueErr number
      • plus

        public ValueErr plus(double a,            ValueErr b)
        Add a ValueErr number to an error free double
      • plus

        public ValueErr plus(double a,            double b)
        Add an error free double number to an error free double and return sum
      • plusEquals

        public void plusEquals(ValueErr a,              double corrCoeff)
        Add a ValueErr number to this ValueErr number and replace this with the sum using a correlation
      • plusEquals

        public void plusEquals(ValueErr a)
        Add a ValueErr number to this ValueErr number and replace this with the sum without correlation
      • plusEquals

        public void plusEquals(double a)
        Add double number to this ValueErr number and replace this with the sum
      • times

        public ValueErr times(ValueErr a,             double corrCoeff)
        Multiply two ValueErr numbers with correlation
      • times

        public ValueErr times(ValueErr a)
        Multiply this ValueErr number by a ValueErr number without correlation
      • times

        public ValueErr times(double a)
        Multiply this ValueErr number by a double. ValueErr number remains unaltered
      • times

        public ValueErr times(double a,             ValueErr b)
        Multiply a double by a ValueErr number
      • times

        public ValueErr times(double a,             double b)
        Multiply a double number by a double and return product as ValueErr
      • timesEquals

        public void timesEquals(ValueErr a,               double corrCoeff)
        Multiply this ValueErr number by an ValueErr number and replace this by the product with correlation
      • timesEquals

        public void timesEquals(ValueErr a)
        Multiply this ValueErr number by an ValueErr number and replace this by the product with no correlation
      • timesEquals

        public void timesEquals(double a)
        Multiply this ValueErr number by a double and replace it by the product
      • divide

        public ValueErr divide(ValueErr a,              double corrCoeff)
        Division of this ValueErr number by a ValueErr number.
      • divide

        public ValueErr divide(ValueErr a,              ValueErr b,              double corrCoeff)
        Division of two ValueErr numbers a/b with correlation
      • divide

        public ValueErr divide(ValueErr a)
        Division of this ValueErr number by a ValueErr number without correlation
      • divide

        public ValueErr divide(double a)
        Division of this ValueErr number by a double
      • divide

        public ValueErr divide(double a,              ValueErr b)
        Division of a double, a, by a ValueErr number, b
      • divide

        public ValueErr divide(double a,              double b)
        Divide a double number by a double and return quotient as ValueErr
      • divideEqual

        public void divideEqual(ValueErr b)
        Division of this ValueErr number by a ValueErr number and replace it by the quotient without correlation
      • divideEqual

        public void divideEqual(ValueErr b,               double corrCoeff)
        Division of this ValueErr number by a ValueErr number and replace this by the quotient
      • divideEqual

        public void divideEqual(double a)
        Division of this ValueErr number by a double and replace this by the quotient
      • inverse

        public ValueErr inverse()
        Returns the inverse (1/a) of a ValueErr number
      • inverse

        public ValueErr inverse(ValueErr a)
        Returns the reciprocal (1/a) of a ValueErr number (a)
      • hypotenuse

        public ValueErr hypotenuse(ValueErr a,                  ValueErr b,                  double corrCoeff)
        Returns the length of the hypotenuse of a and b i.e. sqrt(a*a + b*b) where a and b are ValueErr
      • hypotenuse

        public double hypotenuse(double aa,                double bb)
        Returns the length of the hypotenuse of a and b i.e. sqrt(a*a+b*b)
      • hypot

        public ValueErr hypot(ValueErr a,             ValueErr b)
        Returns the length of the hypotenuse of a and b i.e. sqrt(a*a + b*b) where a and b are ValueErr
      • exp

        public ValueErr exp(ValueErr a)
        Get exponential function
        Parameters:
        a - input error
        Returns:
      • log

        public ValueErr log(ValueErr a)
        Take natural log
        Parameters:
        a - input value
        Returns:
      • log10

        public ValueErr log10(ValueErr a)
        log to base 10
        Parameters:
        log - to base 10
        Returns:
        output
      • log10

        public double log10(double a)
      • nRoot

        public ValueErr nRoot(ValueErr a,             int n)
        Take nth root from the value (n is above 1)
      • pow

        public ValueErr pow(ValueErr a,           double b)
        returns an ValueErr number raised to an error free power
      • pow

        public ValueErr pow(double a,           ValueErr b)
        returns an error free number raised to an ValueErr power
      • pow

        public ValueErr pow(ValueErr a,           ValueErr b,           double corrCoeff)
        returns a ValueErr number raised to a ValueErr power with correlation
      • sin

        public ValueErr sin(ValueErr a)
        sine of an ValueErr number (trigonometric function)
      • sec

        public double sec(double a)
        Secant
        Parameters:
        a -
        Returns:
      • square

        public double square(double a)
      • sech

        public double sech(double a)
        Hyperbolic secant
      • atan2

        public ValueErr atan2(ValueErr a,             ValueErr b,             double rho)
        Inverse tangent (atan2) of a value with a correlation
      • asinh

        public ValueErr asinh(ValueErr a)
        Inverse hyperbolic sine of a value with error
      • asinh

        public double asinh(double a)
        Inverse hyperbolic sine of a double number
      • zero

        public ValueErr zero()
        Set value to zero
      • sign

        public double sign(double x)
        Sign function
      • hypWithCovariance

        public double hypWithCovariance(double a,                       double b,                       double r)
        Private methods. Calculation of sqrt(a*a + b*b + 2*r*a*b) (safe)

SCaVis 2.2 © jWork.ORG

Warning: You see this message because an access to the SCaVis documentation for third-party Java classes is denied. Guests can only view jhplot Java API. To enable the description of all Java classes of SCaVis, please request the full SCaVis membership.

If you are already a full member, please login to the SCaVis member area before visiting this documentation.