mirror of
https://github.com/boostorg/geometry.git
synced 2025-05-12 14:01:47 +00:00
26e9526564
rtree::box() renamed to rtree::envelope() index::box() renamed to index::envelope() some unneeded tests removed docs updated [SVN r82546]
56 lines
1.9 KiB
Plaintext
56 lines
1.9 KiB
Plaintext
[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
|
|
[/ Generated from xml/classboost_1_1geometry_1_1index_1_1translator_1_1index.xml]
|
|
[#classboost_1_1geometry_1_1index_1_1translator_1_1index]
|
|
[section:boost_geometry_index_translator_index boost::geometry::index::translator::index]
|
|
|
|
'''<indexterm><primary>boost</primary></indexterm><indexterm><primary>geometry</primary></indexterm><indexterm><primary>index</primary></indexterm><indexterm><primary>translator</primary></indexterm><indexterm><primary>index</primary></indexterm>'''
|
|
The index translator.
|
|
|
|
[heading Description]
|
|
This translator translates from index of an element in an external Container to the Indexable. The container should have operator[](size\u005ftype) defined. Index translator uses [link structboost_1_1geometry_1_1index_1_1translator_1_1def translator::def]<...> to translate from Container::value\u005ftype to the Indexable which means that it can handle Indexables, std::pairs and boost::tuples stored in an external Container.
|
|
|
|
[heading Header]
|
|
`#include <boost/geometry/index/translator/index.hpp>`
|
|
|
|
[heading Synopsis]
|
|
[pre
|
|
`template<``typename Container``>`
|
|
`class index`
|
|
`{`
|
|
` // ...`
|
|
`};`
|
|
]
|
|
|
|
[heading Template parameter(s)]
|
|
[table
|
|
[[Parameter] [Description]]
|
|
[[`Container`][The Container type. ]]
|
|
]
|
|
|
|
[heading Constructor(s) and destructor]
|
|
[table
|
|
[[Function][Description]]
|
|
[[[link classboost_1_1geometry_1_1index_1_1translator_1_1index_1a87e7e498c20aa3bf38e350a6ab19e736 `index(Container const &)`]][The constructor. ]]
|
|
]
|
|
|
|
[#classboost_1_1geometry_1_1index_1_1translator_1_1index_1a87e7e498c20aa3bf38e350a6ab19e736]
|
|
[section index(Container const &)]
|
|
The constructor.
|
|
|
|
[heading Synopsis]
|
|
[pre
|
|
|
|
`index``(``Container const &` `c``)`
|
|
]
|
|
|
|
[heading Modifier(s)]
|
|
``explicit ``[heading Parameter(s)]
|
|
[table
|
|
[[Type][Name][Description]]
|
|
[[`Container const &`][ `c` ][The container which stores indexed values. ]]
|
|
]
|
|
[endsect]
|
|
|
|
[endsect]
|
|
|