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/classboost_1_1geometry_1_1model_1_1point.xml] 16[section:model_point model::point] 17 18'''<indexterm><primary>model</primary></indexterm><indexterm><primary>point</primary></indexterm>''' 19Basic point class, having coordinates defined in a neutral way. 20 21[heading Description] 22Defines a neutral point class, fulfilling the Point Concept. Library users can use this point class, or use their own point classes. This point class is used in most of the samples and tests of Boost.Geometry This point class is used occasionally within the library, where a temporary point class is necessary. 23 24[heading Model of] 25[link geometry.reference.concepts.concept_point Point Concept] 26 27[heading Synopsis] 28``template<typename CoordinateType, std::size_t DimensionCount, typename CoordinateSystem> 29class model::point 30{ 31 // ... 32}; 33`` 34 35[heading Template parameter(s)] 36[table 37[[Parameter] [Description]] 38[[typename CoordinateType] [numerical type (int, double, ttmath, ...) ]] 39[[std::size_t DimensionCount] [number of coordinates, usually 2 or 3 ]] 40[[typename CoordinateSystem] [coordinate system, for example cs::cartesian]] 41] 42 43[heading Constructor(s)] 44[table 45[[Function] [Description] [Parameters] ] 46[[``point()`` 47 48] [Default constructor, no initialization. ] [ 49 50]] 51[[``point(CoordinateType const & v0)`` 52 53] [Constructor to set one value. ] [[* CoordinateType const &]: ['v0]: 54 55 56 57]] 58[[``point(CoordinateType const & v0, CoordinateType const & v1)`` 59 60] [Constructor to set two values. ] [[* CoordinateType const &]: ['v0]: 61 62[* CoordinateType const &]: ['v1]: 63 64 65 66]] 67[[``point(CoordinateType const & v0, CoordinateType const & v1, CoordinateType const & v2)`` 68 69] [Constructor to set three values. ] [[* CoordinateType const &]: ['v0]: 70 71[* CoordinateType const &]: ['v1]: 72 73[* CoordinateType const &]: ['v2]: 74 75 76 77]] 78] 79 80[heading Member Function(s)] 81[table 82[[Function] [Description] [Parameters] [Returns]] 83[[``template<std::size_t K> 84CoordinateType const & get()`` 85 86] [Get a coordinate. ] [ 87 88][ 89the coordinate 90 91] 92] 93[[``template<std::size_t K> 94void set(CoordinateType const & value)`` 95 96] [Set a coordinate. ] [[* CoordinateType const &]: ['value]: value to set 97 98 99 100][ 101 102] 103] 104] 105 106[heading Header] 107Either 108 109`#include <boost/geometry/geometries/geometries.hpp>` 110 111 112Or 113 114`#include <boost/geometry/geometries/point.hpp>` 115 116[include reference/geometries/point.qbk] 117 118[endsect] 119 120