Skip to content

Commit c2aca09

Browse files
ivanpanchivanpanch
authored
Fix mistakes (#84)
* Update index.html * Update basics.html * Update indices.html * Update debug.html * Update techniques.html * Update multi_index_container.html * Update indices.html * Update ord_indices.html * Update hash_indices.html * Update seq_indices.html * Update rnd_indices.html * Update key_extraction.html * Update compiler_specifics.html * Update performance.html * Update examples.html * Update tests.html * Update indices.html * Update key_extraction.html * Update key_extraction.html * Update multi_index_container.html * Update rnd_indices.html
1 parent 280d659 commit c2aca09

16 files changed

+57
-57
lines changed

‎doc/compiler_specifics.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ <h3><a name="type_hiding">Type hiding</a></h3>
263263
</p>
264264

265265
<p>
266-
Type hiding techniques can also be applied to <code>composite_key</code> intantiations,
266+
Type hiding techniques can also be applied to <code>composite_key</code> instantiations,
267267
which often contribute a great deal to symbol name lengths.
268268
</p>
269269

@@ -274,7 +274,7 @@ <h2><a name="legacy">Legacy compilers</a></h2>
274274
to work with an old environment you might need to use a former version of the library.
275275
A table is provided of some legacy compilers along with the latest version of
276276
Boost.MultiIndex known to work for them (frequently with limitations as explained
277-
in the corresponding compiler specifics section.) If you successfully try one of those
277+
in the corresponding compiler specifics section). If you successfully try one of those
278278
with newer versions of Boost.MultiIndex than stated here, please report back so that
279279
the information can be updated.
280280
</p>

‎doc/examples.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ <h2><a name="example4">Example 4: bidirectional map</a></h2>
105105
This example shows how to construct a bidirectional map with
106106
<code>multi_index_container</code>. By a <i>bidirectional map</i> we mean
107107
a container of <code>(const FromType,const ToType)</code> pairs
108-
such that no two elements exists with the same first
108+
such that no two elements exist with the same first
109109
<i>or</i> second component (<code>std::map</code> only
110110
guarantees uniqueness of the first component). Fast lookup is provided
111111
for both keys. The program features a tiny Spanish-English

‎doc/performance.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ <h2><a name="spatial_efficiency">Spatial efficiency</a></h2>
220220
The gain in space consumption of <code>multi_index_container</code> with
221221
respect to its manual simulations is amenable to a very simple
222222
theoretical analysis. For simplicity, we will ignore alignment
223-
issues (which in general play in favor of <code>multi_index_container</code>.)
223+
issues (which in general play in favor of <code>multi_index_container</code>).
224224
</p>
225225

226226
<p>
@@ -285,7 +285,7 @@ <h2><a name="spatial_efficiency">Spatial efficiency</a></h2>
285285

286286
<p>
287287
where <i>O</i> is the number of ordered indices of the container, and <i>w</i>
288-
is the system word size (typically 4 bytes on 32-bit architectures.)
288+
is the system word size (typically 4 bytes on 32-bit architectures).
289289
</p>
290290

291291
<p>
@@ -473,7 +473,7 @@ <h4><a name="memory_1s">Memory consumption</a></h4>
473473

474474
<p>
475475
The figures confirm that in this case <code>multi_index_container</code> nodes are the
476-
same size than those of its <code>std::list</code> counterpart.
476+
same size as those of its <code>std::list</code> counterpart.
477477
</p>
478478

479479
<h4><a name="time_1s">Execution time</a></h4>
@@ -725,7 +725,7 @@ <h2><a name="conclusions">Conclusions</a></h2>
725725
We have shown that <code>multi_index_container</code> outperforms, both in space and
726726
time efficiency, equivalent data structures obtained from the manual
727727
combination of STL containers. This improvement gets larger when the number
728-
of indices increase.
728+
of indices increases.
729729
</p>
730730

731731
<p>

