[#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
    : public /* implementation-defined */
----

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

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `/* implementation-defined */`
| 
|===

== Member Functions

[cols="1,4"]
|===
| 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`]  [.small]#[deprecated]#
| Deprecated accessor for the portable rendering; use `portable()` instead
| xref:mp_units/symbol_text-032/empty.adoc[`empty`] 
| Checks whether both the UTF‐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‐8 rendering; use `utf8()` instead
| xref:mp_units/symbol_text-032/utf8.adoc[`utf8`] 
| Returns the UTF‐8 rendering of the symbol
|===


== Data Members

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


== Deduction Guides

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


== Template Parameters

[cols="1,4"]
|===
| 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]#