Checked (decimal4j API 1.0.7-SNAPSHOT)

java.lang.Object
- org.decimal4j.arithmetic.Checked

```
final class Checked
extends Object
```
Helper class for arithmetic operations with overflow checks.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static long`	`abs(DecimalArithmetic arith, long value)` Returns the absolute value `\|value\|` throwing an exception if an overflow occurs.
`static long`	`add(DecimalArithmetic arith, long uDecimal1, long uDecimal2)` Returns the sum `(uDecimal1 + uDecimal2)` of the two unsigned decimal values throwing an exception if an overflow occurs.
`static long`	`addLong(long long1, long long2)` Returns the sum `(long1 + long2)` of the two `long` values throwing an exception if an overflow occurs.
`static long`	`divideByLong(DecimalArithmetic arith, long uDecimalDividend, long lDivisor)` Returns the quotient `(uDecimalDividend / lDivisor)` of an unscaled decimal value and a `long` value throwing an exception if an overflow occurs.
`static long`	`divideLong(long lDividend, long lDivisor)` Returns the quotient `(lDividend / lDivisor)` of the two `long` values throwing an exception if an overflow occurs.
`(package private) static boolean`	`isAddOverflow(long long1, long long2, long result)` Returns true if the addition `long1 + long2 = result` has resulted in an overflow.
`(package private) static boolean`	`isDivideOverflow(long dividend, long divisor)` Returns true if the quotient `dividend / divisor` will result in an overflow.
`(package private) static boolean`	`isSubtractOverflow(long minuend, long subtrahend, long result)` Returns true if the subtraction `minuend - subtrahend = result` has resulted in an overflow.
`static long`	`multiplyByLong(DecimalArithmetic arith, long uDecimal, long lValue)` Returns the product `(uDecimal * lValue)` of an unsigned decimal value and a `long` value throwing an exception if an overflow occurs.
`static long`	`multiplyLong(long lValue1, long lValue2)` Returns the product `(lValue1 * lValue2)` of the two `long` values throwing an exception if an overflow occurs.
`static long`	`negate(DecimalArithmetic arith, long value)` Returns the negation `(-value)` throwing an exception if an overflow occurs.
`static long`	`subtract(DecimalArithmetic arith, long uDecimalMinuend, long uDecimalSubtrahend)` Returns the difference `(uDecimalMinuend - uDecimalSubtrahend)` of the two unscaled decimal values throwing an exception if an overflow occurs.
`static long`	`subtractLong(long lMinuend, long lSubtrahend)` Returns the difference `(lMinuend - lSubtrahend)` of the two `long` values throwing an exception if an overflow occurs.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - isAddOverflow
```
static final boolean isAddOverflow(long long1,
                                   long long2,
                                   long result)
```
    Returns true if the addition long1 + long2 = result has resulted in an overflow.
    
    Parameters:
    
    long1 - the first summand
    
    long2 - the second summand
    
    result - the sum
    
    Returns:
    
    true if the calculation resulted in an overflow
  - isSubtractOverflow
```
static final boolean isSubtractOverflow(long minuend,
                                        long subtrahend,
                                        long result)
```
    Returns true if the subtraction minuend - subtrahend = result has resulted in an overflow.
    
    Parameters:
    
    minuend - the minuend to subtract from
    
    subtrahend - the subtrahend to subtract
    
    result - the difference
    
    Returns:
    
    true if the calculation resulted in an overflow
  - isDivideOverflow
```
static final boolean isDivideOverflow(long dividend,
                                      long divisor)
```
    Returns true if the quotient dividend / divisor will result in an overflow.
    
    Parameters:
    
    dividend - the dividend
    
    divisor - the divisor
    
    Returns:
    
    true if the calculation will result in an overflow
  - addLong
```
public static final long addLong(long long1,
                                 long long2)
```
    Returns the sum (long1 + long2) of the two long values throwing an exception if an overflow occurs.
    
    Parameters:
    
    long1 - the first summand
    
    long2 - the second summand
    
    Returns:
    
    the sum of the two values
    
    Throws:
    
    ArithmeticException - if the calculation results in an overflow
  - add
```
public static final long add(DecimalArithmetic arith,
                             long uDecimal1,
                             long uDecimal2)
```
    Returns the sum (uDecimal1 + uDecimal2) of the two unsigned decimal values throwing an exception if an overflow occurs.
    
    Parameters:
    
    arith - the arithmetic associated with the two unsigned decimals
    
    uDecimal1 - the first summand
    
    uDecimal2 - the second summand
    
    Returns:
    
    the sum of the two values
    
    Throws:
    
    ArithmeticException - if the calculation results in an overflow
  - subtractLong
```
public static final long subtractLong(long lMinuend,
                                      long lSubtrahend)
```
    Returns the difference (lMinuend - lSubtrahend) of the two long values throwing an exception if an overflow occurs.
    
    Parameters:
    
    lMinuend - the minuend
    
    lSubtrahend - the subtrahend
    
    Returns:
    
    the difference of the two values
    
    Throws:
    
    ArithmeticException - if the calculation results in an overflow
  - subtract
```
public static final long subtract(DecimalArithmetic arith,
                                  long uDecimalMinuend,
                                  long uDecimalSubtrahend)
```
    Returns the difference (uDecimalMinuend - uDecimalSubtrahend) of the two unscaled decimal values throwing an exception if an overflow occurs.
    
    Parameters:
    
    arith - the arithmetic associated with the two unsigned decimals
    
    uDecimalMinuend - the minuend
    
    uDecimalSubtrahend - the subtrahend
    
    Returns:
    
    the difference of the two values
    
    Throws:
    
    ArithmeticException - if the calculation results in an overflow
  - multiplyLong
```
public static final long multiplyLong(long lValue1,
                                      long lValue2)
```
    Returns the product (lValue1 * lValue2) of the two long values throwing an exception if an overflow occurs.
    
    Parameters:
    
    lValue1 - the first factor
    
    lValue2 - the second factor
    
    Returns:
    
    the product of the two values
    
    Throws:
    
    ArithmeticException - if the calculation results in an overflow
  - multiplyByLong
```
public static final long multiplyByLong(DecimalArithmetic arith,
                                        long uDecimal,
                                        long lValue)
```
    Returns the product (uDecimal * lValue) of an unsigned decimal value and a long value throwing an exception if an overflow occurs.
    
    Parameters:
    
    arith - the arithmetic associated with the first unsigned decimal argument
    
    uDecimal - the first factor
    
    lValue - the second factor
    
    Returns:
    
    the product of the two values
    
    Throws:
    
    ArithmeticException - if the calculation results in an overflow
  - divideLong
```
public static final long divideLong(long lDividend,
                                    long lDivisor)
```
    Returns the quotient (lDividend / lDivisor) of the two long values throwing an exception if an overflow occurs.
    
    Parameters:
    
    lDividend - the dividend to divide
    
    lDivisor - the divisor to divide by
    
    Returns:
    
    the quotient of the two values
    
    Throws:
    
    ArithmeticException - if the calculation results in an overflow
  - divideByLong
```
public static final long divideByLong(DecimalArithmetic arith,
                                      long uDecimalDividend,
                                      long lDivisor)
```
    Returns the quotient (uDecimalDividend / lDivisor) of an unscaled decimal value and a long value throwing an exception if an overflow occurs.
    
    Parameters:
    
    arith - the arithmetic associated with the first unsigned decimal argument
    
    uDecimalDividend - the dividend to divide
    
    lDivisor - the divisor to divide by
    
    Returns:
    
    the quotient of the two values
    
    Throws:
    
    ArithmeticException - if the calculation results in an overflow
  - abs
```
public static final long abs(DecimalArithmetic arith,
                             long value)
```
    Returns the absolute value |value| throwing an exception if an overflow occurs.
    
    Parameters:
    
    arith - the arithmetic associated with the value
    
    value - the number whose absolute value to return
    
    Returns:
    
    the absolute of the specified value
    
    Throws:
    
    ArithmeticException - if the calculation results in an overflow
  - negate
```
public static final long negate(DecimalArithmetic arith,
                                long value)
```
    Returns the negation (-value) throwing an exception if an overflow occurs.
    
    Parameters:
    
    arith - the arithmetic associated with the value
    
    value - the number to negate
    
    Returns:
    
    the negation of the specified value
    
    Throws:
    
    ArithmeticException - if the calculation results in an overflow

Class Checked

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isAddOverflow

isSubtractOverflow

isDivideOverflow

addLong

add

subtractLong

subtract

multiplyLong

multiplyByLong

divideLong

divideByLong

abs

negate