[#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;
----

== Member Functions

[cols=2]
|===
| 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`] 
| 
| xref:mp_units/symbol_text-032/empty.adoc[`empty`] 
| 
| xref:mp_units/symbol_text-032/portable.adoc[`portable`] 
| 
| xref:mp_units/symbol_text-032/unicode.adoc[`unicode`] 
| 
| xref:mp_units/symbol_text-032/utf8.adoc[`utf8`] 
| 
|===

== Data Members

[cols=1]
|===
| Name
| xref:mp_units/symbol_text-032/portable_.adoc[`portable&lowbar;`] 
| xref:mp_units/symbol_text-032/utf8_.adoc[`utf8&lowbar;`] 
|===

== Friends

[cols=2]
|===
| Name
| Description
| `xref:mp_units/operator_eq-0a.adoc[mp&lowbar;units::operator&equals;&equals;]`
| Equality operator
| `xref:mp_units/operator_3way-0b.adoc[mp&lowbar;units::operator&lt;&equals;&gt;]`
| Three&hyphen;way comparison operator
| `xref:mp_units/operator_plus-0e1.adoc[mp&lowbar;units::operator&plus;]`
| Addition operator
|===

== 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;

== Template Parameters

[cols=2]
|===
| 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]#
