ValueErr

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

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- jhplot.math.ValueErr

All Implemented Interfaces:

java.io.Serializable
```
public class ValueErr
extends java.lang.Object
implements java.io.Serializable
```
A value represented with the number (value) and associated error. This class contains methods useful for error propagation. You can enabled fast math calculation using

See Also:

HParam, Serialized Form

Constructor Summary

Constructors
Constructor and Description
`ValueErr()` Initialize error propagations
`ValueErr(double value)` Initialize with value and set error=0
`ValueErr(double value, double error)` Initialize error propagation

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ValueErr`	`acos(ValueErr a)` Inverse cosine of a value with error
`ValueErr`	`asin(ValueErr a)` Inverse sine of a value with error
`double`	`asinh(double a)` Inverse hyperbolic sine of a double number
`ValueErr`	`asinh(ValueErr a)` Inverse hyperbolic sine of a value with error
`ValueErr`	`atan(ValueErr a)` inverse tangent of a value
`ValueErr`	`atan2(ValueErr a, ValueErr b)` Inverse tangent (atan2) of a value without correlations
`ValueErr`	`atan2(ValueErr a, ValueErr b, double rho)` Inverse tangent (atan2) of a value with a correlation
`java.lang.Object`	`clone()`
`ValueErr`	`copy()` Copy a single ValueErr
`static ValueErr`	`copy(ValueErr a)` Copy value
`ValueErr[]`	`copy(ValueErr[] a)`
`ValueErr[][]`	`copy(ValueErr[][] a)` Deep copy a 2D array of ValueErr numbers
`ValueErr`	`cos(ValueErr a)` Cosine of a value wth error
`ValueErr`	`cosh(ValueErr a)` Hyperbolic cosine
`ValueErr`	`divide(double a)` Division of this ValueErr number by a double
`ValueErr`	`divide(double a, double b)` Divide a double number by a double and return quotient as ValueErr
`ValueErr`	`divide(double a, ValueErr b)` Division of a double, a, by a ValueErr number, b
`ValueErr`	`divide(ValueErr a)` Division of this ValueErr number by a ValueErr number without correlation
`ValueErr`	`divide(ValueErr a, double corrCoeff)` Division of this ValueErr number by a ValueErr number.
`ValueErr`	`divide(ValueErr a, ValueErr b)` Division of two ValueErr numbers a/b without correlation
`ValueErr`	`divide(ValueErr a, ValueErr b, double corrCoeff)` Division of two ValueErr numbers a/b with correlation
`void`	`divideEqual(double a)` Division of this ValueErr number by a double and replace this by the quotient
`void`	`divideEqual(ValueErr b)` Division of this ValueErr number by a ValueErr number and replace it by the quotient without correlation
`void`	`divideEqual(ValueErr b, double corrCoeff)` Division of this ValueErr number by a ValueErr number and replace this by the quotient
`ValueErr`	`exp(ValueErr a)` Get exponential function
`double`	`getErr()` Get current error
`double`	`getVal()` Get current value
`int`	`hashCode()`
`ValueErr`	`hypot(ValueErr a, ValueErr b)` Returns the length of the hypotenuse of a and b i.e.
`double`	`hypotenuse(double aa, double bb)` Returns the length of the hypotenuse of a and b i.e.
`ValueErr`	`hypotenuse(ValueErr a, ValueErr b, double corrCoeff)` Returns the length of the hypotenuse of a and b i.e.
`double`	`hypWithCovariance(double a, double b, double r)` Private methods.
`ValueErr`	`inverse()` Returns the inverse (1/a) of a ValueErr number
`ValueErr`	`inverse(ValueErr a)` Returns the reciprocal (1/a) of a ValueErr number (a)
`ValueErr`	`log(ValueErr a)` Take natural log
`double`	`log10(double a)`
`ValueErr`	`log10(ValueErr a)` log to base 10
`ValueErr`	`minus(double a)` Subtract an error free double number from this ValueErr number.
`ValueErr`	`minus(double a, double b)` Subtract an error free double number b from an error free double a and return sum as ValueErr
`ValueErr`	`minus(double a, ValueErr b)` Subtract a ValueErr number b from an error free double
`ValueErr`	`minus(ValueErr a)` Subtract a ValueErr number from this ValueErr number without correlation
`ValueErr`	`minus(ValueErr a, double corrCoeff)` Subtract an ValueErr number from this ValueErr number with correlation
`ValueErr`	`minus(ValueErr a, ValueErr b)` Subtract ValueErr number b from ValueErr number without correlation
`ValueErr`	`minus(ValueErr a, ValueErr b, double corrCoeff)` Subtract ValueErr number b from ValueErr number a with correlation
`void`	`minusEquals(double a)` Subtract a double number from this ValueErr number and replace this with the sum
`void`	`minusEquals(ValueErr a)` Subtract a ValueErr number from this ValueErr number and replace this with the sum with no correlation
`void`	`minusEquals(ValueErr a, double corrCoeff)` Subtract a ValueErr number to this ValueErr number and replace this with the sum with correlation
`ValueErr`	`nRoot(ValueErr a, int n)` Take nth root from the value (n is above 1)
`ValueErr[]`	`oneDarray(int n)` Create a one dimensional array of ValueErr objects of length n.
`ValueErr[]`	`oneDarray(int n, ValueErr constant)` Create a one dimensional array of ValueErr objects of length n and m
`ValueErr`	`plus(double a)` Add an error free double number to this ValueErr number
`ValueErr`	`plus(double a, double b)` Add an error free double number to an error free double and return sum
`ValueErr`	`plus(double a, ValueErr b)` Add a ValueErr number to an error free double
`ValueErr`	`plus(ValueErr a)` Add a ValueErr number to this ValueErr number without correlaton
`ValueErr`	`plus(ValueErr a, double corrCoeff)` Add 2 values with correlation
`ValueErr`	`plus(ValueErr a, ValueErr b)` Add two ValueErr numbers with no correlation
`ValueErr`	`plus(ValueErr a, ValueErr b, double corrCoeff)` Adding 2 values with correlation
`void`	`plusEquals(double a)` Add double number to this ValueErr number and replace this with the sum
`void`	`plusEquals(ValueErr a)` Add a ValueErr number to this ValueErr number and replace this with the sum without correlation
`void`	`plusEquals(ValueErr a, double corrCoeff)` Add a ValueErr number to this ValueErr number and replace this with the sum using a correlation
`ValueErr`	`pow(double a, ValueErr b)` returns an error free number raised to an ValueErr power
`ValueErr`	`pow(ValueErr a, double b)` returns an ValueErr number raised to an error free power
`ValueErr`	`pow(ValueErr a, ValueErr b)` ValueErr number raised to a ValueErr power with no correlation
`ValueErr`	`pow(ValueErr a, ValueErr b, double corrCoeff)` returns a ValueErr number raised to a ValueErr power with correlation
`void`	`reset(double value, double error)` Set value and errors to 0
`double`	`sec(double a)` Secant
`double`	`sech(double a)` Hyperbolic secant
`void`	`setErr(double error)` Set error
`void`	`setVal(double value)` Set value
`double`	`sign(double x)` Sign function
`ValueErr`	`sin(ValueErr a)` sine of an ValueErr number (trigonometric function)
`ValueErr`	`sinh(ValueErr a)` Hyperbolic sine of a value with error
`ValueErr`	`sqrt(ValueErr a)` Get square root value
`ValueErr`	`square()` Square
`double`	`square(double a)`
`ValueErr`	`square(ValueErr a)` Square
`ValueErr`	`tan(ValueErr a)` Tangent of a value with error
`ValueErr`	`tanh(ValueErr a)` Hyperbolic tangent of value with error
`ValueErr`	`times(double a)` Multiply this ValueErr number by a double.
`ValueErr`	`times(double a, double b)` Multiply a double number by a double and return product as ValueErr
`ValueErr`	`times(double a, ValueErr b)` Multiply a double by a ValueErr number
`ValueErr`	`times(ValueErr a)` Multiply this ValueErr number by a ValueErr number without correlation
`ValueErr`	`times(ValueErr a, double corrCoeff)` Multiply two ValueErr numbers with correlation
`ValueErr`	`times(ValueErr a, ValueErr b)` Multiply two ValueErr numbers without correlation
`ValueErr`	`times(ValueErr a, ValueErr b, double corrCoeff)` Multiply two ValueErr numbers with correlation
`void`	`timesEquals(double a)` Multiply this ValueErr number by a double and replace it by the product
`void`	`timesEquals(ValueErr a)` Multiply this ValueErr number by an ValueErr number and replace this by the product with no correlation
`void`	`timesEquals(ValueErr a, double corrCoeff)` Multiply this ValueErr number by an ValueErr number and replace this by the product with correlation
`java.lang.String`	`toString()` Convert to a string
`ValueErr[][]`	`twoDarray(int n, int m)` Create a two dimensional array of ValueErr objects of dimensions n and m with zeros
`ValueErr`	`zero()` Set value to zero

Methods inherited from class java.lang.Object
equals, getClass, notify, notifyAll, wait, wait, wait

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

toString
```
public java.lang.String toString()
```
Convert to a string

Overrides:

toString in class java.lang.Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class java.lang.Object

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 static ValueErr copy(ValueErr a)

Copy value

copy
```
public ValueErr copy()
```
Copy a single ValueErr

clone
```
public java.lang.Object clone()
```
Overrides:

clone in class java.lang.Object

copy
```
public ValueErr[] copy(ValueErr[] a)
```

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,
                     ValueErr b,
                     double corrCoeff)

Adding 2 values with correlation

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

plus

public ValueErr plus(ValueErr a,
                     ValueErr b)

Add two ValueErr numbers with no correlation

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(ValueErr a,
                      ValueErr b,
                      double corrCoeff)

Multiply two ValueErr numbers with correlation

times

public ValueErr times(ValueErr a,
                      ValueErr b)

Multiply two ValueErr numbers without correlation

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(ValueErr a,
                       ValueErr b)

Division of two ValueErr numbers a/b 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)
```

