summaryrefslogtreecommitdiff
path: root/libs/geometry/doc/reference/algorithms/append.qbk
blob: 22dbb561aec6f096be7942c2c79c26ec6f1c2475 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
[/============================================================================
  Boost.Geometry (aka GGL, Generic Geometry Library)

  Copyright (c) 2009-2014 Barend Gehrels, Amsterdam, the Netherlands.
  Copyright (c) 2009-2014 Mateusz Loskot, London, UK.
  Copyright (c) 2009-2014 Bruno Lalande, Paris, France.

  This file was modified by Oracle on 2014.
  Modifications copyright (c) 2014, Oracle and/or its affiliates.

  Contributed and/or modified by Menelaos Karavelas, on behalf of Oracle

  Use, modification and distribution is subject to the Boost Software License,
  Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
  http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]

[def __this_function__ append]

[heading_conformance_no_ogc __this_function__]

[include reference/status/append_status.qbk]

[heading Behavior]
[table
[[Case] [Behavior] ]
[[__point__, __box__, __segment__][Compiles, but no action]]
[[__linestring__][Appends point or range to the end of the linestring]]
[[__ring__][Appends point or range to the end of the ring (without explicitly closing it)]]
[[__polygon__][Appends point or range to the end of the polygon (without explicitly closing it), 
	either the exterior ring (the default) or specify a zero-based index for one of the interior rings. 
	In the last case, the interior rings are not resized automatically, 
	so ensure that the zero-based index is smaller than the number of interior rings]]
[[__multi_linestring__][Appends point or range to the end of the
        linestring with the given multi index.
        The multi-linestring is not resized automatically, so ensure
        that the multi index is smaller than then number of linestring
        in the multi-linestring.]]
[[__multi_polygon__][Appends point or range to the end of the polygon
        (without explicitly closing it) with the given multi-index.
        The point or range is appended at the end of the
        exterior ring (the default) or specify a zero-based ring index for
        the interior rings.
        The multi-polygon is not resized automatically, so ensure
        that the multi index is smaller than then number of polygon
        in the multi-polygon. The same applies for the interior rings
        of the polygon: the interior rings are not resized
        automatically, so ensure that the zero-based ring index is
        smaller than the number of interior rings of the polygon.]]
]

[heading Complexity]
Linear

[heading Example]
[append]
[append_output]

[heading See also]
* [link geometry.reference.algorithms.assign.assign_points assign]