Class UInt128
java.lang.Object
org.apache.commons.statistics.descriptive.UInt128
A mutable 128-bit unsigned integer.
This is a specialised class to implement an accumulator of long
values
generated by squaring int
values.
- Since:
- 1.1
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription(package private) void
Adds the value in-place.(package private) void
addPositive
(long x) Adds the value in place.(package private) static UInt128
create()
Create an instance.(package private) long
hi64()
Return the higher 64-bits as along
value.(package private) int
lo32()
Return the low 32-bits as anint
value.(package private) long
lo64()
Return the lower 64-bits as along
value.(package private) int
mid32()
Return the middle 32-bits as anint
value.(package private) static UInt128
Create an instance of theUInt96
value.(package private) UInt128
Subtracts the value.(package private) BigInteger
Convert to a BigInteger.(package private) double
toDouble()
Convert to adouble
.(package private) int
Convert to anint
; throwing an exception if the value overflows anint
.(package private) long
Convert to along
; throwing an exception if the value overflows along
.(package private) UInt128
unsignedMultiply
(int x) Multiply by the unsigned value.
-
Field Details
-
MASK32
private static final long MASK32Mask for the lower 32-bits of a long.- See Also:
-
d
private int dbits 32-1 (low 32-bits). -
c
private int cbits 64-33. -
ab
private long abbits 128-65.
-
-
Constructor Details
-
UInt128
private UInt128()Create an instance. -
UInt128
private UInt128(long hi, int mid, int lo) Create an instance using a direct binary representation.- Parameters:
hi
- High 64-bits.mid
- Middle 32-bits.lo
- Low 32-bits.
-
UInt128
UInt128(long hi, long lo) Create an instance using a direct binary representation. This is package-private for testing.- Parameters:
hi
- High 64-bits.lo
- Low 64-bits.
-
-
Method Details
-
create
Create an instance. The initial value is zero.- Returns:
- the instance
-
of
Create an instance of theUInt96
value.- Parameters:
x
- Value.- Returns:
- the instance
-
addPositive
void addPositive(long x) Adds the value in place. It is assumed to be positive, for example the square of anint
value. However no check is performed for a negative value.Note: This addition handles -9223372036854775808L as an unsigned value of 2^63.
- Parameters:
x
- Value.
-
add
Adds the value in-place.- Parameters:
x
- Value.
-
unsignedMultiply
Multiply by the unsigned value. Any overflow bits are lost.- Parameters:
x
- Value.- Returns:
- the product
-
subtract
Subtracts the value. Any overflow bits (negative result) are lost.- Parameters:
x
- Value.- Returns:
- the difference
-
toBigInteger
BigInteger toBigInteger()Convert to a BigInteger.- Returns:
- the value
-
toDouble
double toDouble()Convert to adouble
.- Returns:
- the value
-
toIntExact
int toIntExact()Convert to anint
; throwing an exception if the value overflows anint
.- Returns:
- the value
- Throws:
ArithmeticException
- if the value overflows anint
.- See Also:
-
toLongExact
long toLongExact()Convert to along
; throwing an exception if the value overflows along
.- Returns:
- the value
- Throws:
ArithmeticException
- if the value overflows along
.
-
lo64
long lo64()Return the lower 64-bits as along
value.- Returns:
- bits 64-1
-
lo32
int lo32()Return the low 32-bits as anint
value.- Returns:
- bits 32-1
-
mid32
int mid32()Return the middle 32-bits as anint
value.- Returns:
- bits 64-33
-
hi64
long hi64()Return the higher 64-bits as along
value.- Returns:
- bits 128-65
-