‎doc/reference/hash_indices.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ <h3><a name="hash_indices">Hashed indices</a></h3>
199199
<p>
200200
Except where noted or if the corresponding interface does not exist, hashed indices
201201
(both unique and non-unique) satisfy the C++ requirements for unordered associative
202-
containers at <b>[unord.req]</b> (supporting unique and equivalent keys, respectively.)
202+
containers at <b>[unord.req]</b> (supporting unique and equivalent keys, respectively).
203203
Iterators (including to the end of the index) and pointers and references to an element
204204
remain valid during the lifetime of the associated container (which can change
205205
upon swapping), or until the referred-to element is erased or extracted;
@@ -458,7 +458,7 @@ <h4><a name="instantiation_types">Instantiation types</a></h4>
458458
which determines the mechanism for extracting a key from <code>Value</code>,
459459
must be a model of <a href="key_extraction.html#key_extractors">
460460
<code>Key Extractor</code></a> from <code>Value</code>. <code>Hash</code> is a
461-
<code>CopyConstructible</code>unary function object
461+
<code>CopyConstructible</code> unary function object
462462
taking a single argument of type <code>KeyFromValue::result_type</code> and returning a
463463
value of type <code>std::size_t</code> in the range
464464
<code>[0, std::numeric_limits&lt;std::size_t&gt;::max())</code>.
@@ -802,7 +802,7 @@ <h4><a name="modifiers">Modifiers</a></h4>
802802
<code>position</code> is a valid dereferenceable iterator of the index.<br>
803803
<b>Effects:</b> Assigns the value <code>x</code> to the element pointed
804804
to by <code>position</code> into the <code>multi_index_container</code> to which
805-
the index belongs if, for the value <code>x</code>
805+
the index belongs if, for the value <code>x</code>,
806806
<ul>
807807
<li>the index is non-unique OR no other element exists
808808
(except possibly <code>*position</code>) with equivalent key,</li>
@@ -1355,7 +1355,7 @@ <h4><a name="serialization">Serialization</a></h4>
13551355
was <code>m.get&lt;i&gt;().end(n)</code> for some <code>n</code>, then
13561356
<code>it'==m'.get&lt;i&gt;().end(n)</code> (where <code>m</code> is the original
13571357
<code>multi_index_container</code>, <code>m'</code> its restored copy
1358-
and <code>i</code> is the ordinal of the index.)<br>
1358+
and <code>i</code> is the ordinal of the index).<br>
13591359
<b>Note:</b> It is allowed that <code>it</code> be a <code>const_local_iterator</code>
13601360
and the restored <code>it'</code> a <code>local_iterator</code>, or vice versa.
13611361
</blockquote>

‎doc/reference/indices.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ <h2><a name="index_concepts">Index concepts</a></h2>
8181
these operations, however, do have an impact on all other indices as
8282
well: for instance, insertion through a given index may fail because
8383
there exists another index which bans the operation in order to preserve
84-
its invariant (like uniqueness of elements.) This circumstance, rather
84+
its invariant (like uniqueness of elements). This circumstance, rather
8585
than being an obstacle, yields much of the power of Boost.MultiIndex:
8686
equivalent constructions based on manual composition of standard
8787
containers would have to add a fair amount of code in order to
@@ -103,7 +103,7 @@ <h2><a name="index_concepts">Index concepts</a></h2>
103103
</ul>
104104
The last two primitives deserve some further explanation: in order to
105105
guarantee the invariants associated to each index (e.g. some definite
106-
ordering,) elements of a <code>multi_index_container</code> are not mutable.
106+
ordering), elements of a <code>multi_index_container</code> are not mutable.
107107
To overcome this restriction, indices expose member functions
108108
for replacement and modification which allow for the mutation of elements
109109
in a controlled fashion. Immutability of elements does not significantly
@@ -120,8 +120,8 @@ <h2><a name="index_concepts">Index concepts</a></h2>
120120
they are wrapped as appropriate by each index (for instance, ordered indices
121121
provide a set-like suite of insertion member functions, whereas sequenced
122122
and random access indices have <code>push_back</code> and <code>push_front</code>
123-
operations.) Boost.MultiIndex poses no particular conditions on
124-
the interface of indices, although each index provided satisfy the C++ requirements for
123+
operations). Boost.MultiIndex poses no particular conditions on
124+
the interface of indices, although each index provided satisfies the C++ requirements for
125125
standard containers to the maximum extent possible within the conceptual framework
126126
of the library.
127127
</p>
@@ -312,7 +312,7 @@ <h3><a name="key_based_indices">Key-based indices</a></h3>
312312
reference</a>.
313313
<ul>
314314
<li><a href="ord_indices.html">Ordered indices</a> sort the elements
315-
on the key and provide fast lookup capabilites.</li>
315+
on the key and provide fast lookup capabilities.</li>
316316
<li><a href="rnk_indices.html">Ranked indices</a> are a variation of
317317
ordered indices providing extra operations based on
318318
<i>rank</i>, the numerical position of an element
@@ -336,7 +336,7 @@ <h3><a name="other_indices">Other types</a></h3>
336336
<h2><a name="views">Index views</a></h2>
337337

