[#llvm-DynamicAPInt]
= xref:llvm.adoc[llvm]::DynamicAPInt
:relfileprefix: ../
:mrdocs:

Dynamically sized arbitrary‐precision integer.

== Synopsis

Declared in `<llvm/ADT/DynamicAPInt.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class DynamicAPInt { /* see-below */ };
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/DynamicAPInt/divByPositive.adoc[`divByPositive`] 
| Divides by a divisor known to be positive.
| xref:llvm/DynamicAPInt/divByPositiveInPlace.adoc[`divByPositiveInPlace`] 
| Divides by a positive divisor in place.
| xref:llvm/DynamicAPInt/operator_mod.adoc[`operator%`] 
| Returns the remainder of this value divided by `O.`
| xref:llvm/DynamicAPInt/operator_mod_eq.adoc[`operator%=`] 
| Stores the remainder of this value divided by `O.`
| xref:llvm/DynamicAPInt/operator_star.adoc[`operator*`] 
| Returns the product of this value and `O.`
| xref:llvm/DynamicAPInt/operator_star_eq.adoc[`operator*=`] 
| Multiplies this value by `O` in place.
| xref:llvm/DynamicAPInt/operator_plus.adoc[`operator+`] 
| Returns the sum of this value and `O.`
| xref:llvm/DynamicAPInt/operator_inc.adoc[`operator++`] 
| Pre‐increments this value by one.
| xref:llvm/DynamicAPInt/operator_plus_eq.adoc[`operator+=`] 
| Adds `O` to this value in place.
| xref:llvm/DynamicAPInt/operator_minus-00.adoc[`operator‐`] 
| Unary minus operators
| xref:llvm/DynamicAPInt/operator_dec.adoc[`operator‐‐`] 
| Pre‐decrements this value by one.
| xref:llvm/DynamicAPInt/operator_minus_eq.adoc[`operator‐=`] 
| Subtracts `O` from this value in place.
| xref:llvm/DynamicAPInt/operator_slash.adoc[`operator/`] 
| Divides by `O` using signed truncating division.
| xref:llvm/DynamicAPInt/operator_slash_eq.adoc[`operator/=`] 
| Divides this value by `O` in place.
| xref:llvm/DynamicAPInt/operator_eq.adoc[`operator==`] 
| Returns true if the value is equal to `O.`
| xref:llvm/DynamicAPInt/operator_not_eq.adoc[`operator!=`] 
| Returns true if the value is not equal to `O.`
| xref:llvm/DynamicAPInt/operator_lt.adoc[`operator<`] 
| Returns true if the value is less than `O.`
| xref:llvm/DynamicAPInt/operator_le.adoc[`operator<=`] 
| Returns true if the value is less than or equal to `O.`
| xref:llvm/DynamicAPInt/operator_gt.adoc[`operator>`] 
| Returns true if the value is greater than `O.`
| xref:llvm/DynamicAPInt/operator_ge.adoc[`operator>=`] 
| Returns true if the value is greater than or equal to `O.`
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:llvm/hash_value-08d.adoc[llvm::hash_value]`
| Computes a hash code for `x.`
| `xref:llvm/operator_mod-09.adoc[llvm::operator%]`
| Returns the remainder of `A` divided by `B.`
| `xref:llvm/operator_slash-014.adoc[llvm::operator/]`
| Returns `A` divided by `B.`
| `xref:llvm/operator_star-0d.adoc[llvm::operator*]`
| Returns `A` multiplied by `B.`
| `xref:llvm/operator_minus-01.adoc[llvm::operator‐]`
| Returns `A` minus `B.`
| `xref:llvm/operator_plus-090.adoc[llvm::operator+]`
| Returns `A` plus `B.`
| `xref:llvm/operator_ge-0ed.adoc[llvm::operator>=]`
| Returns true if `A` is greater than or equal to `B.`
| `xref:llvm/operator_le-04.adoc[llvm::operator<=]`
| Returns true if `A` is less than or equal to `B.`
| `xref:llvm/operator_lt-04d.adoc[llvm::operator<]`
| Returns true if `A` is less than `B.`
| `xref:llvm/operator_gt-02f.adoc[llvm::operator>]`
| Returns true if `A` is greater than `B.`
| `xref:llvm/operator_not_eq-026.adoc[llvm::operator!=]`
| Returns true if `A` is not equal to `B.`
| `xref:llvm/operator_eq-0da6.adoc[llvm::operator==]`
| Returns true if `A` is equal to `B.`
| `xref:llvm/operator_mod-0b.adoc[llvm::operator%]`
| Returns the remainder of `A` divided by `B.`
| `xref:llvm/operator_slash-00.adoc[llvm::operator/]`
| Returns `A` divided by `B.`
| `xref:llvm/operator_star-094.adoc[llvm::operator*]`
| Returns `A` multiplied by `B.`
| `xref:llvm/operator_minus-0d2.adoc[llvm::operator‐]`
| Returns `A` minus `B.`
| `xref:llvm/operator_plus-0e5.adoc[llvm::operator+]`
| Returns `A` plus `B.`
| `xref:llvm/operator_ge-078.adoc[llvm::operator>=]`
| Returns true if `A` is greater than or equal to `B.`
| `xref:llvm/operator_le-0029.adoc[llvm::operator<=]`
| Returns true if `A` is less than or equal to `B.`
| `xref:llvm/operator_lt-0a5.adoc[llvm::operator<]`
| Returns true if `A` is less than `B.`
| `xref:llvm/operator_gt-0d.adoc[llvm::operator>]`
| Returns true if `A` is greater than `B.`
| `xref:llvm/operator_not_eq-0ef.adoc[llvm::operator!=]`
| Returns true if `A` is not equal to `B.`
| `xref:llvm/operator_eq-0ea.adoc[llvm::operator==]`
| Returns true if `A` is equal to `B.`
| `xref:llvm/operator_mod_eq.adoc[llvm::operator%=]`
| Stores the remainder of `A` divided by `B` in `A.`
| `xref:llvm/operator_slash_eq.adoc[llvm::operator/=]`
| Divides `A` by `B` in place.
| `xref:llvm/operator_star_eq.adoc[llvm::operator*=]`
| Multiplies `A` by `B` in place.
| `xref:llvm/operator_minus_eq.adoc[llvm::operator‐=]`
| Subtracts `B` from `A` in place.
| `xref:llvm/operator_plus_eq-04.adoc[llvm::operator+=]`
| Adds `B` to `A` in place.
| `xref:llvm/mod-00.adoc[llvm::mod]`
| Returns the remainder of `LHS` divided by `RHS.`
| `xref:llvm/lcm.adoc[llvm::lcm]`
| Returns the least common multiple of `A` and `B.`
| `xref:llvm/gcd.adoc[llvm::gcd]`
| Returns the greatest common divisor of `A` and `B.`
| `xref:llvm/floorDiv.adoc[llvm::floorDiv]`
| Returns the floor of `LHS` divided by `RHS.`
| `xref:llvm/ceilDiv.adoc[llvm::ceilDiv]`
| Returns the ceiling of `LHS` divided by `RHS.`
| `xref:llvm/abs-09.adoc[llvm::abs]`
| Returns the absolute value of `X.`
|===


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