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

The `[[assume(expression)]]` attribute (C++23).

== Synopsis

Declared in `<mrdocs/Metadata/Attribute/AssumeAttribute.hpp>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
struct AssumeAttribute final
    : xref:mrdocs/AttributeCommonBase-01.adoc[AttributeCommonBase<AttributeKind::Assume>]
----

== Description

States that the expression always evaluates to true at this point.

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `xref:mrdocs/AttributeCommonBase-01.adoc[AttributeCommonBase<AttributeKind::Assume>]`
| CRTP base that ties a concrete attribute to a fixed AttributeKind.
|===

== Static Member Functions

[cols="1"]
|===
| Name
| xref:mrdocs/AssumeAttribute/isAssume.adoc[`isAssume`] 
| xref:mrdocs/AssumeAttribute/isCarriesDependency.adoc[`isCarriesDependency`] 
| xref:mrdocs/AssumeAttribute/isDeprecated.adoc[`isDeprecated`] 
| xref:mrdocs/AssumeAttribute/isFallthrough.adoc[`isFallthrough`] 
| xref:mrdocs/AssumeAttribute/isIndeterminate.adoc[`isIndeterminate`] 
| xref:mrdocs/AssumeAttribute/isLikely.adoc[`isLikely`] 
| xref:mrdocs/AssumeAttribute/isMaybeUnused.adoc[`isMaybeUnused`] 
| xref:mrdocs/AssumeAttribute/isNoUniqueAddress.adoc[`isNoUniqueAddress`] 
| xref:mrdocs/AssumeAttribute/isNodiscard.adoc[`isNodiscard`] 
| xref:mrdocs/AssumeAttribute/isNoreturn.adoc[`isNoreturn`] 
| xref:mrdocs/AssumeAttribute/isOther.adoc[`isOther`] 
| xref:mrdocs/AssumeAttribute/isUnlikely.adoc[`isUnlikely`] 
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/AssumeAttribute/Expression.adoc[`Expression`] 
| The assumed expression, as written.
|===


== Static Data Members

[cols="1"]
|===
| Name
| xref:mrdocs/AssumeAttribute/kind_id.adoc[`kind_id`] 
|===



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