MySQL 8.0.31
Source Code Documentation
distance.h
Go to the documentation of this file.
1#ifndef SQL_GIS_DISTANCE_H_INCLUDED
2#define SQL_GIS_DISTANCE_H_INCLUDED
3
4// Copyright (c) 2017, 2022, Oracle and/or its affiliates.
5//
6// This program is free software; you can redistribute it and/or modify
7// it under the terms of the GNU General Public License, version 2.0,
8// as published by the Free Software Foundation.
9//
10// This program is also distributed with certain software (including
11// but not limited to OpenSSL) that is licensed under separate terms,
12// as designated in a particular file or component or in included license
13// documentation. The authors of MySQL hereby grant you an additional
14// permission to link the program and your derivative works with the
15// separately licensed software that they have included with MySQL.
16//
17// This program is distributed in the hope that it will be useful,
18// but WITHOUT ANY WARRANTY; without even the implied warranty of
19// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20// GNU General Public License, version 2.0, for more details.
21//
22// You should have received a copy of the GNU General Public License
23// along with this program; if not, write to the Free Software
24// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
25
26/// @file
27///
28/// This file declares the interface to calculate distance between two
29/// geometries.
30
31#include "sql/dd/types/spatial_reference_system.h" // dd::Spatial_reference_system
32#include "sql/gis/geometries.h"
33
34namespace gis {
35
36/// Computes the distance between two geometries.
37///
38/// Both geometries must be in the same coordinate system (Cartesian or
39/// geographic), and the coordinate system of the geometries must match
40/// the coordinate system of the SRID. It is the caller's responsibility
41/// to guarantee this.
42///
43/// @param[in] srs The spatial reference system, common to both geometries.
44/// @param[in] g1 First geometry.
45/// @param[in] g2 Second geometry.
46/// @param[out] distance The shortest distance between g1 and g2 in the SRS'
47/// linear unit.
48/// @param[out] is_null True if the return value is NULL.
49///
50/// @retval false Success.
51/// @retval true An error has occurred. The error has been reported with
52/// my_error().
53bool distance(const dd::Spatial_reference_system *srs, const Geometry *g1,
54 const Geometry *g2, double *distance, bool *is_null) noexcept;
55
56} // namespace gis
57
58#endif // SQL_GIS_DISTANCE_H_INCLUDED
Definition: spatial.h:214
Definition: spatial_reference_system.h:52
This file declares the geometry class hierarchy used by the server as the internal representation of ...
Definition: area.cc:46
bool distance(const dd::Spatial_reference_system *srs, const Geometry *g1, const Geometry *g2, double *distance, bool *is_null) noexcept
Computes the distance between two geometries.
Definition: distance.cc:39