Imported Upstream version 1.72.0
[platform/upstream/boost.git] / boost / geometry / srs / projections / proj / putp5.hpp
1 // Boost.Geometry - gis-projections (based on PROJ4)
2
3 // Copyright (c) 2008-2015 Barend Gehrels, Amsterdam, the Netherlands.
4
5 // This file was modified by Oracle on 2017, 2018, 2019.
6 // Modifications copyright (c) 2017-2019, Oracle and/or its affiliates.
7 // Contributed and/or modified by Adam Wulkiewicz, on behalf of Oracle.
8
9 // Use, modification and distribution is subject to the Boost Software License,
10 // Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
11 // http://www.boost.org/LICENSE_1_0.txt)
12
13 // This file is converted from PROJ4, http://trac.osgeo.org/proj
14 // PROJ4 is originally written by Gerald Evenden (then of the USGS)
15 // PROJ4 is maintained by Frank Warmerdam
16 // PROJ4 is converted to Boost.Geometry by Barend Gehrels
17
18 // Last updated version of proj: 5.0.0
19
20 // Original copyright notice:
21
22 // Permission is hereby granted, free of charge, to any person obtaining a
23 // copy of this software and associated documentation files (the "Software"),
24 // to deal in the Software without restriction, including without limitation
25 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
26 // and/or sell copies of the Software, and to permit persons to whom the
27 // Software is furnished to do so, subject to the following conditions:
28
29 // The above copyright notice and this permission notice shall be included
30 // in all copies or substantial portions of the Software.
31
32 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
33 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
34 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
35 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
36 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
37 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
38 // DEALINGS IN THE SOFTWARE.
39
40 #ifndef BOOST_GEOMETRY_PROJECTIONS_PUTP5_HPP
41 #define BOOST_GEOMETRY_PROJECTIONS_PUTP5_HPP
42
43 #include <boost/geometry/srs/projections/impl/base_static.hpp>
44 #include <boost/geometry/srs/projections/impl/base_dynamic.hpp>
45 #include <boost/geometry/srs/projections/impl/projects.hpp>
46 #include <boost/geometry/srs/projections/impl/factory_entry.hpp>
47
48 namespace boost { namespace geometry
49 {
50
51 namespace projections
52 {
53     #ifndef DOXYGEN_NO_DETAIL
54     namespace detail { namespace putp5
55     {
56
57             static const double C = 1.01346;
58             static const double D = 1.2158542;
59
60             template <typename T>
61             struct par_putp5
62             {
63                 T    A, B;
64             };
65
66             template <typename T, typename Parameters>
67             struct base_putp5_spheroid
68             {
69                 par_putp5<T> m_proj_parm;
70
71                 // FORWARD(s_forward)  spheroid
72                 // Project coordinates from geographic (lon, lat) to cartesian (x, y)
73                 inline void fwd(Parameters const& , T const& lp_lon, T const& lp_lat, T& xy_x, T& xy_y) const
74                 {
75                     xy_x = C * lp_lon * (this->m_proj_parm.A - this->m_proj_parm.B * sqrt(1. + D * lp_lat * lp_lat));
76                     xy_y = C * lp_lat;
77                 }
78
79                 // INVERSE(s_inverse)  spheroid
80                 // Project coordinates from cartesian (x, y) to geographic (lon, lat)
81                 inline void inv(Parameters const& , T const& xy_x, T const& xy_y, T& lp_lon, T& lp_lat) const
82                 {
83                     lp_lat = xy_y / C;
84                     lp_lon = xy_x / (C * (this->m_proj_parm.A - this->m_proj_parm.B * sqrt(1. + D * lp_lat * lp_lat)));
85                 }
86
87                 static inline std::string get_name()
88                 {
89                     return "putp5_spheroid";
90                 }
91
92             };
93             
94
95             // Putnins P5
96             template <typename Parameters, typename T>
97             inline void setup_putp5(Parameters& par, par_putp5<T>& proj_parm)
98             {
99                 proj_parm.A = 2.;
100                 proj_parm.B = 1.;
101                 
102                 par.es = 0.;
103             }
104
105             // Putnins P5'
106             template <typename Parameters, typename T>
107             inline void setup_putp5p(Parameters& par, par_putp5<T>& proj_parm)
108             {
109                 proj_parm.A = 1.5;
110                 proj_parm.B = 0.5;
111                 
112                 par.es = 0.;
113             }
114
115     }} // namespace detail::putp5
116     #endif // doxygen
117
118     /*!
119         \brief Putnins P5 projection
120         \ingroup projections
121         \tparam Geographic latlong point type
122         \tparam Cartesian xy point type
123         \tparam Parameters parameter type
124         \par Projection characteristics
125          - Pseudocylindrical
126          - Spheroid
127         \par Example
128         \image html ex_putp5.gif
129     */
130     template <typename T, typename Parameters>
131     struct putp5_spheroid : public detail::putp5::base_putp5_spheroid<T, Parameters>
132     {
133         template <typename Params>
134         inline putp5_spheroid(Params const& , Parameters & par)
135         {
136             detail::putp5::setup_putp5(par, this->m_proj_parm);
137         }
138     };
139
140     /*!
141         \brief Putnins P5' projection
142         \ingroup projections
143         \tparam Geographic latlong point type
144         \tparam Cartesian xy point type
145         \tparam Parameters parameter type
146         \par Projection characteristics
147          - Pseudocylindrical
148          - Spheroid
149         \par Example
150         \image html ex_putp5p.gif
151     */
152     template <typename T, typename Parameters>
153     struct putp5p_spheroid : public detail::putp5::base_putp5_spheroid<T, Parameters>
154     {
155         template <typename Params>
156         inline putp5p_spheroid(Params const& , Parameters & par)
157         {
158             detail::putp5::setup_putp5p(par, this->m_proj_parm);
159         }
160     };
161
162     #ifndef DOXYGEN_NO_DETAIL
163     namespace detail
164     {
165
166         // Static projection
167         BOOST_GEOMETRY_PROJECTIONS_DETAIL_STATIC_PROJECTION_FI(srs::spar::proj_putp5, putp5_spheroid)
168         BOOST_GEOMETRY_PROJECTIONS_DETAIL_STATIC_PROJECTION_FI(srs::spar::proj_putp5p, putp5p_spheroid)
169
170         // Factory entry(s)
171         BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_ENTRY_FI(putp5_entry, putp5_spheroid)
172         BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_ENTRY_FI(putp5p_entry, putp5p_spheroid)
173
174         BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_INIT_BEGIN(putp5_init)
175         {
176             BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_INIT_ENTRY(putp5, putp5_entry)
177             BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_INIT_ENTRY(putp5p, putp5p_entry)
178         }
179
180     } // namespace detail
181     #endif // doxygen
182
183 } // namespace projections
184
185 }} // namespace boost::geometry
186
187 #endif // BOOST_GEOMETRY_PROJECTIONS_PUTP5_HPP
188