org.decimal4j.arithmetic

Class Shift

java.lang.Object

org.decimal4j.arithmetic.Shift

final class Shift
extends Object

Provides methods for left and right shifts.

Method Summary

Modifier and Type	Method and Description
static long	shiftLeft(DecimalRounding rounding, long uDecimal, int positions) Performs a shift left operation applying the given rounding mode if rounding is necessary.
static long	shiftLeftChecked(DecimalArithmetic arith, DecimalRounding rounding, long uDecimal, int positions) Performs a shift left operation applying the given rounding mode if rounding is necessary.
static long	shiftRight(DecimalRounding rounding, long uDecimal, int positions) Performs a shift right operation applying the given rounding mode if rounding is necessary.
static long	shiftRightChecked(DecimalArithmetic arith, DecimalRounding rounding, long uDecimal, int positions) Performs a shift right operation applying the given rounding mode if rounding is necessary.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

shiftLeft

public static final long shiftLeft(DecimalRounding rounding,
                                   long uDecimal,
                                   int positions)

Performs a shift left operation applying the given rounding mode if rounding is necessary. Overflows are siltently truncated.

Parameters:

rounding - the rounding to apply for negative position (i.e. a right shift)

uDecimal - the value to shift

positions - the positions to shift

Returns:

round(uDecimal << positions)

shiftRight

public static final long shiftRight(DecimalRounding rounding,
                                    long uDecimal,
                                    int positions)

Performs a shift right operation applying the given rounding mode if rounding is necessary. Overflows are siltently truncated.

Parameters:

rounding - the rounding to apply if necessary

uDecimal - the value to shift

positions - the positions to shift

Returns:

round(uDecimal >> positions)

shiftLeftChecked

public static final long shiftLeftChecked(DecimalArithmetic arith,
                                          DecimalRounding rounding,
                                          long uDecimal,
                                          int positions)

Performs a shift left operation applying the given rounding mode if rounding is necessary. Throws an exception if an overflow occurs.

Parameters:

arith - the arithmetic associated with the shifted value

rounding - the rounding to apply for negative position (i.e. a right shift)

uDecimal - the value to shift

positions - the positions to shift

Returns:

round(uDecimal << positions)

Throws:

ArithmeticException - if an overflow occurs and the arithmetic's OverflowMode is set to throw an exception

shiftRightChecked

public static final long shiftRightChecked(DecimalArithmetic arith,
                                           DecimalRounding rounding,
                                           long uDecimal,
                                           int positions)

Performs a shift right operation applying the given rounding mode if rounding is necessary. Throws an exception if an overflow occurs.

Parameters:

arith - the arithmetic associated with the shifted value

rounding - the rounding to apply if necessary

uDecimal - the value to shift

positions - the positions to shift

Returns:

round(uDecimal >> positions)

Throws:

ArithmeticException - if an overflow occurs and the arithmetic's OverflowMode is set to throw an exception