rtree docs updated:

introduction fixed,
translator::def<> changed to translator<>.

[SVN r83094]
This commit is contained in:
Adam Wulkiewicz
2013-02-23 04:30:29 +00:00
parent f7849be05d
commit e7211f7b09
5 changed files with 11 additions and 12 deletions

View File

@@ -53,7 +53,7 @@
<p>
R-tree has 4 parameters:
</p>
<pre class="programlisting"><span class="identifier">rtree</span><span class="special">&lt;</span><span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Parameters</span><span class="special">,</span> <span class="identifier">Translator</span> <span class="special">=</span> <span class="identifier">translator</span><span class="special">::</span><span class="identifier">def</span><span class="special">&lt;</span><span class="identifier">Value</span><span class="special">&gt;,</span> <span class="identifier">Allocator</span><span class="special">&gt;</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">allocator</span><span class="special">&lt;</span><span class="identifier">Value</span><span class="special">&gt;</span> <span class="special">&gt;</span>
<pre class="programlisting"><span class="identifier">rtree</span><span class="special">&lt;</span><span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Parameters</span><span class="special">,</span> <span class="identifier">Translator</span> <span class="special">=</span> <span class="identifier">index</span><span class="special">::</span><span class="identifier">translator</span><span class="special">&lt;</span><span class="identifier">Value</span><span class="special">&gt;,</span> <span class="identifier">Allocator</span><span class="special">&gt;</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">allocator</span><span class="special">&lt;</span><span class="identifier">Value</span><span class="special">&gt;</span> <span class="special">&gt;</span>
</pre>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
@@ -87,7 +87,7 @@
in this documentation. Each type adapted to <code class="computeroutput"><a href="http://www.boost.org/libs/geometry/doc/html/geometry/reference/concepts/concept_point.html" target="_top">Point</a></code>
or <code class="computeroutput"><a href="http://www.boost.org/libs/geometry/doc/html/geometry/reference/concepts/concept_box.html" target="_top">Box</a></code>
concept is an <code class="computeroutput">Indexable</code>. <code class="computeroutput">Value</code>s types which can
be handled by the default <code class="computeroutput">Translator</code> - <code class="computeroutput"><span class="identifier">index</span><span class="special">::</span><span class="identifier">translator</span><span class="special">::</span><span class="identifier">def</span><span class="special">&lt;</span>Value<span class="special">&gt;</span></code>
be handled by the default <code class="computeroutput">Translator</code> - <code class="computeroutput"><span class="identifier">index</span><span class="special">::</span><span class="identifier">translator</span><span class="special">&lt;</span>Value<span class="special">&gt;</span></code>
are defined as follows:
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">

View File

@@ -223,7 +223,7 @@
</h5>
<p>
The spatial index was originally started by Federico J. Fernandez during
the Google-Of-Summer project 2008, mentored by Hartmut Kaiser.
the Google Summer of Code 2008 program, mentored by Hartmut Kaiser.
</p>
<h5>
<a name="geometry_index.r_tree.introduction.h3"></a>
@@ -231,9 +231,8 @@
thanks</a>
</h5>
<p>
I'd like to thank Barend Gehrels, Bruno Lalande, Lucanus J. Simonson for
their support and ideas, as well as the members of the Boost.Geometry mailing
list for their help.
I'd like to thank Barend Gehrels, Bruno Lalande, Mateusz &#321;oskot, Lucanus
J. Simonson for their support and ideas.
</p>
<div class="footnotes">
<br><hr style="width:100; align:left;">

View File

@@ -51,7 +51,7 @@
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"><p><small>Last revised: February 22, 2013 at 13:50:49 GMT</small></p></td>
<td align="left"><p><small>Last revised: February 23, 2013 at 04:28:38 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>

View File

@@ -14,7 +14,7 @@
__rtree__ has 4 parameters:
rtree<Value, Parameters, Translator = translator::def<Value>, Allocator> = std::allocator<Value> >
rtree<Value, Parameters, Translator = index::translator<Value>, Allocator> = std::allocator<Value> >
* `__value__` - type of object which will be stored in the container,
* `Parameters` - parameters type, inserting/splitting algorithm,
@@ -29,7 +29,7 @@ __rtree__ has 4 parameters:
__rtree__ may store `__value__`s of any type as long the `__translator__` knows how to interpret those `__value__`s
and extract an object that the __rtree__ can handle. Those objects are called
`__indexable__`s in this documentation. Each type adapted to `__point__` or `__box__` concept is an `__indexable__`.
`__value__`s types which can be handled by the default `__translator__` - `index::translator::def<__value__>`
`__value__`s types which can be handled by the default `__translator__` - `index::translator<__value__>`
are defined as follows:
* `__indexable__ = __point__ | __box__`

View File

@@ -1,4 +1,4 @@
[/============================================================================
[/============================================================================
Boost.Geometry Index
Copyright (c) 2011-2012 Adam Wulkiewicz.
@@ -61,11 +61,11 @@ R-tree depends on *Boost.Move*, *Boost.Container*, *Boost.Tuple*, *Boost.Utility
[heading Contributors]
The spatial index was originally started by Federico J. Fernandez during the Google-Of-Summer project 2008, mentored by Hartmut Kaiser.
The spatial index was originally started by Federico J. Fernandez during the Google Summer of Code 2008 program, mentored by Hartmut Kaiser.
[heading Spatial thanks]
I'd like to thank Barend Gehrels, Bruno Lalande, Lucanus J. Simonson for their support and ideas, as well as the members of the Boost.Geometry mailing list for their help.
I'd like to thank Barend Gehrels, Bruno Lalande, Mateusz Łoskot, Lucanus J. Simonson for their support and ideas.
[endsect]