diff options
Diffstat (limited to 'libtellurian_coarse_distance.3')
-rw-r--r-- | libtellurian_coarse_distance.3 | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/libtellurian_coarse_distance.3 b/libtellurian_coarse_distance.3 new file mode 100644 index 0000000..f1c308c --- /dev/null +++ b/libtellurian_coarse_distance.3 @@ -0,0 +1,60 @@ +.TH LIBTELLURIAN_COARSE_DISTANCE 3 libtellurian +.SH NAME +libtellurian_coarse_distance \- Calculate distance between two locations + +.SH SYNPOSIS +.ni +#include <libtellurian.h> + +double libtellurian_coarse_distance(double \fIlatitude1\fP, double \fIlongitude1\fP, + double \fIlatitude2\fP, double \fIlongitude2\fP); + +double libtellurian_coarse_distance_radians(double \fIlatitude1\fP, double \fIlongitude1\fP, + double \fIlatitude2\fP, double \fIlongitude2\fP); +.fi +.PP +Link with +.I -ltellurian +.IR -lm . + +.SH DESCRIPTION +The +.BR libtellurian_coarse_distance () +function calculates a coarse approximate +spherical distance between two locations, +.RI ( latitude1 ", " longitude1 ) +and +.RI ( latitude2 ", " longitude2 ), +on the Earth's surface modelling the Earth +as a perfect sphere. +.PP +The coordinates shall be specified according +to GPS and in degrees. +.PP +The +.BR libtellurian_coarse_distance_radians () +function is identical to the +.BR libtellurian_coarse_distance () +function except that +.IR latitude1 , +.IR longitude1 , +.IR latitude2 , +and +.I longitude2 +shall be specified in radians. + +.SH RETURN VALUE +The +.BR libtellurian_coarse_distance () +and +.BR libtellurian_coarse_distance_radians () +functions return the distance, along the Earth's +surface, between the two points measured in +meters. + +.SH ERRORS +None. + +.SH SEE ALSO +.BR libtellurian (7), +.BR libtellurian_distance (3) |