338338
<p>
339-
The following concept is used by the rearrange facilities of non key-based
339+
The following concept is used by the rearrange facilities of non-key-based
340340
indices. Given an index <code>i</code> of type <code>Index</code>, a <i>view
341341
of <code>i</code></i> is any range [<code>first</code>,<code>last</code>)
342342
where <code>first</code> and <code>last</code> are input iterators such that

‎doc/reference/key_extraction.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -776,7 +776,7 @@ <h4><code>global_fun</code> members</h4>
776776
<blockquote>
777777
<b>Requires:</b> <code>ChainedPtr</code> is a <a href="#chained_pointers">chained pointer</a>
778778
type to <code>Value</code>.<br>
779-
<b>Returns:</b> <code>PtrToFunction)(y)</code>, where <code>y</code> is the
779+
<b>Returns:</b> <code>PtrToFunction(y)</code>, where <code>y</code> is the
780780
object chained-pointed to by <code>x</code>.
781781
</blockquote>
782782

@@ -1233,7 +1233,7 @@ <h4>Comparison operators</h4>
12331233

12341234
<blockquote>
12351235
<b>Requires:</b> The expressions given below are valid (for the particular
1236-
<code><b><i>OP</i></b></code> considered.)<br>
1236+
<code><b><i>OP</i></b></code> considered).<br>
12371237
<b>Returns:</b> <code>true</code> if and only if
12381238
<blockquote>
12391239
<code>!(x==y)</code> (<code><b><i>OP</i></b></code> is <code>!=</code>),<br>
@@ -2078,7 +2078,7 @@ <h3><a name="ckey_result_semantics">Semantics of
20782078
<blockquote>
20792079
<code>tuple&lt;Q0,...,Qj></code>,<br>
20802080
<code>composite_key_result&lt;composite_key&lt;K0,...,Kj> ></code>, with
2081-
<code>Ki::result_type = Qi</code> for all <code>i = 0,...,j</code>.
2081+
<code>Ki::result_type = Qi</code> for all <code>i = 0,...,j</code>,
20822082
</blockquote>
20832083
provided that each <code>Qi</code> is either <code>Ti</code> or a
20842084
<a href="hash_indices.html#lookup"><code>Compatible Key</code></a>
@@ -2097,9 +2097,9 @@ <h3><a name="ckey_result_semantics">Semantics of
20972097
<code>composite_key_compare</code> with respect to
20982098
<code>composite_key_result&lt;CompositeKey></code>:
20992099
<blockquote>
2100-
<code>tuple&lt;Q0,...,Qk></code>, <code>k &lt;= n</code><br>
2100+
<code>tuple&lt;Q0,...,Qk></code>, <code>k &lt;= n</code>,<br>
21012101
<code>composite_key_result&lt;composite_key&lt;K0,...,Kk> ></code>, with
2102-
<code>Ki::result_type = Qi</code> for all <code>i = 0,...,k</code>.
2102+
<code>Ki::result_type = Qi</code> for all <code>i = 0,...,k</code>,
21032103
</blockquote>
21042104
provided that
21052105
<ul>
@@ -2214,7 +2214,7 @@ <h3><a name="key">Alias template <code>key</code></a></h3>
22142214
with:
22152215
<ul>
22162216
<li><code>KeyFromValuei</code> = <code>key&lt;Keyi&gt;</code>
2217-
for all <code>i = 0,...,n</code>
2217+
for all <code>i = 0,...,n</code>,
22182218
</li>
22192219
<li><code>Value</code> = <code>std::decay_t&lt;Value0&gt;</code> &#8855;
22202220
<code>std::decay_t&lt;Value1&gt;</code> &#8855; &middot;&middot;&middot; &#8855;

