|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r63534 - sandbox/SOC/2009/unicode/libs/unicode/doc/concepts
From: loufoque_at_[hidden]
Date: 2010-07-02 19:02:14
Author: mgaunard
Date: 2010-07-02 19:02:13 EDT (Fri, 02 Jul 2010)
New Revision: 63534
URL: http://svn.boost.org/trac/boost/changeset/63534
Log:
adding concept definitions that should already have been there
Added:
sandbox/SOC/2009/unicode/libs/unicode/doc/concepts/Converter.xml (contents, props changed)
sandbox/SOC/2009/unicode/libs/unicode/doc/concepts/OneManyConverter.xml (contents, props changed)
sandbox/SOC/2009/unicode/libs/unicode/doc/concepts/Segmenter.xml (contents, props changed)
Added: sandbox/SOC/2009/unicode/libs/unicode/doc/concepts/Converter.xml
==============================================================================
--- (empty file)
+++ sandbox/SOC/2009/unicode/libs/unicode/doc/concepts/Converter.xml 2010-07-02 19:02:13 EDT (Fri, 02 Jul 2010)
@@ -0,0 +1,143 @@
+<?xml version="1.0" ?>
+<concept name="Converter" category="utility">
+ <!--
+ Copyright 2009 Mathias Gaunard
+
+ Distributed under the Boost
+ Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ -->
+ <param name="Converter" role="model of Converter" />
+ <param name="In" role="model of Bidirectional Iterator with elements convertible to input_type" />
+ <param name="Out" role="model of OutputIterator<output_type>" />
+
+ <models-sentence>
+ The type <arg num="1" /> must be a model of <self/>.
+ </models-sentence>
+
+ <description>
+ <para>
+ A Converter is a type grouping two functions that read a certain number of elements off a range
+ and write another number of elements on another one, hence making it a
+ many-to-many conversion facility.
+ </para>
+ </description>
+
+ <notation variables="p">
+ <sample-value>
+ <type name="Converter" />
+ </sample-value>
+ </notation>
+
+ <notation variables="begin end">
+ <sample-value>
+ <type name="In" />
+ </sample-value>
+ </notation>
+
+ <notation variables="out">
+ <sample-value>
+ <type name="Out" />
+ </sample-value>
+ </notation>
+
+ <associated-type name="input_type">
+ <get-member-type name="input_type">
+ <type name="Converter" />
+ </get-member-type>
+ <description>
+ <simpara>The type of elements the converter converts from.</simpara>
+ </description>
+ </associated-type>
+
+ <associated-type name="output_type">
+ <get-member-type name="output_type">
+ <type name="Converter" />
+ </get-member-type>
+ <description>
+ <simpara>The type of elements the converter converts into.</simpara>
+ </description>
+ </associated-type>
+
+ <associated-type name="max_output">
+ <get-member-type name="max_output">
+ <type name="Converter" />
+ </get-member-type>
+ <description>
+ <simpara>Optional MPL integral constant that states how many
+ elements may be added to <code>out</code> at maximum in an <code>ltr</code>
+ or <code>rtl</code> call.</simpara>
+ </description>
+ </associated-type>
+
+ <valid-expression name="Construction">
+ <construct template-parameters="">
+ <type name="Converter"/>
+ </construct>
+ <return-type><require-same-type testable="yes"><type name="Converter"/></require-same-type></return-type>
+ <semantics>Construct an instance of the type with default parameters.</semantics>
+ </valid-expression>
+
+ <valid-expression name="Left to right">
+ <apply-method name="ltr">
+ <sample-value>
+ <type name="Converter" />
+ </sample-value>
+ <sample-value>
+ <type name="In" />
+ </sample-value>
+ <sample-value>
+ <type name="In" />
+ </sample-value>
+ <sample-value>
+ <type name="Out" />
+ </sample-value>
+ </apply-method>
+ <return-type>
+ <require-same-type testable="yes">
+ <type name="std::pair<In, Out>"/>
+ </require-same-type>
+ </return-type>
+ <semantics>
+ Reads part of the [<code>begin</code>, <code>end</code>[ range left to right,
+ writes some elements of type <code>output_type</code> to <code>out</code>, and returns a pair
+ indicating the new begin iterator and the past-the-end output iterator.
+ </semantics>
+ <precondition><code>begin != end</code></precondition>
+ </valid-expression>
+
+ <valid-expression name="Right to left">
+ <apply-method name="rtl">
+ <sample-value>
+ <type name="Converter" />
+ </sample-value>
+ <sample-value>
+ <type name="In" />
+ </sample-value>
+ <sample-value>
+ <type name="In" />
+ </sample-value>
+ <sample-value>
+ <type name="Out" />
+ </sample-value>
+ </apply-method>
+ <return-type>
+ <require-same-type testable="yes">
+ <type name="std::pair<In, Out>"/>
+ </require-same-type>
+ </return-type>
+ <semantics>
+ Reads part of the [<code>begin</code>, <code>end</code>[ range right to left,
+ writes some elements of type <code>output_type</code> to <code>out</code>, and returns a pair
+ indicating the new past-the-end iterator and the past-the-end output iterator.
+ </semantics>
+ <precondition><code>begin != end</code></precondition>
+ </valid-expression>
+
+ <example-model>
+ <type name="boost::unicode::u8_decoder" />
+ <type name="boost::unicode::u16_decoder" />
+ <type name="boost::unicode::hangul_composer" />
+ </example-model>
+
+</concept>
Added: sandbox/SOC/2009/unicode/libs/unicode/doc/concepts/OneManyConverter.xml
==============================================================================
--- (empty file)
+++ sandbox/SOC/2009/unicode/libs/unicode/doc/concepts/OneManyConverter.xml 2010-07-02 19:02:13 EDT (Fri, 02 Jul 2010)
@@ -0,0 +1,112 @@
+<?xml version="1.0" ?>
+<concept name="OneManyConverter" category="utility">
+ <!--
+ Copyright 2009 Mathias Gaunard
+
+ Distributed under the Boost
+ Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ -->
+ <param name="Converter" role="model of OneManyConverter" />
+ <param name="In" role="model of Convertible<input_type>" />
+ <param name="Out" role="model of OutputIterator<output_type>" />
+
+ <models-sentence>
+ The type <arg num="1" /> must be a model of <self/>.
+ </models-sentence>
+
+ <description>
+ <para>
+ A OneManyConverter is a function object that takes a value as argument and writes
+ a number of elements to a range, hence making it a
+ one-to-many conversion facility.
+ </para>
+ </description>
+
+ <notation variables="p">
+ <sample-value>
+ <type name="Converter" />
+ </sample-value>
+ </notation>
+
+ <notation variables="v">
+ <sample-value>
+ <type name="In" />
+ </sample-value>
+ </notation>
+
+ <notation variables="out">
+ <sample-value>
+ <type name="Out" />
+ </sample-value>
+ </notation>
+
+ <associated-type name="input_type">
+ <get-member-type name="input_type">
+ <type name="Converter" />
+ </get-member-type>
+ <description>
+ <simpara>The type of elements the converter converts from.</simpara>
+ </description>
+ </associated-type>
+
+ <associated-type name="output_type">
+ <get-member-type name="output_type">
+ <type name="Converter" />
+ </get-member-type>
+ <description>
+ <simpara>The type of elements the converter converts into.</simpara>
+ </description>
+ </associated-type>
+
+ <associated-type name="max_output">
+ <get-member-type name="max_output">
+ <type name="Converter" />
+ </get-member-type>
+ <description>
+ <simpara>Optional MPL integral constant that states how many
+ elements may be added to <code>out</code> at maximum in a call to
+ the function object.</simpara>
+ </description>
+ </associated-type>
+
+ <refines const="no" concept="Converter"/>
+
+ <valid-expression name="Construction">
+ <construct template-parameters="">
+ <type name="OneManyConverter"/>
+ </construct>
+ <return-type><require-same-type testable="yes"><type name="OneManyConverter"/></require-same-type></return-type>
+ <semantics>Construct an instance of the type with default parameters.</semantics>
+ </valid-expression>
+
+ <valid-expression name="Function Object Call">
+ <apply-funcobj>
+ <sample-value>
+ <type name="Converter" />
+ </sample-value>
+ <sample-value>
+ <type name="In" />
+ </sample-value>
+ <sample-value>
+ <type name="Out" />
+ </sample-value>
+ </apply-funcobj>
+ <return-type>
+ <require-same-type testable="yes">
+ <type name="Out"/>
+ </require-same-type>
+ </return-type>
+ <semantics>
+ Writes some elements of type <code>output_type</code> to <code>out</code>,
+ and returns the past-the-end output iterator.
+ </semantics>
+ </valid-expression>
+
+ <example-model>
+ <type name="boost::unicode::u8_encoder" />
+ <type name="boost::unicode::u16_encoder" />
+ <type name="boost::unicode::hangul_decomposer" />
+ </example-model>
+
+</concept>
Added: sandbox/SOC/2009/unicode/libs/unicode/doc/concepts/Segmenter.xml
==============================================================================
--- (empty file)
+++ sandbox/SOC/2009/unicode/libs/unicode/doc/concepts/Segmenter.xml 2010-07-02 19:02:13 EDT (Fri, 02 Jul 2010)
@@ -0,0 +1,108 @@
+<?xml version="1.0" ?>
+<concept name="Segmenter" category="utility">
+ <!--
+ Copyright 2009 Mathias Gaunard
+
+ Distributed under the Boost
+ Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ -->
+ <param name="Segmenter" role="model of Segmenter" />
+ <param name="In" role="model of Bidirectional Iterator with elements convertible to input_type" />
+
+ <models-sentence>
+ The type <arg num="1" /> must be a model of <self/>.
+ </models-sentence>
+
+ <description>
+ <para>
+ A Segmenter is a type grouping two functions that read a certain number of
+ elements off a range, hence making it a facility to segment a range.
+ </para>
+ </description>
+
+ <notation variables="c">
+ <sample-value>
+ <type name="Segmenter" />
+ </sample-value>
+ </notation>
+
+ <notation variables="begin end">
+ <sample-value>
+ <type name="In" />
+ </sample-value>
+ </notation>
+
+ <associated-type name="input_type">
+ <get-member-type name="input_type">
+ <type name="Segmenter" />
+ </get-member-type>
+ <description>
+ <simpara>The type of elements the segmenters segments.</simpara>
+ </description>
+ </associated-type>
+
+ <valid-expression name="Construction">
+ <construct template-parameters="">
+ <type name="Segmenter"/>
+ </construct>
+ <return-type><require-same-type testable="yes"><type name="Segmenter"/></require-same-type></return-type>
+ <semantics>Construct an instance of the type with default parameters.</semantics>
+ </valid-expression>
+
+ <valid-expression name="Left to right">
+ <apply-method name="ltr">
+ <sample-value>
+ <type name="Segmenter" />
+ </sample-value>
+ <sample-value>
+ <type name="In" />
+ </sample-value>
+ <sample-value>
+ <type name="In" />
+ </sample-value>
+ </apply-method>
+ <return-type>
+ <require-same-type testable="yes">
+ <type name="In"/>
+ </require-same-type>
+ </return-type>
+ <semantics>
+ Reads part of the [<code>begin</code>, <code>end</code>[ range left to right,
+ and returns the new begin iterator.
+ </semantics>
+ <precondition><code>begin != end</code></precondition>
+ </valid-expression>
+
+ <valid-expression name="Right to left">
+ <apply-method name="rtl">
+ <sample-value>
+ <type name="Segmenter" />
+ </sample-value>
+ <sample-value>
+ <type name="In" />
+ </sample-value>
+ <sample-value>
+ <type name="In" />
+ </sample-value>
+ </apply-method>
+ <return-type>
+ <require-same-type testable="yes">
+ <type name="In"/>
+ </require-same-type>
+ </return-type>
+ <semantics>
+ Reads part of the [<code>begin</code>, <code>end</code>[ range right to left,
+ and returns the new past-the-end iterator.
+ </semantics>
+ <precondition><code>begin != end</code></precondition>
+ </valid-expression>
+
+ <example-model>
+ <apply-template name="boost::boundary_segmenter">
+ <type name="BoundaryChecker"/>
+ </apply-template>
+ <type name="boost::unicode::combiner" />
+ </example-model>
+
+</concept>
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk