[#mp_units-symbol_text-032]
= xref:mp_units.adoc[mp_units]::symbol_text
:relfileprefix: ../
:mrdocs:

A symbol text representation

== Synopsis

Declared in `<mp‐units/framework/symbol_text.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    std::size_t N,
    std::size_t M>
class symbol_text;
----

== Member Functions

[cols=2]
|===
| Name
| Description
| xref:mp_units/symbol_text-032/2constructor-01.adoc[`symbol_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_`] 
| xref:mp_units/symbol_text-032/utf8_.adoc[`utf8_`] 
|===

== Friends

[cols=2]
|===
| Name
| Description
| `xref:mp_units/operator_eq-0a.adoc[mp_units::operator==]`
| Equality operator
| `xref:mp_units/operator_3way-0b.adoc[mp_units::operator<=>]`
| Three‐way comparison operator
| `xref:mp_units/operator_plus-0e1.adoc[mp_units::operator+]`
| Addition operator
|===

== Description

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

== Template Parameters

[cols=2]
|===
| Name
| Description
| *N*
| The size of a UTF‐8 symbol
| *M*
| The size of the portable symbol
|===


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