‎doc/reference/multi_index_container.html‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ <h3><a name="multi_index_container">
244244
For convenience of use, all public methods and types of the first index
245245
specified are inherited by <code>multi_index_container</code>. This also includes global
246246
operators and functions associated with the index (vg. comparison and
247-
<code>swap</code>.)
247+
<code>swap</code>).
248248
</p>
249249

250250
<blockquote><pre>
@@ -532,7 +532,7 @@ <h4><a name="instantiation_types">Instantiation types</a></h4>
532532
<li><code>IndexSpecifierList</code> specifies the indices that the
533533
<code>multi_index_container</code> is composed of. It must be a non-empty
534534
<a href="../../../../libs/mpl/doc/refmanual/forward-sequence.html">
535-
<code>MPL Forward Sequence</code></a> (and, preferrably,
535+
<code>MPL Forward Sequence</code></a> (and, preferably,
536536
an <a href="../../../../libs/mpl/doc/refmanual/random-access-sequence.html">
537537
<code>MPL Random Access Sequence</code></a>) of index specifiers. For
538538
syntactic convenience, the
@@ -738,7 +738,7 @@ <h4><a name="constructors">Constructors, copy and assignment</a></h4>
738738
<code>EmplaceConstructible</code> into <code>multi_index_container</code>
739739
from <code>*first</code>.
740740
<code>last</code> is reachable from <code>first</code>.<br>
741-
<b>Effects:</b> Constructs and empty <code>multi_index_container</code> using the
741+
<b>Effects:</b> Constructs an empty <code>multi_index_container</code> using the
742742
specified argument list and allocator and fills it with
743743
the elements in the range [<code>first</code>,<code>last</code>).
744744
Insertion of each element may or may not succeed depending
@@ -765,7 +765,7 @@ <h4><a name="constructors">Constructors, copy and assignment</a></h4>
765765
<code>multi_index_container</code>.<br>
766766
<b>Effects:</b> Constructs a copy of <code>x</code>, copying its
767767
elements as well as its internal objects (those specified
768-
in <code>ctor_args_list</code> and the allocator.)<br>
768+
in <code>ctor_args_list</code> and the allocator).<br>
769769
<b>Postconditions:</b> <code>*this==x</code>. The order on every index
770770
of the <code>multi_index_container</code> is preserved as well.<br>
771771
<b>Complexity:</b> <code>O(x.size()*log(x.size()) + C(x.size()))</code>.
@@ -777,7 +777,7 @@ <h4><a name="constructors">Constructors, copy and assignment</a></h4>
777777
<blockquote>
778778
<b>Effects:</b> Constructs a <code>multi_index_container</code> by transferring the
779779
elements of <code>x</code> and copying its internal objects (those specified
780-
in <code>ctor_args_list</code> and the allocator.)<br>
780+
in <code>ctor_args_list</code> and the allocator).<br>
781781
<b>Postconditions:</b> If <code>x==y</code> just
782782
before the movement, <code>*this==y</code>. The order on every index
783783
of the <code>multi_index_container</code> is preserved as well.<br>
@@ -883,7 +883,7 @@ <h4><a name="constructors">Constructors, copy and assignment</a></h4>
883883
<blockquote>
884884
<b>Requires:</b> <code>Value</code> is <code>CopyInsertable</code> into
885885
<code>multi_index_container</code>.<br>
886-
<b>Effects:</b> Replaces the elements the <code>multi_index_container</code>
886+
<b>Effects:</b> Replaces the elements of the <code>multi_index_container</code>
887887
with copies of the elements of <code>list</code>, inserted in the specified order.
888888
Insertion of each element may or may not succeed depending
889889
on the acceptance by all the indices of the <code>multi_index_container</code>.<br>
@@ -965,7 +965,7 @@ <h4><a name="projection">Projection operations</a></h4>
965965
<b>Requires:</b> <code>0 &lt;= N &lt; I-1</code>. <code>IteratorType</code>
966966
belongs to <code>iterator_type_list</code>. <code>it</code> is a valid
967967
iterator of some index of <code>*this</code> (i.e. does not refer to some
968-
other <code>multi_index_container</code>.)<br>
968+
other <code>multi_index_container</code>).<br>
969969
<b>Effects:</b> Returns an <code>nth_index&lt;N>::type::iterator</code>
970970
equivalent to <code>it</code>.<br>
971971
<b>Complexity:</b> Constant.<br>
@@ -995,7 +995,7 @@ <h4><a name="projection">Projection operations</a></h4>
995995
<code>index&lt;Tag>::type</code> is valid. <code>IteratorType</code>
996996
belongs to <code>iterator_type_list</code>. <code>it</code> is a valid
997997
iterator of some index of <code>*this</code> (i.e. does not refer to some
998-
other <code>multi_index_container</code>.)<br>
998+
other <code>multi_index_container</code>).<br>
999999
<b>Effects:</b> Returns an <code>index&lt;Tag>::type::iterator</code>
10001000
equivalent to <code>it</code>.<br>
10011001
<b>Complexity:</b> Constant.<br>
@@ -1011,7 +1011,7 @@ <h4><a name="projection">Projection operations</a></h4>
10111011
belongs to <code>const_iterator_type_list</code> or
10121012
<code>iterator_type_list</code>. <code>it</code> is a valid
10131013
(constant or non-constant) iterator of some index of <code>*this</code>
1014-
(i.e. does not refer to some other <code>multi_index_container</code>.)<br>
1014+
(i.e. does not refer to some other <code>multi_index_container</code>).<br>
10151015
<b>Effects:</b> Returns an <code>index&lt;Tag>::type::const_iterator</code>
10161016
iterator equivalent to <code>it</code>.<br>
10171017
<b>Complexity:</b> Constant.<br>
@@ -1053,7 +1053,7 @@ <h4><a name="serialization">Serialization</a></h4>
10531053

10541054
<blockquote>
10551055
<b>Requires:</b> <code>Value</code> is serializable (XML-serializable). Additionally,
1056-
each of the indices of <code>m</code> can impose another requirements.<br>
1056+
each of the indices of <code>m</code> can impose other requirements.<br>
10571057
<b>Exception safety:</b> Strong with respect to <code>m</code>. If an exception
10581058
is thrown, <code>ar</code> may be left in an inconsistent state.
10591059
</blockquote>
@@ -1063,7 +1063,7 @@ <h4><a name="serialization">Serialization</a></h4>
10631063

10641064
<blockquote>
10651065
<b>Requires:</b> <code>Value</code> is serializable (XML-serializable). Additionally,
1066-
each of the indices of <code>m'</code> can impose another requirements.<br>
1066+
each of the indices of <code>m'</code> can impose other requirements.<br>
10671067
<b>Exception safety:</b> Basic. If an exception is thrown, <code>ar</code> may be
10681068
left in an inconsistent state.
10691069
</blockquote>

‎doc/reference/ord_indices.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ <h3><a name="ord_indices">Ordered indices</a></h3>
196196
Except where noted or if the corresponding interface does not exist,
197197
ordered indices (both unique and non-unique) satisfy the C++ requirements
198198
for associative containers at <b>[associative.reqmts]</b>
199-
(supporting unique and equivalent keys, respectively.)
199+
(supporting unique and equivalent keys, respectively).
200200
Iterators (including to the end of the index) and pointers and references to an element
201201
remain valid during the lifetime of the associated container (which can change
202202
upon swapping), or until the referred-to element is erased or extracted;
@@ -1324,7 +1324,7 @@ <h4><a name="serialization">Serialization</a></h4>
13241324
then <code>*it'</code> is the restored copy of <code>*it</code>, otherwise
13251325
<code>it'==end()</code>.<br>
13261326
<b>Note:</b> It is allowed that <code>it</code> be a <code>const_iterator</code>
1327-
and the restored <code>it'</code> an <code>iterator</code>, or viceversa.
1327+
and the restored <code>it'</code> an <code>iterator</code>, or vice versa.
13281328
</blockquote>
13291329

13301330
<hr>

‎doc/reference/rnd_indices.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ <h3><a name="rnd_indices">Random access indices</a></h3>
178178
have <code>data</code> member functions.
179179
</li>
180180

181-
<li>The complexity of some operations, notably insertion and deletion, differ
181+
<li>The complexities of some operations, notably insertion and deletion, differ
182182
from those of <code>std::vector</code>.
183183
</li>
184184
<li>Unlike as in <code>std::vector</code>, insertions into a random access index
@@ -439,7 +439,7 @@ <h4><a name="complexity_signature">Complexity signature</a></h4>
439439

440440
<p>
441441
(<code>shl</code> and <code>rel</code> stand for <i>shift left</i> and
442-
<i>relocate</i>, respectively.)
442+
<i>relocate</i>, respectively).
443443
</p>
444444

445445
<h4><a name="instantiation_types">Instantiation types</a></h4>
@@ -550,7 +550,7 @@ <h4><a name="capacity">Capacity operations</a></h4>
550550
<code>size()&lt;c</code>, back insertions happen in constant time (the
551551
general case as described by
552552
<a href="#complexity_signature"><code>i(n)</code></a> is <i>amortized</i>
553-
constant time.)<br>
553+
constant time).<br>
554554
<b>Note:</b> Validity of iterators and references to elements
555555
is preserved in all insertions, regardless of the capacity status.
556556
</blockquote>
@@ -590,7 +590,7 @@ <h4><a name="capacity">Capacity operations</a></h4>
590590
elements (first version) or copies of <code>x</code> (second version) at the end of
591591
the index. If <code>n&lt;size()</code>, erases the last <code>size()-n</code> elements.<br>
592592
<b>Note:</b> If an expansion is requested, the size of the index is not guaranteed
593-
to be <code>n</code> after this operation (other indices may ban insertions.)
593+
to be <code>n</code> after this operation (other indices may ban insertions).
594594
</blockquote>
595595

596596
<h4><a name="modifiers">Modifiers</a></h4>
@@ -1223,7 +1223,7 @@ <h4><a name="serialization">Serialization</a></h4>
12231223
then <code>*it'</code> is the restored copy of <code>*it</code>, otherwise
12241224
<code>it'==end()</code>.<br>
12251225
<b>Note:</b> It is allowed that <code>it</code> be a <code>const_iterator</code>
1226-
and the restored <code>it'</code> an <code>iterator</code>, or viceversa.
1226+
and the restored <code>it'</code> an <code>iterator</code>, or vice versa.
12271227
</blockquote>
12281228

12291229
<hr>

0 commit comments

Comments
 (0)