[#Num3072]
= Num3072
:mrdocs:

A 3072‐bit number in the MuHash prime field, stored as an array of limbs.

== Synopsis

Declared in `<crypto/muhash.h>`

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

== Description

Num3072 holds the running numerator or denominator of a MuHash3072 set and provides the modular multiply, divide, and inverse operations used to combine set elements.

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:Num3072/double_limb_t.adoc[`double_limb_t`] 
| Unsigned integer type twice as wide as a limb, used for carries.
| xref:Num3072/limb_t.adoc[`limb_t`] 
| Unsigned integer type of a single limb.
| xref:Num3072/signed_double_limb_t.adoc[`signed_double_limb_t`] 
| Signed integer type twice as wide as a limb, used for carries.
| xref:Num3072/signed_limb_t.adoc[`signed_limb_t`] 
| Signed integer type of a single limb.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:Num3072/2constructor-08.adoc[`Num3072`]         [.small]#[constructor]#
| Constructors
| xref:Num3072/Divide.adoc[`Divide`] 
| Divide this number by another, modulo the MuHash prime.
| xref:Num3072/Multiply.adoc[`Multiply`] 
| Multiply this number by another, modulo the MuHash prime.
| xref:Num3072/SetToOne.adoc[`SetToOne`] 
| Set this number to the multiplicative identity (one).
| xref:Num3072/ToBytes.adoc[`ToBytes`] 
| Serialize this number into a fixed‐size byte buffer.
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:Num3072/limbs-02.adoc[`limbs`] 
| The limbs holding the little‐endian representation of the number.
|===


== Static Data Members

[cols="1,4"]
|===
| Name| Description
| xref:Num3072/BYTE_SIZE.adoc[`BYTE_SIZE`] 
| Size of the serialized number in bytes (3072 bits).
| xref:Num3072/LIMBS-06.adoc[`LIMBS`] 
| Number of unsigned limbs making up the 3072‐bit number.
| xref:Num3072/LIMB_SIZE.adoc[`LIMB_SIZE`] 
| Bit width of a single unsigned limb.
| xref:Num3072/SIGNED_LIMBS.adoc[`SIGNED_LIMBS`] 
| Number of signed limbs used by the intermediate representation.
| xref:Num3072/SIGNED_LIMB_SIZE.adoc[`SIGNED_LIMB_SIZE`] 
| Bit width of a single signed limb.
|===



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