2009-08-17 23:36:52 +00:00
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" xml:lang = "en" lang = "en" >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" / >
2010-08-09 20:07:24 +00:00
< meta name = "generator" content = "Docutils 0.7: http://docutils.sourceforge.net/" / >
2009-08-17 23:36:52 +00:00
< title > The MPL Reference Manual: string< / title >
< link rel = "stylesheet" href = "../style.css" type = "text/css" / >
< / head >
< body class = "docframe refmanual" >
< table class = "header" > < tr class = "header" > < td class = "header-group navigation-bar" > < span class = "navigation-group" > < a href = "./set-c.html" class = "navigation-link" > Prev< / a > < a href = "./views.html" class = "navigation-link" > Next< / a > < / span > < span class = "navigation-group-separator" > | < / span > < span class = "navigation-group" > < a href = "./set-c.html" class = "navigation-link" > Back< / a > Along< / span > < span class = "navigation-group-separator" > | < / span > < span class = "navigation-group" > < a href = "./classes.html" class = "navigation-link" > Up< / a > < a href = "../refmanual.html" class = "navigation-link" > Home< / a > < / span > < span class = "navigation-group-separator" > | < / span > < span class = "navigation-group" > < a href = "./refmanual_toc.html" class = "navigation-link" > Full TOC< / a > < / span > < / td >
< td class = "header-group page-location" > < a href = "../refmanual.html" class = "navigation-link" > Front Page< / a > / < a href = "./sequences.html" class = "navigation-link" > Sequences< / a > / < a href = "./classes.html" class = "navigation-link" > Classes< / a > / < a href = "./string.html" class = "navigation-link" > string< / a > < / td >
< / tr > < / table > < div class = "header-separator" > < / div >
< div class = "section" id = "string" >
2010-08-09 20:07:24 +00:00
< h1 > < a class = "toc-backref" href = "./classes.html#id1415" > string< / a > < / h1 >
2009-08-17 23:36:52 +00:00
< div class = "section" id = "id112" >
< h3 > < a class = "subsection-title" href = "#description" name = "description" > Description< / a > < / h3 >
2010-08-09 20:07:24 +00:00
< p > < tt class = "literal" > < span class = "pre" > < a href = "./string.html" class = "identifier" > string< / a > < / span > < / tt > is a < a class = "reference internal" href = "./variadic-sequence.html" > variadic< / a > , < a class = "reference internal" href = "./bidirectional-sequence.html" > bidirectional< / a > , < a class = "reference internal" href = "./extensible-sequence.html" > extensible< / a > < a class = "reference internal" href = "./integral-sequence-wrapper.html" > Integral Sequence Wrapper< / a > of
2009-08-17 23:36:52 +00:00
characters that supports amortized constant-time insertion and removal of elements at both ends,
and linear-time insertion and removal of elements in the middle. The parameters to < tt class = "literal" > < span class = "pre" > < a href = "./string.html" class = "identifier" > string< / a > < / span > < / tt >
are multi-character literals, giving a somewhat readable syntax for compile-time strings.
< tt class = "literal" > < span class = "pre" > < a href = "./string.html" class = "identifier" > string< / a > < / span > < / tt > can also be an argument to the < tt class = "literal" > < span class = "pre" > < a href = "./c-str.html" class = "identifier" > c_str< / a > < / span > < / tt > metafunction, which generates a
null-terminated character array that facilitates interoperability with runtime string
processing routines.< / p >
< / div >
< div class = "section" id = "id115" >
< h3 > < a class = "subsection-title" href = "#header" name = "header" > Header< / a > < / h3 >
< table border = "1" class = "docutils table" >
< colgroup >
< col width = "26%" / >
< col width = "74%" / >
< / colgroup >
< thead valign = "bottom" >
< tr > < th class = "head" > Sequence form< / th >
< th class = "head" > Header< / th >
< / tr >
< / thead >
< tbody valign = "top" >
< tr > < td > Variadic< / td >
< td > < tt class = "literal" > < span class = "pre" > #include < < a href = "../../../../boost/mpl/string.hpp" class = "header" > boost/mpl/string.hpp< / a > > < / span > < / tt > < / td >
< / tr >
< / tbody >
< / table >
< / div >
< div class = "section" id = "id116" >
< h3 > < a class = "subsection-title" href = "#model-of" name = "model-of" > Model of< / a > < / h3 >
< ul class = "simple" >
< li > < a class = "reference internal" href = "./integral-sequence-wrapper.html" > Integral Sequence Wrapper< / a > < / li >
< li > < a class = "reference internal" href = "./variadic-sequence.html" > Variadic Sequence< / a > < / li >
< li > < a class = "reference internal" href = "./bidirectional-sequence.html" > Bidirectional Sequence< / a > < / li >
< li > < a class = "reference internal" href = "./extensible-sequence.html" > Extensible Sequence< / a > < / li >
< li > < a class = "reference internal" href = "./back-extensible-sequence.html" > Back Extensible Sequence< / a > < / li >
< li > < a class = "reference internal" href = "./front-extensible-sequence.html" > Front Extensible Sequence< / a > < / li >
< / ul >
< / div >
< div class = "section" id = "id117" >
< h3 > < a class = "subsection-title" href = "#expression-semantics" name = "expression-semantics" > Expression semantics< / a > < / h3 >
< p > In the following table, < tt class = "literal" > < span class = "pre" > s< / span > < / tt > is an instance of < tt class = "literal" > < span class = "pre" > < a href = "./string.html" class = "identifier" > string< / a > < / span > < / tt > , < tt class = "literal" > < span class = "pre" > pos< / span > < / tt > and < tt class = "literal" > < span class = "pre" > last< / span > < / tt > are iterators
into < tt class = "literal" > < span class = "pre" > s< / span > < / tt > , < tt class = "literal" > < span class = "pre" > r< / span > < / tt > is a < a class = "reference internal" href = "./forward-sequence.html" > Forward Sequence< / a > of characters, < tt class = "literal" > < span class = "pre" > n< / span > < / tt > and < tt class = "literal" > < span class = "pre" > x< / span > < / tt > are < a class = "reference internal" href = "./integral-constant.html" > Integral Constant< / a > s,
and < em > c< / em > < sub > 1< / sub > ,< em > c< / em > < sub > 2< / sub > ,... < em > c< / em > < sub > n< / sub > are arbitrary (multi-)characters.< / p >
< table border = "1" class = "docutils table" >
< colgroup >
< col width = "40%" / >
< col width = "60%" / >
< / colgroup >
< thead valign = "bottom" >
< tr > < th class = "head" > Expression< / th >
< th class = "head" > Semantics< / th >
< / tr >
< / thead >
< tbody valign = "top" >
< tr > < td > < pre class = "first last literal-block" >
< a href = "./string.html" class = "identifier" > string< / a > < < em > c< / em > < sub > 1< / sub > ,< em > c< / em > < sub > 2< / sub > ,... < em > c< / em > < sub > n< / sub > >
< / pre >
< / td >
< td > < tt class = "literal" > < span class = "pre" > < a href = "./string.html" class = "identifier" > string< / a > < / span > < / tt > of characters < em > c< / em > < sub > 1< / sub > ,< em > c< / em > < sub > 2< / sub > ,... < em > c< / em > < sub > n< / sub > ; see
< a class = "reference internal" href = "./variadic-sequence.html" > Variadic Sequence< / a > .< / td >
< / tr >
< tr > < td > < pre class = "first last literal-block" >
< a href = "./string.html" class = "identifier" > string< / a > < < em > c< / em > < sub > 1< / sub > ,< em > c< / em > < sub > 2< / sub > ,... < em > c< / em > < sub > n< / sub > > ::type
< / pre >
< / td >
< td > Identical to < tt class = "literal" > < span class = "pre" > < a href = "./string.html" class = "identifier" > string< / a > < < / span > < / tt > < em > c< / em > < sub > 1< / sub > ,< em > c< / em > < sub > 2< / sub > ,... < em > c< / em > < sub > n< / sub > < tt class = "literal" > < span class = "pre" > > < / span > < / tt > ;
see < a class = "reference internal" href = "./variadic-sequence.html" > Variadic Sequence< / a > .< / td >
< / tr >
< tr > < td > < tt class = "literal" > < span class = "pre" > < a href = "./begin.html" class = "identifier" > begin< / a > < s> ::type< / span > < / tt > < / td >
< td > An iterator pointing to the beginning of < tt class = "literal" > < span class = "pre" > s< / span > < / tt > ;
see < a class = "reference internal" href = "./bidirectional-sequence.html" > Bidirectional Sequence< / a > .< / td >
< / tr >
< tr > < td > < tt class = "literal" > < span class = "pre" > < a href = "./end.html" class = "identifier" > end< / a > < s> ::type< / span > < / tt > < / td >
< td > An iterator pointing to the end of < tt class = "literal" > < span class = "pre" > s< / span > < / tt > ;
see < a class = "reference internal" href = "./bidirectional-sequence.html" > Bidirectional Sequence< / a > .< / td >
< / tr >
< tr > < td > < tt class = "literal" > < span class = "pre" > < a href = "./size.html" class = "identifier" > size< / a > < s> ::type< / span > < / tt > < / td >
< td > The size of < tt class = "literal" > < span class = "pre" > s< / span > < / tt > ; see < a class = "reference internal" href = "./bidirectional-sequence.html" > Bidirectional Sequence< / a > .< / td >
< / tr >
< tr > < td > < tt class = "literal" > < span class = "pre" > < a href = "./empty.html" class = "identifier" > empty< / a > < s> ::type< / span > < / tt > < / td >
< td > A boolean < a class = "reference internal" href = "./integral-constant.html" > Integral Constant< / a > < tt class = "literal" > < span class = "pre" > c< / span > < / tt > such that
< tt class = "literal" > < span class = "pre" > c::value< / span > < span class = "pre" > ==< / span > < span class = "pre" > true< / span > < / tt > if and only if the sequence is empty;
see < a class = "reference internal" href = "./bidirectional-sequence.html" > Bidirectional Sequence< / a > .< / td >
< / tr >
< tr > < td > < tt class = "literal" > < span class = "pre" > < a href = "./front.html" class = "identifier" > front< / a > < s> ::type< / span > < / tt > < / td >
< td > The first element in < tt class = "literal" > < span class = "pre" > s< / span > < / tt > ; see
< a class = "reference internal" href = "./bidirectional-sequence.html" > Bidirectional Sequence< / a > .< / td >
< / tr >
< tr > < td > < tt class = "literal" > < span class = "pre" > < a href = "./back.html" class = "identifier" > back< / a > < s> ::type< / span > < / tt > < / td >
< td > The last element in < tt class = "literal" > < span class = "pre" > s< / span > < / tt > ; see
< a class = "reference internal" href = "./bidirectional-sequence.html" > Bidirectional Sequence< / a > .< / td >
< / tr >
< tr > < td > < tt class = "literal" > < span class = "pre" > < a href = "./insert.html" class = "identifier" > insert< / a > < s,pos,x> ::type< / span > < / tt > < / td >
< td > A new < tt class = "literal" > < span class = "pre" > < a href = "./string.html" class = "identifier" > string< / a > < / span > < / tt > of following elements:
[< tt class = "literal" > < span class = "pre" > < a href = "./begin.html" class = "identifier" > begin< / a > < s> ::type< / span > < / tt > , < tt class = "literal" > < span class = "pre" > pos< / span > < / tt > ), < tt class = "literal" > < span class = "pre" > x< / span > < / tt > ,
[< tt class = "literal" > < span class = "pre" > pos< / span > < / tt > , < tt class = "literal" > < span class = "pre" > < a href = "./end.html" class = "identifier" > end< / a > < s> ::type< / span > < / tt > ); see < a class = "reference internal" href = "./extensible-sequence.html" > Extensible Sequence< / a > .< / td >
< / tr >
< tr > < td > < tt class = "literal" > < span class = "pre" > < a href = "./insert-range.html" class = "identifier" > insert_range< / a > < s,pos,r> ::type< / span > < / tt > < / td >
< td > A new < tt class = "literal" > < span class = "pre" > < a href = "./string.html" class = "identifier" > string< / a > < / span > < / tt > of following elements:
[< tt class = "literal" > < span class = "pre" > < a href = "./begin.html" class = "identifier" > begin< / a > < s> ::type< / span > < / tt > , < tt class = "literal" > < span class = "pre" > pos< / span > < / tt > ),
[< tt class = "literal" > < span class = "pre" > < a href = "./begin.html" class = "identifier" > begin< / a > < r> ::type< / span > < / tt > , < tt class = "literal" > < span class = "pre" > < a href = "./end.html" class = "identifier" > end< / a > < r> ::type< / span > < / tt > )
[< tt class = "literal" > < span class = "pre" > pos< / span > < / tt > , < tt class = "literal" > < span class = "pre" > < a href = "./end.html" class = "identifier" > end< / a > < s> ::type< / span > < / tt > ); see < a class = "reference internal" href = "./extensible-sequence.html" > Extensible Sequence< / a > .< / td >
< / tr >
< tr > < td > < tt class = "literal" > < span class = "pre" > < a href = "./erase.html" class = "identifier" > erase< / a > < s,pos> ::type< / span > < / tt > < / td >
< td > A new < tt class = "literal" > < span class = "pre" > < a href = "./string.html" class = "identifier" > string< / a > < / span > < / tt > of following elements:
[< tt class = "literal" > < span class = "pre" > < a href = "./begin.html" class = "identifier" > begin< / a > < s> ::type< / span > < / tt > , < tt class = "literal" > < span class = "pre" > pos< / span > < / tt > ),
[< tt class = "literal" > < span class = "pre" > < a href = "./next.html" class = "identifier" > next< / a > < pos> ::type< / span > < / tt > , < tt class = "literal" > < span class = "pre" > < a href = "./end.html" class = "identifier" > end< / a > < s> ::type< / span > < / tt > ); see
< a class = "reference internal" href = "./extensible-sequence.html" > Extensible Sequence< / a > .< / td >
< / tr >
< tr > < td > < tt class = "literal" > < span class = "pre" > < a href = "./erase.html" class = "identifier" > erase< / a > < s,pos,last> ::type< / span > < / tt > < / td >
< td > A new < tt class = "literal" > < span class = "pre" > < a href = "./string.html" class = "identifier" > string< / a > < / span > < / tt > of following elements:
[< tt class = "literal" > < span class = "pre" > < a href = "./begin.html" class = "identifier" > begin< / a > < s> ::type< / span > < / tt > , < tt class = "literal" > < span class = "pre" > pos< / span > < / tt > ),
[< tt class = "literal" > < span class = "pre" > last< / span > < / tt > , < tt class = "literal" > < span class = "pre" > < a href = "./end.html" class = "identifier" > end< / a > < s> ::type< / span > < / tt > ); see < a class = "reference internal" href = "./extensible-sequence.html" > Extensible Sequence< / a > .< / td >
< / tr >
< tr > < td > < tt class = "literal" > < span class = "pre" > < a href = "./clear.html" class = "identifier" > clear< / a > < s> ::type< / span > < / tt > < / td >
< td > An empty < tt class = "literal" > < span class = "pre" > < a href = "./string.html" class = "identifier" > string< / a > < / span > < / tt > ; see < a class = "reference internal" href = "./extensible-sequence.html" > Extensible Sequence< / a > .< / td >
< / tr >
< tr > < td > < tt class = "literal" > < span class = "pre" > < a href = "./push-back.html" class = "identifier" > push_back< / a > < s,x> ::type< / span > < / tt > < / td >
< td > A new < tt class = "literal" > < span class = "pre" > < a href = "./string.html" class = "identifier" > string< / a > < / span > < / tt > of following elements:
[< tt class = "literal" > < span class = "pre" > < a href = "./begin.html" class = "identifier" > begin< / a > < s> ::type< / span > < / tt > , < tt class = "literal" > < span class = "pre" > < a href = "./end.html" class = "identifier" > end< / a > < s> ::type< / span > < / tt > ), < tt class = "literal" > < span class = "pre" > x< / span > < / tt > ;
see < a class = "reference internal" href = "./back-extensible-sequence.html" > Back Extensible Sequence< / a > .< / td >
< / tr >
< tr > < td > < tt class = "literal" > < span class = "pre" > < a href = "./pop-back.html" class = "identifier" > pop_back< / a > < s> ::type< / span > < / tt > < / td >
< td > A new < tt class = "literal" > < span class = "pre" > < a href = "./string.html" class = "identifier" > string< / a > < / span > < / tt > of following elements:
[< tt class = "literal" > < span class = "pre" > < a href = "./begin.html" class = "identifier" > begin< / a > < s> ::type< / span > < / tt > , < tt class = "literal" > < span class = "pre" > < a href = "./prior.html" class = "identifier" > prior< / a > < < / span > < span class = "pre" > < a href = "./end.html" class = "identifier" > end< / a > < s> ::type< / span > < span class = "pre" > > ::type< / span > < / tt > );
see < a class = "reference internal" href = "./back-extensible-sequence.html" > Back Extensible Sequence< / a > .< / td >
< / tr >
< tr > < td > < tt class = "literal" > < span class = "pre" > < a href = "./push-front.html" class = "identifier" > push_front< / a > < s,x> ::type< / span > < / tt > < / td >
< td > A new < tt class = "literal" > < span class = "pre" > < a href = "./string.html" class = "identifier" > string< / a > < / span > < / tt > of following elements:
[< tt class = "literal" > < span class = "pre" > < a href = "./begin.html" class = "identifier" > begin< / a > < s> ::type< / span > < / tt > , < tt class = "literal" > < span class = "pre" > < a href = "./end.html" class = "identifier" > end< / a > < s> ::type< / span > < / tt > ), < tt class = "literal" > < span class = "pre" > x< / span > < / tt > ; see < a class = "reference internal" href = "./front-extensible-sequence.html" > Front Extensible Sequence< / a > .< / td >
< / tr >
< tr > < td > < tt class = "literal" > < span class = "pre" > < a href = "./pop-front.html" class = "identifier" > pop_front< / a > < s> ::type< / span > < / tt > < / td >
< td > A new < tt class = "literal" > < span class = "pre" > < a href = "./string.html" class = "identifier" > string< / a > < / span > < / tt > of following elements:
[< tt class = "literal" > < span class = "pre" > < a href = "./next.html" class = "identifier" > next< / a > < < / span > < span class = "pre" > < a href = "./begin.html" class = "identifier" > begin< / a > < s> ::type< / span > < span class = "pre" > > ::type< / span > < / tt > , < tt class = "literal" > < span class = "pre" > < a href = "./end.html" class = "identifier" > end< / a > < s> ::type< / span > < / tt > );
see < a class = "reference internal" href = "./front-extensible-sequence.html" > Front Extensible Sequence< / a > .< / td >
< / tr >
< tr > < td > < tt class = "literal" > < span class = "pre" > < a href = "./c-str.html" class = "identifier" > c_str< / a > < s> ::value< / span > < / tt > < / td >
< td > A null-terminated byte string such that
< tt class = "literal" > < span class = "pre" > < a href = "./c-str.html" class = "identifier" > c_str< / a > < s> ::value[< / span > < / tt > < em > n< / em > < tt class = "literal" > < span class = "pre" > ]< / span > < / tt > is equal to the < em > n< / em > -th
character in < tt class = "literal" > < span class = "pre" > s< / span > < / tt > , and
< tt class = "literal" > < span class = "pre" > < a href = "./c-str.html" class = "identifier" > c_str< / a > < s> ::value[< a href = "./size.html" class = "identifier" > size< / a > < s> ::type::value]< / span > < / tt > is < tt class = "literal" > < span class = "pre" > '\0'< / span > < / tt > .< / td >
< / tr >
< / tbody >
< / table >
< / div >
< div class = "section" id = "id118" >
< h3 > < a class = "subsection-title" href = "#example" name = "example" > Example< / a > < / h3 >
< pre class = "literal-block" >
typedef mpl::< a href = "./string.html" class = "identifier" > string< / a > < 'hell','o wo','rld'> hello;
typedef mpl::< a href = "./push-back.html" class = "identifier" > push_back< / a > < hello, mpl::< a href = "./char.html" class = "identifier" > char_< / a > < '!'> > ::type hello2;
BOOST_ASSERT(0 == std::strcmp(mpl::< a href = "./c-str.html" class = "identifier" > c_str< / a > < hello2> ::value, " hello world!"));
< / pre >
< / div >
< div class = "section" id = "id119" >
< h3 > < a class = "subsection-title" href = "#see-also" name = "see-also" > See also< / a > < / h3 >
< p > < a class = "reference internal" href = "./sequences.html" > Sequences< / a > , < a class = "reference internal" href = "./variadic-sequence.html" > Variadic Sequence< / a > , < a class = "reference internal" href = "./bidirectional-sequence.html" > Bidirectional Sequence< / a > , < a class = "reference internal" href = "./extensible-sequence.html" > Extensible Sequence< / a > , < a class = "reference internal" href = "./integral-sequence-wrapper.html" > Integral Sequence Wrapper< / a > , < a class = "reference internal" href = "./char.html" > char_< / a > , < a class = "reference internal" href = "./c-str.html" > c_str< / a > < / p >
< / div >
< / div >
< div class = "footer-separator" > < / div >
< table class = "footer" > < tr class = "footer" > < td class = "header-group navigation-bar" > < span class = "navigation-group" > < a href = "./set-c.html" class = "navigation-link" > Prev< / a > < a href = "./views.html" class = "navigation-link" > Next< / a > < / span > < span class = "navigation-group-separator" > | < / span > < span class = "navigation-group" > < a href = "./set-c.html" class = "navigation-link" > Back< / a > Along< / span > < span class = "navigation-group-separator" > | < / span > < span class = "navigation-group" > < a href = "./classes.html" class = "navigation-link" > Up< / a > < a href = "../refmanual.html" class = "navigation-link" > Home< / a > < / span > < span class = "navigation-group-separator" > | < / span > < span class = "navigation-group" > < a href = "./refmanual_toc.html" class = "navigation-link" > Full TOC< / a > < / span > < / td >
< td > < div class = "copyright-footer" > < div class = "copyright" > Copyright © 2009 Eric Niebler< / div >
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at < a class = "reference external" href = "http://www.boost.org/LICENSE_1_0.txt" target = "_top" > http://www.boost.org/LICENSE_1_0.txt< / a > )< / div > < / td > < / tr > < / table > < / body >
< / html >
