|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.lang.Number
com.google.common.primitives.UnsignedInteger
@GwtCompatible(emulated=true) public final class UnsignedInteger
A wrapper class for unsigned int
values, supporting arithmetic operations.
In some cases, when speed is more important than code readability, it may be faster simply to
treat primitive int
values as unsigned, using the methods from UnsignedInts
.
See the Guava User Guide article on unsigned primitive utilities.
Field Summary | |
---|---|
static UnsignedInteger |
MAX_VALUE
|
static UnsignedInteger |
ONE
|
static UnsignedInteger |
ZERO
|
Method Summary | |
---|---|
UnsignedInteger |
add(UnsignedInteger val)
Deprecated. Use plus(UnsignedInteger) . This method is scheduled to be removed in Guava
release 15.0. |
static UnsignedInteger |
asUnsigned(int value)
Deprecated. Use fromIntBits(int) . This method is scheduled to be removed in Guava
release 15.0. |
java.math.BigInteger |
bigIntegerValue()
Returns the value of this UnsignedInteger as a BigInteger . |
int |
compareTo(UnsignedInteger other)
Compares this unsigned integer to another unsigned integer. |
UnsignedInteger |
divide(UnsignedInteger val)
Deprecated. Use dividedBy(UnsignedInteger) . This method is scheduled to be removed in
Guava release 15.0. |
UnsignedInteger |
dividedBy(UnsignedInteger val)
Returns the result of dividing this by val . |
double |
doubleValue()
Returns the value of this UnsignedInteger as a float , analogous to a widening
primitive conversion from int to double , and correctly rounded. |
boolean |
equals(java.lang.Object obj)
|
float |
floatValue()
Returns the value of this UnsignedInteger as a float , analogous to a widening
primitive conversion from int to float , and correctly rounded. |
static UnsignedInteger |
fromIntBits(int bits)
Returns an UnsignedInteger corresponding to a given bit representation. |
int |
hashCode()
|
int |
intValue()
Returns the value of this UnsignedInteger as an int . |
long |
longValue()
Returns the value of this UnsignedInteger as a long . |
UnsignedInteger |
minus(UnsignedInteger val)
Returns the result of subtracting this and val . |
UnsignedInteger |
mod(UnsignedInteger val)
Returns this mod val . |
UnsignedInteger |
multiply(UnsignedInteger val)
Deprecated. Use times(UnsignedInteger) . This method is scheduled to be removed in
Guava release 15.0. |
UnsignedInteger |
plus(UnsignedInteger val)
Returns the result of adding this and val . |
UnsignedInteger |
remainder(UnsignedInteger val)
Deprecated. Use mod(UnsignedInteger) . This method is scheduled to be removed in Guava
release 15.0. |
UnsignedInteger |
subtract(UnsignedInteger val)
Deprecated. Use minus(UnsignedInteger) . This method is scheduled to be removed in
Guava release 15.0. |
UnsignedInteger |
times(UnsignedInteger val)
Returns the result of multiplying this and val . |
java.lang.String |
toString()
Returns a string representation of the UnsignedInteger value, in base 10. |
java.lang.String |
toString(int radix)
Returns a string representation of the UnsignedInteger value, in base radix . |
static UnsignedInteger |
valueOf(java.math.BigInteger value)
Returns a UnsignedInteger representing the same value as the specified
BigInteger . |
static UnsignedInteger |
valueOf(long value)
Returns an UnsignedInteger that is equal to value ,
if possible. |
static UnsignedInteger |
valueOf(java.lang.String string)
Returns an UnsignedInteger holding the value of the specified String , parsed
as an unsigned int value. |
static UnsignedInteger |
valueOf(java.lang.String string,
int radix)
Returns an UnsignedInteger holding the value of the specified String , parsed
as an unsigned int value in the specified radix. |
Methods inherited from class java.lang.Number |
---|
byteValue, shortValue |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final UnsignedInteger ZERO
public static final UnsignedInteger ONE
public static final UnsignedInteger MAX_VALUE
Method Detail |
---|
@Deprecated @Beta public static UnsignedInteger asUnsigned(int value)
fromIntBits(int)
. This method is scheduled to be removed in Guava
release 15.0.
UnsignedInteger
that, when treated as signed, is
equal to value
.
public static UnsignedInteger fromIntBits(int bits)
UnsignedInteger
corresponding to a given bit representation.
The argument is interpreted as an unsigned 32-bit value. Specifically, the sign bit
of bits
is interpreted as a normal bit, and all other bits are treated as usual.
If the argument is nonnegative, the returned result will be equal to bits
,
otherwise, the result will be equal to 2^32 + bits
.
To represent unsigned decimal constants, consider valueOf(long)
instead.
public static UnsignedInteger valueOf(long value)
UnsignedInteger
that is equal to value
,
if possible. The inverse operation of longValue()
.
public static UnsignedInteger valueOf(java.math.BigInteger value)
UnsignedInteger
representing the same value as the specified
BigInteger
. This is the inverse operation of bigIntegerValue()
.
java.lang.IllegalArgumentException
- if value
is negative or value >= 2^32
public static UnsignedInteger valueOf(java.lang.String string)
UnsignedInteger
holding the value of the specified String
, parsed
as an unsigned int
value.
java.lang.NumberFormatException
- if the string does not contain a parsable unsigned int
valuepublic static UnsignedInteger valueOf(java.lang.String string, int radix)
UnsignedInteger
holding the value of the specified String
, parsed
as an unsigned int
value in the specified radix.
java.lang.NumberFormatException
- if the string does not contain a parsable unsigned int
value@Deprecated @Beta public UnsignedInteger add(UnsignedInteger val)
plus(UnsignedInteger)
. This method is scheduled to be removed in Guava
release 15.0.
val
. If the result would have more than 32 bits,
returns the low 32 bits of the result.
@CheckReturnValue public UnsignedInteger plus(UnsignedInteger val)
val
. If the result would have more than 32 bits,
returns the low 32 bits of the result.
@Deprecated @Beta public UnsignedInteger subtract(UnsignedInteger val)
minus(UnsignedInteger)
. This method is scheduled to be removed in
Guava release 15.0.
val
. If the result would be negative,
returns the low 32 bits of the result.
@CheckReturnValue public UnsignedInteger minus(UnsignedInteger val)
val
. If the result would be negative,
returns the low 32 bits of the result.
@Deprecated @Beta @GwtIncompatible(value="Does not truncate correctly") public UnsignedInteger multiply(UnsignedInteger val)
times(UnsignedInteger)
. This method is scheduled to be removed in
Guava release 15.0.
val
. If the result would have more than 32
bits, returns the low 32 bits of the result.
@CheckReturnValue @GwtIncompatible(value="Does not truncate correctly") public UnsignedInteger times(UnsignedInteger val)
val
. If the result would have more than 32
bits, returns the low 32 bits of the result.
@Deprecated @Beta public UnsignedInteger divide(UnsignedInteger val)
dividedBy(UnsignedInteger)
. This method is scheduled to be removed in
Guava release 15.0.
val
.
@CheckReturnValue public UnsignedInteger dividedBy(UnsignedInteger val)
val
.
java.lang.ArithmeticException
- if val
is zero@Deprecated @Beta public UnsignedInteger remainder(UnsignedInteger val)
mod(UnsignedInteger)
. This method is scheduled to be removed in Guava
release 15.0.
val
.
@CheckReturnValue public UnsignedInteger mod(UnsignedInteger val)
val
.
java.lang.ArithmeticException
- if val
is zeropublic int intValue()
UnsignedInteger
as an int
. This is an inverse
operation to fromIntBits(int)
.
Note that if this UnsignedInteger
holds a value >= 2^31
, the returned value
will be equal to this - 2^32
.
intValue
in class java.lang.Number
public long longValue()
UnsignedInteger
as a long
.
longValue
in class java.lang.Number
public float floatValue()
UnsignedInteger
as a float
, analogous to a widening
primitive conversion from int
to float
, and correctly rounded.
floatValue
in class java.lang.Number
public double doubleValue()
UnsignedInteger
as a float
, analogous to a widening
primitive conversion from int
to double
, and correctly rounded.
doubleValue
in class java.lang.Number
public java.math.BigInteger bigIntegerValue()
UnsignedInteger
as a BigInteger
.
public int compareTo(UnsignedInteger other)
0
if they are equal, a negative number if this < other
,
and a positive number if this > other
.
compareTo
in interface java.lang.Comparable<UnsignedInteger>
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(@Nullable java.lang.Object obj)
equals
in class java.lang.Object
public java.lang.String toString()
UnsignedInteger
value, in base 10.
toString
in class java.lang.Object
public java.lang.String toString(int radix)
UnsignedInteger
value, in base radix
.
If radix < Character.MIN_RADIX
or radix > Character.MAX_RADIX
, the radix
10
is used.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |