[#mp_units-dimension_symbol_to]
= xref:mp_units.adoc[mp&lowbar;units]::dimension&lowbar;symbol&lowbar;to
:relfileprefix: ../
:mrdocs:

Writes the textual symbol of a dimension to an output iterator&period;

== Synopsis

Declared in `&lt;mp&hyphen;units&sol;framework&sol;dimension&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;
    typename CharT = char,
    std::output&lowbar;iterator&lt;CharT&gt; Out,
    xref:mp_units/Dimension.adoc[Dimension] D&gt;
constexpr
Out
dimension&lowbar;symbol&lowbar;to(
    Out out,
    D d,
    xref:mp_units/dimension_symbol_formatting.adoc[dimension&lowbar;symbol&lowbar;formatting] const& fmt = dimension&lowbar;symbol&lowbar;formatting&lcub;&rcub;);
----

== Return Value

an iterator past the last written character

== Template Parameters

[cols="1,4"]
|===
| Name| Description
| *CharT*
| the character type of the output symbol
|===

== Parameters

[cols="1,4"]
|===
| Name| Description
| *out*
| the output iterator to write to
| *d*
| the dimension to render
| *fmt*
| the formatting options to use
|===


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