Imported Upstream version 1.72.0
[platform/upstream/boost.git] / boost / geometry / srs / projections / proj / hatano.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_HATANO_HPP
41 #define BOOST_GEOMETRY_PROJECTIONS_HATANO_HPP
42
43 #include <boost/geometry/util/math.hpp>
44
45 #include <boost/geometry/srs/projections/impl/base_static.hpp>
46 #include <boost/geometry/srs/projections/impl/base_dynamic.hpp>
47 #include <boost/geometry/srs/projections/impl/projects.hpp>
48 #include <boost/geometry/srs/projections/impl/factory_entry.hpp>
49
50 namespace boost { namespace geometry
51 {
52
53 namespace projections
54 {
55     #ifndef DOXYGEN_NO_DETAIL
56     namespace detail { namespace hatano
57     {
58
59             static const int n_iter = 20;
60             static const double epsilon = 1e-7;
61             static const double one_plus_tol = 1.000001;
62             static const double CN_ = 2.67595;
63             static const double CS_ = 2.43763;
64             static const double RCN = 0.37369906014686373063;
65             static const double RCS = 0.41023453108141924738;
66             static const double FYCN = 1.75859;
67             static const double FYCS = 1.93052;
68             static const double RYCN = 0.56863737426006061674;
69             static const double RYCS = 0.51799515156538134803;
70             static const double FXC = 0.85;
71             static const double RXC = 1.17647058823529411764;
72
73             template <typename T, typename Parameters>
74             struct base_hatano_spheroid
75             {
76                 // FORWARD(s_forward)  spheroid
77                 // Project coordinates from geographic (lon, lat) to cartesian (x, y)
78                 inline void fwd(Parameters const& , T const& lp_lon, T lp_lat, T& xy_x, T& xy_y) const
79                 {
80                     T th1, c;
81                     int i;
82
83                     c = sin(lp_lat) * (lp_lat < 0. ? CS_ : CN_);
84                     for (i = n_iter; i; --i) {
85                         lp_lat -= th1 = (lp_lat + sin(lp_lat) - c) / (1. + cos(lp_lat));
86                         if (fabs(th1) < epsilon) break;
87                     }
88                     xy_x = FXC * lp_lon * cos(lp_lat *= .5);
89                     xy_y = sin(lp_lat) * (lp_lat < 0. ? FYCS : FYCN);
90                 }
91
92                 // INVERSE(s_inverse)  spheroid
93                 // Project coordinates from cartesian (x, y) to geographic (lon, lat)
94                 inline void inv(Parameters const& , T const& xy_x, T const& xy_y, T& lp_lon, T& lp_lat) const
95                 {
96                     static T const half_pi = detail::half_pi<T>();
97
98                     T th;
99
100                     th = xy_y * ( xy_y < 0. ? RYCS : RYCN);
101                     if (fabs(th) > 1.) {
102                         if (fabs(th) > one_plus_tol) {
103                             BOOST_THROW_EXCEPTION( projection_exception(error_tolerance_condition) );
104                         } else {
105                             th = th > 0. ? half_pi : - half_pi;
106                         }
107                     } else {
108                         th = asin(th);
109                     }
110
111                     lp_lon = RXC * xy_x / cos(th);
112                     th += th;
113                     lp_lat = (th + sin(th)) * (xy_y < 0. ? RCS : RCN);
114                     if (fabs(lp_lat) > 1.) {
115                         if (fabs(lp_lat) > one_plus_tol) {
116                             BOOST_THROW_EXCEPTION( projection_exception(error_tolerance_condition) );
117                         } else {
118                             lp_lat = lp_lat > 0. ? half_pi : - half_pi;
119                         }
120                     } else {
121                         lp_lat = asin(lp_lat);
122                     }
123                 }
124
125                 static inline std::string get_name()
126                 {
127                     return "hatano_spheroid";
128                 }
129
130             };
131
132             // Hatano Asymmetrical Equal Area
133             template <typename Parameters>
134             inline void setup_hatano(Parameters& par)
135             {
136                 par.es = 0.;
137             }
138
139     }} // namespace detail::hatano
140     #endif // doxygen
141
142     /*!
143         \brief Hatano Asymmetrical Equal Area projection
144         \ingroup projections
145         \tparam Geographic latlong point type
146         \tparam Cartesian xy point type
147         \tparam Parameters parameter type
148         \par Projection characteristics
149          - Pseudocylindrical
150          - Spheroid
151         \par Example
152         \image html ex_hatano.gif
153     */
154     template <typename T, typename Parameters>
155     struct hatano_spheroid : public detail::hatano::base_hatano_spheroid<T, Parameters>
156     {
157         template <typename Params>
158         inline hatano_spheroid(Params const& , Parameters & par)
159         {
160             detail::hatano::setup_hatano(par);
161         }
162     };
163
164     #ifndef DOXYGEN_NO_DETAIL
165     namespace detail
166     {
167
168         // Static projection
169         BOOST_GEOMETRY_PROJECTIONS_DETAIL_STATIC_PROJECTION_FI(srs::spar::proj_hatano, hatano_spheroid)
170
171         // Factory entry(s)
172         BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_ENTRY_FI(hatano_entry, hatano_spheroid)
173         
174         BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_INIT_BEGIN(hatano_init)
175         {
176             BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_INIT_ENTRY(hatano, hatano_entry)
177         }
178
179     } // namespace detail
180     #endif // doxygen
181
182 } // namespace projections
183
184 }} // namespace boost::geometry
185
186 #endif // BOOST_GEOMETRY_PROJECTIONS_HATANO_HPP
187