[#BloombergLP-bdldfp-Uint128]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdldfp.adoc[bdldfp]::Uint128
:relfileprefix: ../../
:mrdocs:

This value‐semantic type represents a 128‐bit integer, with host machine byte order.

== Synopsis

Declared in `<bdldfp_uint128.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class Uint128;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdldfp/Uint128/2constructor-092.adoc[`Uint128`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdldfp/Uint128/high.adoc[`high`] 
| Return the high order bits of this integer.
| xref:BloombergLP/bdldfp/Uint128/low.adoc[`low`] 
| Return the low order bits of this integer.
| xref:BloombergLP/bdldfp/Uint128/operator_and_eq.adoc[`operator&=`] 
| Set the value of this object to the value of a the bitwise and between this 128 bit integer and the specified `rhs` value, and return a reference providing mofifiable access to this object.
| xref:BloombergLP/bdldfp/Uint128/operator_lshift_eq.adoc[`operator<<=`] 
| Set the value of this object to the value of a bitwise left shift of this 128 bit integer shifted by the specified `rhs` value, and return a reference providing mofifiable access to this object. The behavior is undefined unless `0 <= rhs < 128`.
| xref:BloombergLP/bdldfp/Uint128/operator_rshift_eq.adoc[`operator>>=`] 
| Set the value of this object to the value of a bitwise right shift of this 128 bit integer shifted by the specified `rhs` value, and return a reference providing mofifiable access to this object. The behavior is undefined unless `0 <= rhs < 128`.
| xref:BloombergLP/bdldfp/Uint128/operator_xor_eq.adoc[`operatorˆ=`] 
| Set the value of this object to the value of a the bitwise xor between this 128 bit integer and the specified `rhs` value, and return a reference providing mofifiable access to this object.
| xref:BloombergLP/bdldfp/Uint128/operator_or_eq.adoc[`operator|=`] 
| Set the value of this object to the value of a the bitwise or between this 128 bit integer and the specified `rhs` value, and return a reference providing mofifiable access to this object.
| xref:BloombergLP/bdldfp/Uint128/setHigh.adoc[`setHigh`] 
| Set the high order bits of this integer to the specified `value`.
| xref:BloombergLP/bdldfp/Uint128/setLow.adoc[`setLow`] 
| Set the low order bits of this integer to the specified `value`.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdldfp/operator_not_eq-05.adoc[`operator!=`]
| Return `true` if the specified `lhs` and the specified `rhs` objects do not have the same value, and `false` otherwise. Two `Uint128` objects do not have the same value if either of their `low` and `high` attributes are not the same.
| xref:BloombergLP/bdldfp/operator_bitand.adoc[`operator&`]
| Return an Uint128 object having the value of a the bitwise and between the specified `lhs` and the specified `rhs` value.
| xref:BloombergLP/bdldfp/operator_lshift-0e.adoc[`operator<<`]
| Return an `Uint128` value equal to the value of a bitwise left shift of the specified `lhs` 128‐bit integer shifted by the specified `rhs` value. The behavior is undefined unless `0 <= rhs < 128`.
| xref:BloombergLP/bdldfp/operator_eq-05.adoc[`operator==`]
| Return `true` if the specified `lhs` and the specified `rhs` objects have the same value, and `false` otherwise. Two `Uint128` objects have the same value if both of their `low` and `high` attributes are the same.
| xref:BloombergLP/bdldfp/operator_rshift-04.adoc[`operator>>`]
| Return an `Uint128` value equal to the value of a bitwise right shift of the specified `lhs` 128‐bit integer shifted by the specified `rhs` value. The behavior is undefined unless `0 <= rhs < 128`.
| xref:BloombergLP/bdldfp/operator_xor.adoc[`operatorˆ`]
| Return an Uint128 object having the value of a the bitwise xor between the specified `lhs` and the specified `rhs` value.
| xref:BloombergLP/bdldfp/operator_bitor.adoc[`operator|`]
| Return an Uint128 object having the value of a the bitwise or between the specified `lhs` and the specified `rhs` value.
| xref:BloombergLP/bdldfp/operator_bitnot.adoc[`operator~`]
| Return an `Uint128` value equal to the bitwise ones compliment of the specified `value`.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#