• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1[/============================================================================
2  Boost.Geometry (aka GGL, Generic Geometry Library)
3
4  Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands.
5  Copyright (c) 2008-2013 Bruno Lalande, Paris, France.
6  Copyright (c) 2009-2013 Mateusz Loskot, London, UK.
7
8  Use, modification and distribution is subject to the Boost Software License,
9  Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
10  http://www.boost.org/LICENSE_1_0.txt)
11=============================================================================/]
12
13
14[/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically]
15[/ Generated from doxy/doxygen_output/xml/group__register.xml]
16[section:boost_geometry_register_box BOOST_GEOMETRY_REGISTER_BOX]
17
18'''<indexterm><primary>BOOST_GEOMETRY_REGISTER_BOX</primary></indexterm>'''
19Macro to register a box.
20
21[heading Description]
22The macro BOOST\u005fGEOMETRY\u005fREGISTER\u005fBOX registers a box such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified type. The box may contain template parameters, which must be specified then.
23
24[heading Synopsis]
25``#define BOOST_GEOMETRY_REGISTER_BOX(Box, Point, MinCorner,
26                             MaxCorner)``
27
28[heading Parameters]
29
30[table
31[[Name] [Description] ]
32[[Box] [Box type to be registered ]]
33[[Point] [Point type on which box is based. Might be two or three-dimensional ]]
34[[MinCorner] [minimum corner (should be public member or method) ]]
35[[MaxCorner] [maximum corner (should be public member or method)]]
36]
37
38
39[heading Header]
40`#include <boost/geometry/geometries/register/box.hpp>`
41
42[heading Example]
43[register_box]
44[register_box_output]
45
46
47[endsect]
48
49[section:boost_geometry_register_box_2d_4values BOOST_GEOMETRY_REGISTER_BOX_2D_4VALUES]
50
51'''<indexterm><primary>BOOST_GEOMETRY_REGISTER_BOX_2D_4VALUES</primary></indexterm>'''
52Macro to register a box.
53
54[heading Description]
55The macro BOOST\u005fGEOMETRY\u005fREGISTER\u005fBOX\u005f2D\u005f4VALUES registers a box such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified type.
56
57[heading Synopsis]
58``#define BOOST_GEOMETRY_REGISTER_BOX_2D_4VALUES(Box, Point, Left,
59                                        Bottom, Right, Top)``
60
61[heading Parameters]
62
63[table
64[[Name] [Description] ]
65[[Box] [Box type to be registered ]]
66[[Point] [Point type reported as point_type by box. Must be two dimensional. Note that these box tyeps do not contain points, but they must have a related point_type ]]
67[[Left] [Left side (must be public member or method) ]]
68[[Bottom] [Bottom side (must be public member or method) ]]
69[[Right] [Right side (must be public member or method) ]]
70[[Top] [Top side (must be public member or method)]]
71]
72
73
74[heading Header]
75`#include <boost/geometry/geometries/register/box.hpp>`
76
77[heading Example]
78[register_box_2d_4values]
79[register_box_2d_4values_output]
80
81
82[endsect]
83
84[section:boost_geometry_register_box_templated BOOST_GEOMETRY_REGISTER_BOX_TEMPLATED]
85
86'''<indexterm><primary>BOOST_GEOMETRY_REGISTER_BOX_TEMPLATED</primary></indexterm>'''
87Macro to register a box.
88
89[heading Description]
90The macro BOOST\u005fGEOMETRY\u005fREGISTER\u005fBOX\u005fTEMPLATED registers a box such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified type. The type must have one template parameter, which should be a point type, and should not be specified. Boost.Geometry takes care of inserting the template parameter. Hence all types of this templated box are registered, regardless of their point type.
91
92[heading Synopsis]
93``#define BOOST_GEOMETRY_REGISTER_BOX_TEMPLATED(Box, MinCorner, MaxCorner)``
94
95[heading Parameters]
96
97[table
98[[Name] [Description] ]
99[[Box] [Box type to be registered ]]
100[[MinCorner] [minimum corner (should be public member or method) ]]
101[[MaxCorner] [maximum corner (should be public member or method)]]
102]
103
104
105[heading Header]
106`#include <boost/geometry/geometries/register/box.hpp>`
107
108[heading Example]
109[register_box_templated]
110[register_box_templated_output]
111
112
113[endsect]
114
115[section:boost_geometry_register_linestring BOOST_GEOMETRY_REGISTER_LINESTRING]
116
117'''<indexterm><primary>BOOST_GEOMETRY_REGISTER_LINESTRING</primary></indexterm>'''
118Macro to register a linestring.
119
120[heading Description]
121The macro BOOST\u005fGEOMETRY\u005fREGISTER\u005fLINESTRING registers a linestring such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified type. The linestring may contain template parameters, which must be specified then.
122
123[heading Synopsis]
124``#define BOOST_GEOMETRY_REGISTER_LINESTRING(Linestring)``
125
126[heading Parameters]
127
128[table
129[[Name] [Description] ]
130[[Linestring] [linestring type to be registered]]
131]
132
133
134[heading Header]
135`#include <boost/geometry/geometries/register/linestring.hpp>`
136
137[heading Example]
138[register_linestring]
139[register_linestring_output]
140
141
142[endsect]
143
144[section:boost_geometry_register_linestring_templated BOOST_GEOMETRY_REGISTER_LINESTRING_TEMPLATED]
145
146'''<indexterm><primary>BOOST_GEOMETRY_REGISTER_LINESTRING_TEMPLATED</primary></indexterm>'''
147Macro to register a templated linestring.
148
149[heading Description]
150The macro BOOST\u005fGEOMETRY\u005fREGISTER\u005fLINESTRING\u005fTEMPLATED registers a templated linestring such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified type. The type must have one template parameter, which should be a point type, and should not be specified. Boost.Geometry takes care of inserting the template parameter. Hence all types of this templated linestring are registered, regardless of their point type.
151
152[heading Synopsis]
153``#define BOOST_GEOMETRY_REGISTER_LINESTRING_TEMPLATED(Linestring)``
154
155[heading Parameters]
156
157[table
158[[Name] [Description] ]
159[[Linestring] [linestring (without template parameters) type to be registered]]
160]
161
162
163[heading Header]
164`#include <boost/geometry/geometries/register/linestring.hpp>`
165
166[heading Example]
167[register_linestring_templated]
168[register_linestring_templated_output]
169
170
171[endsect]
172
173[section:boost_geometry_register_multi_linestring BOOST_GEOMETRY_REGISTER_MULTI_LINESTRING]
174
175'''<indexterm><primary>BOOST_GEOMETRY_REGISTER_MULTI_LINESTRING</primary></indexterm>'''
176Macro to register a multi\u005flinestring.
177
178[heading Description]
179The macro BOOST\u005fGEOMETRY\u005fREGISTER\u005fMULTI\u005fLINESTRING registers a multi\u005flinestring such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified type. The multi\u005flinestring may contain template parameters, which must be specified then.
180
181[heading Synopsis]
182``#define BOOST_GEOMETRY_REGISTER_MULTI_LINESTRING(MultiLineString)``
183
184[heading Parameters]
185
186[table
187[[Name] [Description] ]
188[[MultiLineString] [multi_linestring type to be registered]]
189]
190
191
192[heading Header]
193`#include <boost/geometry/geometries/register/multi_linestring.hpp>`
194
195[heading Example]
196[register_multi_linestring]
197[register_multi_linestring_output]
198
199
200[endsect]
201
202[section:boost_geometry_register_multi_linestring_templated BOOST_GEOMETRY_REGISTER_MULTI_LINESTRING_TEMPLATED]
203
204'''<indexterm><primary>BOOST_GEOMETRY_REGISTER_MULTI_LINESTRING_TEMPLATED</primary></indexterm>'''
205Macro to register a templated multi\u005flinestring.
206
207[heading Description]
208The macro BOOST\u005fGEOMETRY\u005fREGISTER\u005fMULTI\u005fLINESTRING\u005fTEMPLATED registers a templated multi\u005flinestring such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified type. The type must have one template parameter, which should be a linestring type, and should not be specified. Boost.Geometry takes care of inserting the template parameter. Hence all types of this templated multi\u005flinestring are registered, regardless of their point type.
209
210[heading Synopsis]
211``#define BOOST_GEOMETRY_REGISTER_MULTI_LINESTRING_TEMPLATED(MultiLineString)``
212
213[heading Parameters]
214
215[table
216[[Name] [Description] ]
217[[MultiLineString] [multi_linestring (without template parameters) type to be registered]]
218]
219
220
221[heading Header]
222`#include <boost/geometry/geometries/register/multi_linestring.hpp>`
223
224[heading Example]
225[register_multi_linestring_templated]
226[register_multi_linestring_templated_output]
227
228
229[endsect]
230
231[section:boost_geometry_register_multi_point BOOST_GEOMETRY_REGISTER_MULTI_POINT]
232
233'''<indexterm><primary>BOOST_GEOMETRY_REGISTER_MULTI_POINT</primary></indexterm>'''
234Macro to register a multi\u005fpoint.
235
236[heading Description]
237The macro BOOST\u005fGEOMETRY\u005fREGISTER\u005fMULTI\u005fPOINT registers a multi\u005fpoint such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified type. The multi\u005fpoint may contain template parameters, which must be specified then.
238
239[heading Synopsis]
240``#define BOOST_GEOMETRY_REGISTER_MULTI_POINT(MultiPoint)``
241
242[heading Parameters]
243
244[table
245[[Name] [Description] ]
246[[MultiPoint] [multi_point type to be registered]]
247]
248
249
250[heading Header]
251`#include <boost/geometry/geometries/register/multi_point.hpp>`
252
253[heading Example]
254[register_multi_point]
255[register_multi_point_output]
256
257
258[endsect]
259
260[section:boost_geometry_register_multi_point_templated BOOST_GEOMETRY_REGISTER_MULTI_POINT_TEMPLATED]
261
262'''<indexterm><primary>BOOST_GEOMETRY_REGISTER_MULTI_POINT_TEMPLATED</primary></indexterm>'''
263Macro to register a templated multi\u005fpoint.
264
265[heading Description]
266The macro BOOST\u005fGEOMETRY\u005fREGISTER\u005fMULTI\u005fPOINT\u005fTEMPLATED registers a templated multi\u005fpoint such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified type. The type must have one template parameter, which should be a point type, and should not be specified. Boost.Geometry takes care of inserting the template parameter. Hence all types of this templated multi\u005fpoint are registered, regardless of their point type.
267
268[heading Synopsis]
269``#define BOOST_GEOMETRY_REGISTER_MULTI_POINT_TEMPLATED(MultiPoint)``
270
271[heading Parameters]
272
273[table
274[[Name] [Description] ]
275[[MultiPoint] [multi_point (without template parameters) type to be registered]]
276]
277
278
279[heading Header]
280`#include <boost/geometry/geometries/register/multi_point.hpp>`
281
282[heading Example]
283[register_multi_point_templated]
284[register_multi_point_templated_output]
285
286
287[endsect]
288
289[section:boost_geometry_register_multi_polygon BOOST_GEOMETRY_REGISTER_MULTI_POLYGON]
290
291'''<indexterm><primary>BOOST_GEOMETRY_REGISTER_MULTI_POLYGON</primary></indexterm>'''
292Macro to register a multi\u005fpolygon.
293
294[heading Description]
295The macro BOOST\u005fGEOMETRY\u005fREGISTER\u005fMULTI\u005fPOLYGON registers a multi\u005fpolygon such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified type. The multi\u005fpolygon may contain template parameters, which must be specified then.
296
297[heading Synopsis]
298``#define BOOST_GEOMETRY_REGISTER_MULTI_POLYGON(MultiPolygon)``
299
300[heading Parameters]
301
302[table
303[[Name] [Description] ]
304[[MultiPolygon] [multi_polygon type to be registered]]
305]
306
307
308[heading Header]
309`#include <boost/geometry/geometries/register/multi_polygon.hpp>`
310
311[heading Example]
312[register_multi_polygon]
313[register_multi_polygon_output]
314
315
316[endsect]
317
318[section:boost_geometry_register_multi_polygon_templated BOOST_GEOMETRY_REGISTER_MULTI_POLYGON_TEMPLATED]
319
320'''<indexterm><primary>BOOST_GEOMETRY_REGISTER_MULTI_POLYGON_TEMPLATED</primary></indexterm>'''
321Macro to register a templated multi\u005fpolygon.
322
323[heading Description]
324The macro BOOST\u005fGEOMETRY\u005fREGISTER\u005fMULTI\u005fPOLYGON\u005fTEMPLATED registers a templated multi\u005fpolygon such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified type. The type must have one template parameter, which should be a polygon type, and should not be specified. Boost.Geometry takes care of inserting the template parameter. Hence all types of this templated multi\u005fpolygon are registered, regardless of their point type.
325
326[heading Synopsis]
327``#define BOOST_GEOMETRY_REGISTER_MULTI_POLYGON_TEMPLATED(MultiPolygon)``
328
329[heading Parameters]
330
331[table
332[[Name] [Description] ]
333[[MultiPolygon] [multi_polygon (without template parameters) type to be registered]]
334]
335
336
337[heading Header]
338`#include <boost/geometry/geometries/register/multi_polygon.hpp>`
339
340[heading Example]
341[register_multi_polygon_templated]
342[register_multi_polygon_templated_output]
343
344
345[endsect]
346
347[section:boost_geometry_register_point_2d BOOST_GEOMETRY_REGISTER_POINT_2D]
348
349'''<indexterm><primary>BOOST_GEOMETRY_REGISTER_POINT_2D</primary></indexterm>'''
350Macro to register a 2D point type.
351
352[heading Description]
353The macro BOOST\u005fGEOMETRY\u005fREGISTER\u005fPOINT\u005f2D registers a two-dimensional point type such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified type.
354
355[heading Synopsis]
356``#define BOOST_GEOMETRY_REGISTER_POINT_2D(Point, CoordinateType, CoordinateSystem,
357                                  Field0, Field1)``
358
359[heading Parameters]
360
361[table
362[[Name] [Description] ]
363[[Point] [Point type to be registered ]]
364[[CoordinateType] [Type of the coordinates of the point (e.g. double) ]]
365[[CoordinateSystem] [Coordinate system (e.g. cs::cartesian) ]]
366[[Field0] [Member containing first (usually x) coordinate ]]
367[[Field1] [Member containing second (usually y) coordinate]]
368]
369
370
371[heading Header]
372`#include <boost/geometry/geometries/register/point.hpp>`
373
374[include reference/geometries/register/point.qbk]
375
376
377[endsect]
378
379[section:boost_geometry_register_point_2d_const BOOST_GEOMETRY_REGISTER_POINT_2D_CONST]
380
381'''<indexterm><primary>BOOST_GEOMETRY_REGISTER_POINT_2D_CONST</primary></indexterm>'''
382Macro to register a 2D point type (const version)
383
384[heading Description]
385The macro BOOST\u005fGEOMETRY\u005fREGISTER\u005fPOINT\u005f2D\u005fCONST registers a two-dimensional point type such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified type.. The const version registers only read access to the fields, the point type is therefore read-only
386
387[heading Synopsis]
388``#define BOOST_GEOMETRY_REGISTER_POINT_2D_CONST(Point, CoordinateType, CoordinateSystem,
389                                        Field0, Field1)``
390
391[heading Parameters]
392
393[table
394[[Name] [Description] ]
395[[Point] [Point type to be registered ]]
396[[CoordinateType] [Type of the coordinates of the point (e.g. double) ]]
397[[CoordinateSystem] [Coordinate system (e.g. cs::cartesian) ]]
398[[Field0] [Member containing first (usually x) coordinate ]]
399[[Field1] [Member containing second (usually y) coordinate ]]
400]
401
402
403[heading Header]
404`#include <boost/geometry/geometries/register/point.hpp>`
405
406
407[endsect]
408
409[section:boost_geometry_register_point_2d_get_set BOOST_GEOMETRY_REGISTER_POINT_2D_GET_SET]
410
411'''<indexterm><primary>BOOST_GEOMETRY_REGISTER_POINT_2D_GET_SET</primary></indexterm>'''
412Macro to register a 2D point type (having separate get/set methods)
413
414[heading Description]
415The macro BOOST\u005fGEOMETRY\u005fREGISTER\u005fPOINT\u005f2D\u005fGET\u005fSET registers a two-dimensional point type such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified type.. The get/set version registers get and set methods separately and can be used for classes with protected member variables and get/set methods to change coordinates
416
417[heading Synopsis]
418``#define BOOST_GEOMETRY_REGISTER_POINT_2D_GET_SET(Point, CoordinateType, CoordinateSystem,
419                                          Get0, Get1, Set0,
420                                          Set1)``
421
422[heading Parameters]
423
424[table
425[[Name] [Description] ]
426[[Point] [Point type to be registered ]]
427[[CoordinateType] [Type of the coordinates of the point (e.g. double) ]]
428[[CoordinateSystem] [Coordinate system (e.g. cs::cartesian) ]]
429[[Get0] [Method to get the first (usually x) coordinate ]]
430[[Get1] [Method to get the second (usually y) coordinate ]]
431[[Set0] [Method to set the first (usually x) coordinate ]]
432[[Set1] [Method to set the second (usually y) coordinate ]]
433]
434
435
436[heading Header]
437`#include <boost/geometry/geometries/register/point.hpp>`
438
439
440[endsect]
441
442[section:boost_geometry_register_point_3d BOOST_GEOMETRY_REGISTER_POINT_3D]
443
444'''<indexterm><primary>BOOST_GEOMETRY_REGISTER_POINT_3D</primary></indexterm>'''
445Macro to register a 3D point type.
446
447[heading Description]
448The macro BOOST\u005fGEOMETRY\u005fREGISTER\u005fPOINT\u005f3D registers a three-dimensional point type such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified type.
449
450[heading Synopsis]
451``#define BOOST_GEOMETRY_REGISTER_POINT_3D(Point, CoordinateType, CoordinateSystem,
452                                  Field0, Field1, Field2)``
453
454[heading Parameters]
455
456[table
457[[Name] [Description] ]
458[[Point] [Point type to be registered ]]
459[[CoordinateType] [Type of the coordinates of the point (e.g. double) ]]
460[[CoordinateSystem] [Coordinate system (e.g. cs::cartesian) ]]
461[[Field0] [Member containing first (usually x) coordinate ]]
462[[Field1] [Member containing second (usually y) coordinate ]]
463[[Field2] [Member containing third (usually z) coordinate ]]
464]
465
466
467[heading Header]
468`#include <boost/geometry/geometries/register/point.hpp>`
469
470
471[endsect]
472
473[section:boost_geometry_register_point_3d_const BOOST_GEOMETRY_REGISTER_POINT_3D_CONST]
474
475'''<indexterm><primary>BOOST_GEOMETRY_REGISTER_POINT_3D_CONST</primary></indexterm>'''
476Macro to register a 3D point type (const version)
477
478[heading Description]
479The macro BOOST\u005fGEOMETRY\u005fREGISTER\u005fPOINT\u005f3D\u005fCONST registers a three-dimensional point type such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified type.. The const version registers only read access to the fields, the point type is therefore read-only
480
481[heading Synopsis]
482``#define BOOST_GEOMETRY_REGISTER_POINT_3D_CONST(Point, CoordinateType, CoordinateSystem,
483                                        Field0, Field1, Field2)``
484
485[heading Parameters]
486
487[table
488[[Name] [Description] ]
489[[Point] [Point type to be registered ]]
490[[CoordinateType] [Type of the coordinates of the point (e.g. double) ]]
491[[CoordinateSystem] [Coordinate system (e.g. cs::cartesian) ]]
492[[Field0] [Member containing first (usually x) coordinate ]]
493[[Field1] [Member containing second (usually y) coordinate ]]
494[[Field2] [Member containing third (usually z) coordinate ]]
495]
496
497
498[heading Header]
499`#include <boost/geometry/geometries/register/point.hpp>`
500
501
502[endsect]
503
504[section:boost_geometry_register_point_3d_get_set BOOST_GEOMETRY_REGISTER_POINT_3D_GET_SET]
505
506'''<indexterm><primary>BOOST_GEOMETRY_REGISTER_POINT_3D_GET_SET</primary></indexterm>'''
507Macro to register a 3D point type (having separate get/set methods)
508
509[heading Description]
510The macro BOOST\u005fGEOMETRY\u005fREGISTER\u005fPOINT\u005f3D\u005fGET\u005fSET registers a three-dimensional point type such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified type.. The get/set version registers get and set methods separately and can be used for classes with protected member variables and get/set methods to change coordinates
511
512[heading Synopsis]
513``#define BOOST_GEOMETRY_REGISTER_POINT_3D_GET_SET(Point, CoordinateType, CoordinateSystem,
514                                          Get0, Get1, Get2,
515                                          Set0, Set1, Set2)``
516
517[heading Parameters]
518
519[table
520[[Name] [Description] ]
521[[Point] [Point type to be registered ]]
522[[CoordinateType] [Type of the coordinates of the point (e.g. double) ]]
523[[CoordinateSystem] [Coordinate system (e.g. cs::cartesian) ]]
524[[Get0] [Method to get the first (usually x) coordinate ]]
525[[Get1] [Method to get the second (usually y) coordinate ]]
526[[Get2] [Method to get the third (usually z) coordinate ]]
527[[Set0] [Method to set the first (usually x) coordinate ]]
528[[Set1] [Method to set the second (usually y) coordinate ]]
529[[Set2] [Method to set the third (usually z) coordinate ]]
530]
531
532
533[heading Header]
534`#include <boost/geometry/geometries/register/point.hpp>`
535
536
537[endsect]
538
539[section:boost_geometry_register_ring BOOST_GEOMETRY_REGISTER_RING]
540
541'''<indexterm><primary>BOOST_GEOMETRY_REGISTER_RING</primary></indexterm>'''
542Macro to register a ring.
543
544[heading Description]
545The macro BOOST\u005fGEOMETRY\u005fREGISTER\u005fRING registers a ring such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified type. The ring may contain template parameters, which must be specified then.
546
547[heading Synopsis]
548``#define BOOST_GEOMETRY_REGISTER_RING(Ring)``
549
550[heading Parameters]
551
552[table
553[[Name] [Description] ]
554[[Ring] [ring type to be registered]]
555]
556
557
558[heading Header]
559`#include <boost/geometry/geometries/register/ring.hpp>`
560
561[heading Example]
562[register_ring]
563[register_ring_output]
564
565
566[endsect]
567
568[section:boost_geometry_register_ring_templated BOOST_GEOMETRY_REGISTER_RING_TEMPLATED]
569
570'''<indexterm><primary>BOOST_GEOMETRY_REGISTER_RING_TEMPLATED</primary></indexterm>'''
571Macro to register a templated ring.
572
573[heading Description]
574The macro BOOST\u005fGEOMETRY\u005fREGISTER\u005fRING\u005fTEMPLATED registers a templated ring such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified type. The type must have one template parameter, which should be a point type, and should not be specified. Boost.Geometry takes care of inserting the template parameter. Hence all types of this templated ring are registered, regardless of their point type.
575
576[heading Synopsis]
577``#define BOOST_GEOMETRY_REGISTER_RING_TEMPLATED(Ring)``
578
579[heading Parameters]
580
581[table
582[[Name] [Description] ]
583[[Ring] [ring (without template parameters) type to be registered]]
584]
585
586
587[heading Header]
588`#include <boost/geometry/geometries/register/ring.hpp>`
589
590[heading Example]
591[register_ring_templated]
592[register_ring_templated_output]
593
594
595[endsect]
596
597