[#BloombergLP-bslmf-FloatingTypeStructuralTraits-01]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslmf.adoc[bslmf]::xref:BloombergLP/bslmf/FloatingTypeStructuralTraits-03.adoc[FloatingTypeStructuralTraits]<float>
:relfileprefix: ../../
:mrdocs:

This is the full specialization of `bslmf::FloatingTypeStructuralTraits` for the `float` type. See the individual members for documentation.

== Synopsis

Declared in `<bslmf_floatingtypestructuraltraits.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<>
struct xref:BloombergLP/bslmf/FloatingTypeStructuralTraits-03.adoc[FloatingTypeStructuralTraits]<float>;
----

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslmf/FloatingTypeStructuralTraits-01/FloatType.adoc[`FloatType`] 
| Alias for the floating‐point type described by this specialization.
| xref:BloombergLP/bslmf/FloatingTypeStructuralTraits-01/UintType.adoc[`UintType`] 
| Alias for the size‐equivalent unsigned integer type.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslmf/FloatingTypeStructuralTraits-01/adjustMantissaForHexDigits.adoc[`adjustMantissaForHexDigits`] 
| Adjust the specified `ieeeMantissa` bits for hexfloat conversion. This method is needed because `float` needs adjustment and `double` doesn't.
| xref:BloombergLP/bslmf/FloatingTypeStructuralTraits-01/toFloatType.adoc[`toFloatType`] 
| Converts the bits of the specified size‐equivalent unsigned integer `uIntValue` into the "original" floating point type.
| xref:BloombergLP/bslmf/FloatingTypeStructuralTraits-01/toUintType.adoc[`toUintType`] 
| Converts the bits of the specified floating point `value` into the size‐equivalent unsigned integer type.
|===


== Static Data Members

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslmf/FloatingTypeStructuralTraits-01/k_DENORM_MANTISSA_MASK.adoc[`k_DENORM_MANTISSA_MASK`] 
| Mask for the fraction bits of a subnormal value (no leading bit).
| xref:BloombergLP/bslmf/FloatingTypeStructuralTraits-01/k_EXPONENT_BIAS.adoc[`k_EXPONENT_BIAS`] 
| Bias added to the true exponent in the encoded exponent field.
| xref:BloombergLP/bslmf/FloatingTypeStructuralTraits-01/k_EXPONENT_BITS.adoc[`k_EXPONENT_BITS`] 
| Number of bits in the IEEE‐754 exponent field.
| xref:BloombergLP/bslmf/FloatingTypeStructuralTraits-01/k_EXPONENT_MASK.adoc[`k_EXPONENT_MASK`] 
| Mask for the unshifted exponent field bits.
| xref:BloombergLP/bslmf/FloatingTypeStructuralTraits-01/k_EXPONENT_SHIFT.adoc[`k_EXPONENT_SHIFT`] 
| Bit offset of the exponent field within the integer representation.
| xref:BloombergLP/bslmf/FloatingTypeStructuralTraits-01/k_GENERAL_MAX_OUTPUT_LENGTH.adoc[`k_GENERAL_MAX_OUTPUT_LENGTH`] 
| Maximum required buffer size for `std::to_chars_format::general` with the maximum precision.
| xref:BloombergLP/bslmf/FloatingTypeStructuralTraits-01/k_MANTISSA_BITS.adoc[`k_MANTISSA_BITS`] 
| Number of significand bits including the implicit leading bit.
| xref:BloombergLP/bslmf/FloatingTypeStructuralTraits-01/k_MANTISSA_HEX_DIGITS.adoc[`k_MANTISSA_HEX_DIGITS`] 
| The hex digits needed to represent the mantissa in a hexfloat.
| xref:BloombergLP/bslmf/FloatingTypeStructuralTraits-01/k_MAX_BINARY_EXPONENT.adoc[`k_MAX_BINARY_EXPONENT`] 
| Maximum unbiased binary exponent for a finite normal value.
| xref:BloombergLP/bslmf/FloatingTypeStructuralTraits-01/k_MAX_FIXED_PRECISION.adoc[`k_MAX_FIXED_PRECISION`] 
| The maximum meaningful precision for `std::to_chars_format::fixed`.
| xref:BloombergLP/bslmf/FloatingTypeStructuralTraits-01/k_MAX_SCIENTIFIC_PRECISION.adoc[`k_MAX_SCIENTIFIC_PRECISION`] 
| Maximum meaningful precision for `std::to_chars_format::scientific`.
| xref:BloombergLP/bslmf/FloatingTypeStructuralTraits-01/k_MAX_VALUE.adoc[`k_MAX_VALUE`] 
| Largest finite `float` value (`FLT_MAX`).
| xref:BloombergLP/bslmf/FloatingTypeStructuralTraits-01/k_MIN_BINARY_EXPONENT.adoc[`k_MIN_BINARY_EXPONENT`] 
| Minimum unbiased binary exponent for a finite normal value.
| xref:BloombergLP/bslmf/FloatingTypeStructuralTraits-01/k_MIN_VALUE.adoc[`k_MIN_VALUE`] 
| Smallest positive normalized `float` value (`FLT_MIN`).
| xref:BloombergLP/bslmf/FloatingTypeStructuralTraits-01/k_NORMAL_MANTISSA_MASK.adoc[`k_NORMAL_MANTISSA_MASK`] 
| Mask for the significand of a normal value, including the leading bit.
| xref:BloombergLP/bslmf/FloatingTypeStructuralTraits-01/k_SHIFTED_EXPONENT_MASK.adoc[`k_SHIFTED_EXPONENT_MASK`] 
| Mask for the exponent field in its natural position in the representation.
| xref:BloombergLP/bslmf/FloatingTypeStructuralTraits-01/k_SHIFTED_SIGN_MASK.adoc[`k_SHIFTED_SIGN_MASK`] 
| Mask for the sign bit in its natural position in the representation.
| xref:BloombergLP/bslmf/FloatingTypeStructuralTraits-01/k_SIGN_SHIFT.adoc[`k_SIGN_SHIFT`] 
| Bit offset of the sign bit within the integer representation.
| xref:BloombergLP/bslmf/FloatingTypeStructuralTraits-01/k_SPEC_NAN_MANTISSA_MASK.adoc[`k_SPEC_NAN_MANTISSA_MASK`] 
| Mask selecting the quiet‐NaN indicator bit in the mantissa.
|===



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