You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
58 lines
2.4 KiB
58 lines
2.4 KiB
#ifndef SQL_GIS_DISTANCE_H_INCLUDED
|
|
#define SQL_GIS_DISTANCE_H_INCLUDED
|
|
|
|
// Copyright (c) 2017, 2018, Oracle and/or its affiliates. All rights reserved.
|
|
//
|
|
// This program is free software; you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License, version 2.0,
|
|
// as published by the Free Software Foundation.
|
|
//
|
|
// This program is also distributed with certain software (including
|
|
// but not limited to OpenSSL) that is licensed under separate terms,
|
|
// as designated in a particular file or component or in included license
|
|
// documentation. The authors of MySQL hereby grant you an additional
|
|
// permission to link the program and your derivative works with the
|
|
// separately licensed software that they have included with MySQL.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License, version 2.0, for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with this program; if not, write to the Free Software
|
|
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
|
|
/// @file
|
|
///
|
|
/// This file declares the interface to calculate distance between two
|
|
/// geometries.
|
|
|
|
#include "sql/dd/types/spatial_reference_system.h" // dd::Spatial_reference_system
|
|
#include "sql/gis/geometries.h"
|
|
|
|
namespace gis {
|
|
|
|
/// Computes the distance between two geometries.
|
|
///
|
|
/// Both geometries must be in the same coordinate system (Cartesian or
|
|
/// geographic), and the coordinate system of the geometries must match
|
|
/// the coordinate system of the SRID. It is the caller's responsibility
|
|
/// to guarantee this.
|
|
///
|
|
/// @param[in] srs The spatial reference system, common to both geometries.
|
|
/// @param[in] g1 First geometry.
|
|
/// @param[in] g2 Second geometry.
|
|
/// @param[out] distance The shortest distance between g1 and g2 in the SRS'
|
|
/// linear unit.
|
|
/// @param[out] is_null True if the return value is NULL.
|
|
///
|
|
/// @retval false Success.
|
|
/// @retval true An error has occurred. The error has been reported with
|
|
/// my_error().
|
|
bool distance(const dd::Spatial_reference_system *srs, const Geometry *g1,
|
|
const Geometry *g2, double *distance, bool *is_null) noexcept;
|
|
|
|
} // namespace gis
|
|
|
|
#endif // SQL_GIS_DISTANCE_H_INCLUDED
|
|
|