diff options
| author | Mattias Andrée <m@maandree.se> | 2024-10-22 22:22:41 +0200 |
|---|---|---|
| committer | Mattias Andrée <m@maandree.se> | 2024-10-22 22:22:41 +0200 |
| commit | bb5de3aa2ee118df78f0347cffd4e58f846dc1fb (patch) | |
| tree | b313a20b79d67f35a5e4e05bc9106b22dc17f451 /libtellurian.h | |
| parent | ... (diff) | |
| download | libtellurian-bb5de3aa2ee118df78f0347cffd4e58f846dc1fb.tar.gz libtellurian-bb5de3aa2ee118df78f0347cffd4e58f846dc1fb.tar.bz2 libtellurian-bb5de3aa2ee118df78f0347cffd4e58f846dc1fb.tar.xz | |
Signed-off-by: Mattias Andrée <m@maandree.se>
Diffstat (limited to '')
| -rw-r--r-- | libtellurian.h | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/libtellurian.h b/libtellurian.h index b294e9c..98309be 100644 --- a/libtellurian.h +++ b/libtellurian.h @@ -219,6 +219,15 @@ double libtellurian_coarse_distance_radians(double latitude1, double longitude1, * performed. If you have no need for an azimuth you can set * the corresponding output parameter to `NULL`, and the * function will not compute it. + * + * If the two points are they same, the distance will be 0 + * and the azimuths will be NaN, denoting that any direction + * can be taken. If the two points are antipodal, the distance + * will be `LIBTELLURIAN_MERIDIONAL_CIRCUMFERENCE` and the + * azimuths will be NaN denoting that are multiple directions + * to take, specifying either any (if the two points are the + * poles) or either north or south (and the two azimuths shall + * be the opposite of each other). */ LIBTELLURIAN_WUR__ double libtellurian_distance(double latitude1, double longitude1, @@ -247,6 +256,15 @@ double libtellurian_distance(double latitude1, double longitude1, * performed. If you have no need for an azimuth you can set * the corresponding output parameter to `NULL`, and the * function will not compute it. + * + * If the two points are they same, the distance will be 0 + * and the azimuths will be NaN, denoting that any direction + * can be taken. If the two points are antipodal, the distance + * will be `LIBTELLURIAN_MERIDIONAL_CIRCUMFERENCE` and the + * azimuths will be NaN denoting that are multiple directions + * to take, specifying either any (if the two points are the + * poles) or either north or south (and the two azimuths shall + * be the opposite of each other). */ LIBTELLURIAN_WUR__ double libtellurian_distance_radians(double latitude1, double longitude1, @@ -271,6 +289,13 @@ double libtellurian_distance_radians(double latitude1, double longitude1, * This function is identical to libtellurian_distance` * except it does not compute the distance between the * points + * + * If the two points are they same, the azimuths will be NaN, + * denoting that any direction can be taken. If the two points + * are antipodal, the azimuths will be NaN denoting that are + * multiple directions to take, specifying either any (if the + * two points are the poles) or either north or south (and + * the two azimuths shall be the opposite of each other). */ void libtellurian_azimuth(double latitude1, double longitude1, double latitude2, double longitude2, @@ -294,6 +319,13 @@ void libtellurian_azimuth(double latitude1, double longitude1, * * This function is identical to libtellurian_distance_radians` * except it does not compute the distance between the points + * + * If the two points are they same, the azimuths will be NaN, + * denoting that any direction can be taken. If the two points + * are antipodal, the azimuths will be NaN denoting that are + * multiple directions to take, specifying either any (if the + * two points are the poles) or either north or south (and + * the two azimuths shall be the opposite of each other). */ void libtellurian_azimuth_radians(double latitude1, double longitude1, double latitude2, double longitude2, |