[#mp_units-symbol_text-032]
= xref:mp_units.adoc[mp&lowbar;units]::symbol&lowbar;text
:relfileprefix: ../
:mrdocs:

A symbol text representation

== Synopsis

Declared in `&lt;mp&hyphen;units&sol;framework&sol;symbol&lowbar;text&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;
    std::size&lowbar;t N,
    std::size&lowbar;t M&gt;
class symbol&lowbar;text
    : public &sol;&ast; implementation-defined &ast;&sol;
----

== Description

This class template is responsible for definition and handling of a symbol text representation&period; In the libary it is used to define symbols of units and prefixes&period; Each symbol can have two versions&colon; UTF&hyphen;8 and portable&period;

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `&sol;&ast; implementation-defined &ast;&sol;`
| 
|===

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:mp_units/symbol_text-032/2constructor-01.adoc[`symbol&lowbar;text`]         [.small]#[constructor]#
| Constructors
| xref:mp_units/symbol_text-032/ascii.adoc[`ascii`]  [.small]#[deprecated]#
| Deprecated accessor for the portable rendering&semi; use `portable()` instead
| xref:mp_units/symbol_text-032/empty.adoc[`empty`] 
| Checks whether both the UTF&hyphen;8 and the portable renderings of the symbol are empty
| xref:mp_units/symbol_text-032/portable.adoc[`portable`] 
| Returns the portable rendering of the symbol
| xref:mp_units/symbol_text-032/unicode.adoc[`unicode`]  [.small]#[deprecated]#
| Deprecated accessor for the UTF&hyphen;8 rendering&semi; use `utf8()` instead
| xref:mp_units/symbol_text-032/utf8.adoc[`utf8`] 
| Returns the UTF&hyphen;8 rendering of the symbol
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:mp_units/symbol_text-032/portable_.adoc[`portable&lowbar;`] 
| The portable (basic literal character set) rendering of the symbol
| xref:mp_units/symbol_text-032/utf8_.adoc[`utf8&lowbar;`] 
| The UTF&hyphen;8 rendering of the symbol
|===


== Deduction Guides

[cols="1,4"]
|===
| Name| Description
| xref:mp_units/symbol_text-06.adoc[`symbol&lowbar;text&lt;1, 1&gt;`] 
| Deduction guide for a `symbol&lowbar;text` constructed from a single character
| xref:mp_units/symbol_text-0f.adoc[`symbol&lowbar;text&lt;N, M&gt;`] 
| Deduction guide for a `symbol&lowbar;text` constructed from separate UTF&hyphen;8 and portable fixed strings
| xref:mp_units/symbol_text-07.adoc[`symbol&lowbar;text&lt;N, N&gt;`] 
| Deduction guide for a `symbol&lowbar;text` constructed from a fixed string
| xref:mp_units/symbol_text-01.adoc[`symbol&lowbar;text&lt;N &hyphen; 1, M &hyphen; 1&gt;`] 
| Deduction guide for a `symbol&lowbar;text` constructed from separate UTF&hyphen;8 and portable string literals
| xref:mp_units/symbol_text-03f.adoc[`symbol&lowbar;text&lt;N &hyphen; 1, N &hyphen; 1&gt;`] 
| Deduction guide for a `symbol&lowbar;text` constructed from a narrow string literal
|===


== Template Parameters

[cols="1,4"]
|===
| Name| Description
| *N*
| The size of a UTF&hyphen;8 symbol
| *M*
| The size of the portable symbol
|===


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