Imported Upstream version 1.63.0
[platform/upstream/boost.git] / libs / geometry / doc / doxy / doxygen_output / xml / classboost_1_1geometry_1_1strategy_1_1simplify_1_1douglas__peucker.xml
1 <?xml version='1.0' encoding='UTF-8' standalone='no'?>
2 <doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.6">
3   <compounddef id="classboost_1_1geometry_1_1strategy_1_1simplify_1_1douglas__peucker" kind="class" prot="public">
4     <compoundname>boost::geometry::strategy::simplify::douglas_peucker</compoundname>
5     <includes local="no">simplify_douglas_peucker.hpp</includes>
6     <templateparamlist>
7       <param>
8         <type>typename Point</type>
9       </param>
10       <param>
11         <type>typename PointDistanceStrategy</type>
12       </param>
13     </templateparamlist>
14       <sectiondef kind="public-type">
15       <memberdef kind="typedef" id="classboost_1_1geometry_1_1strategy_1_1simplify_1_1douglas__peucker_1a4e01b2b1229b52edc649e05b97b52164" prot="public" static="no">
16         <type>PointDistanceStrategy</type>
17         <definition>typedef PointDistanceStrategy boost::geometry::strategy::simplify::douglas_peucker&lt; Point, PointDistanceStrategy &gt;::distance_strategy_type</definition>
18         <argsstring></argsstring>
19         <name>distance_strategy_type</name>
20         <briefdescription>
21         </briefdescription>
22         <detaileddescription>
23         </detaileddescription>
24         <inbodydescription>
25         </inbodydescription>
26         <location file="/home/ubuntu/boost/boost/geometry/strategies/agnostic/simplify_douglas_peucker.hpp" line="271" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/strategies/agnostic/simplify_douglas_peucker.hpp" bodystart="271" bodyend="-1"/>
27       </memberdef>
28       <memberdef kind="typedef" id="classboost_1_1geometry_1_1strategy_1_1simplify_1_1douglas__peucker_1aada9cdf3dd206cda7e45da4a2f74850e" prot="public" static="no">
29         <type>detail::douglas_peucker&lt; Point, PointDistanceStrategy &gt;::<ref refid="classboost_1_1geometry_1_1strategy_1_1simplify_1_1douglas__peucker_1aada9cdf3dd206cda7e45da4a2f74850e" kindref="member">distance_type</ref></type>
30         <definition>typedef detail::douglas_peucker&lt; Point, PointDistanceStrategy &gt;::distance_type boost::geometry::strategy::simplify::douglas_peucker&lt; Point, PointDistanceStrategy &gt;::distance_type</definition>
31         <argsstring></argsstring>
32         <name>distance_type</name>
33         <briefdescription>
34         </briefdescription>
35         <detaileddescription>
36         </detaileddescription>
37         <inbodydescription>
38         </inbodydescription>
39         <location file="/home/ubuntu/boost/boost/geometry/strategies/agnostic/simplify_douglas_peucker.hpp" line="277" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/strategies/agnostic/simplify_douglas_peucker.hpp" bodystart="277" bodyend="-1"/>
40       </memberdef>
41       </sectiondef>
42       <sectiondef kind="public-static-func">
43       <memberdef kind="function" id="classboost_1_1geometry_1_1strategy_1_1simplify_1_1douglas__peucker_1a6f9b4b0c960f624bf702f8418daaabfc" prot="public" static="yes" const="no" explicit="no" inline="yes" virt="non-virtual">
44         <templateparamlist>
45           <param>
46             <type>typename Range</type>
47           </param>
48           <param>
49             <type>typename OutputIterator</type>
50           </param>
51         </templateparamlist>
52         <type>OutputIterator</type>
53         <definition>static OutputIterator boost::geometry::strategy::simplify::douglas_peucker&lt; Point, PointDistanceStrategy &gt;::apply</definition>
54         <argsstring>(Range const &amp;range, OutputIterator out, distance_type const &amp;max_distance)</argsstring>
55         <name>apply</name>
56         <param>
57           <type>Range const &amp;</type>
58           <declname>range</declname>
59         </param>
60         <param>
61           <type>OutputIterator</type>
62           <declname>out</declname>
63         </param>
64         <param>
65           <type><ref refid="classboost_1_1geometry_1_1strategy_1_1simplify_1_1douglas__peucker_1aada9cdf3dd206cda7e45da4a2f74850e" kindref="member">distance_type</ref> const &amp;</type>
66           <declname>max_distance</declname>
67         </param>
68         <briefdescription>
69         </briefdescription>
70         <detaileddescription>
71         </detaileddescription>
72         <inbodydescription>
73         </inbodydescription>
74         <location file="/home/ubuntu/boost/boost/geometry/strategies/agnostic/simplify_douglas_peucker.hpp" line="280" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/strategies/agnostic/simplify_douglas_peucker.hpp" bodystart="280" bodyend="301"/>
75       </memberdef>
76       </sectiondef>
77     <briefdescription>
78 <para>Implements the simplify algorithm. </para>    </briefdescription>
79     <detaileddescription>
80 <para>The <ref refid="classboost_1_1geometry_1_1strategy_1_1simplify_1_1douglas__peucker" kindref="compound">douglas_peucker</ref> strategy simplifies a linestring, ring or vector of points using the well-known Douglas-Peucker algorithm. <parameterlist kind="templateparam"><parameteritem>
81 <parameternamelist>
82 <parametername>Point</parametername>
83 </parameternamelist>
84 <parameterdescription>
85 <para>the point type </para></parameterdescription>
86 </parameteritem>
87 <parameteritem>
88 <parameternamelist>
89 <parametername>PointDistanceStrategy</parametername>
90 </parameternamelist>
91 <parameterdescription>
92 <para>point-segment distance strategy to be used </para></parameterdescription>
93 </parameteritem>
94 </parameterlist>
95 <simplesect kind="note"><para>This strategy uses itself a point-segment-distance strategy which can be specified </para></simplesect>
96 <simplesect kind="author"><para>Barend and Maarten, 1995/1996 </para><simplesectsep/><para>Barend, revised for Generic Geometry Library, 2008 </para></simplesect>
97 </para>    </detaileddescription>
98     <location file="/home/ubuntu/boost/boost/geometry/strategies/agnostic/simplify_douglas_peucker.hpp" line="268" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/strategies/agnostic/simplify_douglas_peucker.hpp" bodystart="267" bodyend="303"/>
99     <listofallmembers>
100       <member refid="classboost_1_1geometry_1_1strategy_1_1simplify_1_1douglas__peucker_1a6f9b4b0c960f624bf702f8418daaabfc" prot="public" virt="non-virtual"><scope>boost::geometry::strategy::simplify::douglas_peucker</scope><name>apply</name></member>
101       <member refid="classboost_1_1geometry_1_1strategy_1_1simplify_1_1douglas__peucker_1a4e01b2b1229b52edc649e05b97b52164" prot="public" virt="non-virtual"><scope>boost::geometry::strategy::simplify::douglas_peucker</scope><name>distance_strategy_type</name></member>
102       <member refid="classboost_1_1geometry_1_1strategy_1_1simplify_1_1douglas__peucker_1aada9cdf3dd206cda7e45da4a2f74850e" prot="public" virt="non-virtual"><scope>boost::geometry::strategy::simplify::douglas_peucker</scope><name>distance_type</name></member>
103     </listofallmembers>
104   </compounddef>
105 </doxygen>