sqrt
```
public ValueErr sqrt(ValueErr a)
```
Get square root value

nRoot

public ValueErr nRoot(ValueErr a,
                      int n)

Take nth root from the value (n is above 1)

square
```
public ValueErr square()
```
Square

square
```
public ValueErr square(ValueErr a)
```
Square

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

pow

public ValueErr pow(ValueErr a,
                    ValueErr b)

ValueErr number raised to a ValueErr power with no correlation

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

cos
```
public ValueErr cos(ValueErr a)
```
Cosine of a value wth error

tan
```
public ValueErr tan(ValueErr a)
```
Tangent of a value with error

sec
```
public double sec(double a)
```
Secant

Parameters:

a -

Returns:

square
```
public double square(double a)
```

sinh
```
public ValueErr sinh(ValueErr a)
```
Hyperbolic sine of a value with error

cosh
```
public ValueErr cosh(ValueErr a)
```
Hyperbolic cosine

tanh
```
public ValueErr tanh(ValueErr a)
```
Hyperbolic tangent of value with error

sech
```
public double sech(double a)
```
Hyperbolic secant

asin
```
public ValueErr asin(ValueErr a)
```
Inverse sine of a value with error

acos
```
public ValueErr acos(ValueErr a)
```
Inverse cosine of a value with error

atan
```
public ValueErr atan(ValueErr a)
```
inverse tangent of a value

atan2

public ValueErr atan2(ValueErr a,
                      ValueErr b)

Inverse tangent (atan2) of a value without correlations

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)

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Class ValueErr

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ValueErr

ValueErr

ValueErr

Method Detail

setVal

setErr

reset

getVal

getErr

toString

hashCode

oneDarray

oneDarray

twoDarray

copy

copy

clone

copy

copy

minus

minus

minus

minus

minus

minus

minus

minusEquals

minusEquals

minusEquals

plus

plus

plus

plus

plus

plus

plus

plusEquals

plusEquals

plusEquals

times

times

times

times

times

times

times

timesEquals

timesEquals

timesEquals

divide

divide

divide

divide

divide

divide

divide

divideEqual

divideEqual

divideEqual

inverse

inverse

hypotenuse

hypotenuse

hypot

exp

log

log10

log10

sqrt

nRoot

square

square

pow

pow

pow