Calculate the great-circle distance between two coordinates on a sphere. More...

#include <geospatial.h>

Inheritance diagram for Xapian::GreatCircleMetric:

Collaboration diagram for Xapian::GreatCircleMetric:

Public Member Functions
	GreatCircleMetric ()
	Construct a GreatCircleMetric. More...

	GreatCircleMetric (double radius_)
	Construct a GreatCircleMetric using a specified radius. More...

double	pointwise_distance (const LatLongCoord &a, const LatLongCoord &b) const
	Return the great-circle distance between points on the sphere. More...

LatLongMetric *	clone () const
	Clone the metric. More...

std::string	name () const
	Return the full name of the metric. More...

std::string	serialise () const
	Serialise object parameters into a string. More...

LatLongMetric *	unserialise (const std::string &serialised) const
	Create object given string serialisation returned by serialise(). More...

Public Member Functions inherited from Xapian::LatLongMetric
virtual	~LatLongMetric ()
	Destructor. More...

double	operator() (const LatLongCoords &a, const LatLongCoords &b) const
	Return the distance between two coordinate lists, in metres. More...

double	operator() (const LatLongCoords &a, std::string_view b) const
	Return the distance between two coordinate lists, in metres. More...

double	operator() (const LatLongCoords &a, const char *b_ptr, size_t b_len) const
	Return the distance between two coordinate lists, in metres. More...

Private Attributes
double	radius
	The radius of the sphere in metres. More...

Detailed Description

Calculate the great-circle distance between two coordinates on a sphere.

Experimental - see https://xapian.org/docs/deprecation#experimental-features

This uses the haversine formula to calculate the distance. Note that this formula is subject to inaccuracy due to numerical errors for coordinates on the opposite side of the sphere.

See https://en.wikipedia.org/wiki/Haversine_formula

Definition at line 398 of file geospatial.h.

Constructor & Destructor Documentation

◆ GreatCircleMetric() [1/2]

GreatCircleMetric::GreatCircleMetric ( )

Construct a GreatCircleMetric.

The (quadratic mean) radius of the Earth will be used by this calculator.

Definition at line 100 of file latlong_metrics.cc.

Referenced by clone(), and unserialise().

◆ GreatCircleMetric() [2/2]

GreatCircleMetric::GreatCircleMetric ( double radius_ )

explicit

Construct a GreatCircleMetric using a specified radius.

This is useful for data sets in which the points are not on Earth (eg, a database of features on Mars).

Parameters

radius_ The radius of the sphere to use, in metres.

Definition at line 104 of file latlong_metrics.cc.

Member Function Documentation

◆ clone()

LatLongMetric * GreatCircleMetric::clone ( ) const

virtual

Clone the metric.

Implements Xapian::LatLongMetric.

Definition at line 130 of file latlong_metrics.cc.

References GreatCircleMetric(), and radius.

◆ name()

string GreatCircleMetric::name ( ) const

virtual

Return the full name of the metric.

This is used when serialising and unserialising metrics; for example, for performing remote searches.

If the subclass is in a C++ namespace, the namespace should be included in the name, using "::" as a separator. For example, for a LatLongMetric subclass called "FooLatLongMetric" in the "Xapian" namespace the result of this call should be "Xapian::FooLatLongMetric".

Implements Xapian::LatLongMetric.

Definition at line 136 of file latlong_metrics.cc.

Referenced by DEFINE_TESTCASE().