PostgreSQL Source Code  git master
Data Structures | Macros | Functions
geo_decls.h File Reference
#include <math.h>
#include "fmgr.h"
Include dependency graph for geo_decls.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  Point
 
struct  LSEG
 
struct  PATH
 
struct  LINE
 
struct  BOX
 
struct  POLYGON
 
struct  CIRCLE
 

Macros

#define EPSILON   1.0E-06
 
#define FPzero(A)   (fabs(A) <= EPSILON)
 
#define HYPOT(A, B)   pg_hypot(A, B)
 
#define DatumGetPointP(X)   ((Point *) DatumGetPointer(X))
 
#define PointPGetDatum(X)   PointerGetDatum(X)
 
#define PG_GETARG_POINT_P(n)   DatumGetPointP(PG_GETARG_DATUM(n))
 
#define PG_RETURN_POINT_P(x)   return PointPGetDatum(x)
 
#define DatumGetLsegP(X)   ((LSEG *) DatumGetPointer(X))
 
#define LsegPGetDatum(X)   PointerGetDatum(X)
 
#define PG_GETARG_LSEG_P(n)   DatumGetLsegP(PG_GETARG_DATUM(n))
 
#define PG_RETURN_LSEG_P(x)   return LsegPGetDatum(x)
 
#define DatumGetPathP(X)   ((PATH *) PG_DETOAST_DATUM(X))
 
#define DatumGetPathPCopy(X)   ((PATH *) PG_DETOAST_DATUM_COPY(X))
 
#define PathPGetDatum(X)   PointerGetDatum(X)
 
#define PG_GETARG_PATH_P(n)   DatumGetPathP(PG_GETARG_DATUM(n))
 
#define PG_GETARG_PATH_P_COPY(n)   DatumGetPathPCopy(PG_GETARG_DATUM(n))
 
#define PG_RETURN_PATH_P(x)   return PathPGetDatum(x)
 
#define DatumGetLineP(X)   ((LINE *) DatumGetPointer(X))
 
#define LinePGetDatum(X)   PointerGetDatum(X)
 
#define PG_GETARG_LINE_P(n)   DatumGetLineP(PG_GETARG_DATUM(n))
 
#define PG_RETURN_LINE_P(x)   return LinePGetDatum(x)
 
#define DatumGetBoxP(X)   ((BOX *) DatumGetPointer(X))
 
#define BoxPGetDatum(X)   PointerGetDatum(X)
 
#define PG_GETARG_BOX_P(n)   DatumGetBoxP(PG_GETARG_DATUM(n))
 
#define PG_RETURN_BOX_P(x)   return BoxPGetDatum(x)
 
#define DatumGetPolygonP(X)   ((POLYGON *) PG_DETOAST_DATUM(X))
 
#define DatumGetPolygonPCopy(X)   ((POLYGON *) PG_DETOAST_DATUM_COPY(X))
 
#define PolygonPGetDatum(X)   PointerGetDatum(X)
 
#define PG_GETARG_POLYGON_P(n)   DatumGetPolygonP(PG_GETARG_DATUM(n))
 
#define PG_GETARG_POLYGON_P_COPY(n)   DatumGetPolygonPCopy(PG_GETARG_DATUM(n))
 
#define PG_RETURN_POLYGON_P(x)   return PolygonPGetDatum(x)
 
#define DatumGetCircleP(X)   ((CIRCLE *) DatumGetPointer(X))
 
#define CirclePGetDatum(X)   PointerGetDatum(X)
 
#define PG_GETARG_CIRCLE_P(n)   DatumGetCircleP(PG_GETARG_DATUM(n))
 
#define PG_RETURN_CIRCLE_P(x)   return CirclePGetDatum(x)
 

Functions

static bool FPeq (double A, double B)
 
static bool FPne (double A, double B)
 
static bool FPlt (double A, double B)
 
static bool FPle (double A, double B)
 
static bool FPgt (double A, double B)
 
static bool FPge (double A, double B)
 
float8 pg_hypot (float8 x, float8 y)
 

Macro Definition Documentation

◆ BoxPGetDatum

#define BoxPGetDatum (   X)    PointerGetDatum(X)

Definition at line 198 of file geo_decls.h.

Referenced by fallbackSplit(), gist_point_compress(), spg_box_quad_choose(), spg_box_quad_leaf_consistent(), spg_box_quad_picksplit(), spg_kd_inner_consistent(), and spg_quad_inner_consistent().

◆ CirclePGetDatum

#define CirclePGetDatum (   X)    PointerGetDatum(X)

Definition at line 210 of file geo_decls.h.

Referenced by gist_point_consistent().

◆ DatumGetBoxP

#define DatumGetBoxP (   X)    ((BOX *) DatumGetPointer(X))

Definition at line 197 of file geo_decls.h.

Referenced by fallbackSplit(), gist_bbox_distance(), gist_bbox_zorder_abbrev_convert(), gist_bbox_zorder_cmp(), gist_box_consistent(), gist_box_penalty(), gist_box_picksplit(), gist_box_union(), gist_circle_consistent(), gist_point_consistent(), gist_point_distance(), gist_point_fetch(), gist_poly_consistent(), spg_box_quad_choose(), spg_box_quad_get_scankey_bbox(), spg_box_quad_inner_consistent(), spg_box_quad_picksplit(), spg_kd_inner_consistent(), spg_key_orderbys_distances(), and spg_quad_inner_consistent().

◆ DatumGetCircleP

#define DatumGetCircleP (   X)    ((CIRCLE *) DatumGetPointer(X))

Definition at line 209 of file geo_decls.h.

Referenced by gist_circle_compress().

◆ DatumGetLineP

#define DatumGetLineP (   X)    ((LINE *) DatumGetPointer(X))

Definition at line 192 of file geo_decls.h.

◆ DatumGetLsegP

#define DatumGetLsegP (   X)    ((LSEG *) DatumGetPointer(X))

Definition at line 180 of file geo_decls.h.

◆ DatumGetPathP

#define DatumGetPathP (   X)    ((PATH *) PG_DETOAST_DATUM(X))

Definition at line 185 of file geo_decls.h.

◆ DatumGetPathPCopy

#define DatumGetPathPCopy (   X)    ((PATH *) PG_DETOAST_DATUM_COPY(X))

Definition at line 186 of file geo_decls.h.

◆ DatumGetPointP

#define DatumGetPointP (   X)    ((Point *) DatumGetPointer(X))

Definition at line 175 of file geo_decls.h.

Referenced by gist_bbox_distance(), gist_point_compress(), spg_box_quad_inner_consistent(), spg_kd_choose(), spg_kd_inner_consistent(), spg_kd_picksplit(), spg_key_orderbys_distances(), spg_quad_choose(), spg_quad_inner_consistent(), spg_quad_leaf_consistent(), and spg_quad_picksplit().

◆ DatumGetPolygonP

#define DatumGetPolygonP (   X)    ((POLYGON *) PG_DETOAST_DATUM(X))

Definition at line 202 of file geo_decls.h.

Referenced by gist_poly_compress(), and spg_box_quad_get_scankey_bbox().

◆ DatumGetPolygonPCopy

#define DatumGetPolygonPCopy (   X)    ((POLYGON *) PG_DETOAST_DATUM_COPY(X))

Definition at line 203 of file geo_decls.h.

◆ EPSILON

#define EPSILON   1.0E-06

Definition at line 41 of file geo_decls.h.

Referenced by FPeq(), FPge(), FPgt(), FPle(), FPlt(), and FPne().

◆ FPzero

#define FPzero (   A)    (fabs(A) <= EPSILON)

Definition at line 44 of file geo_decls.h.

Referenced by circle_poly(), line_contain_point(), line_distance(), line_eq(), line_horizontal(), line_in(), line_interpt_line(), line_invsl(), line_perp(), line_recv(), line_sl(), line_vertical(), and lseg_crossing().

◆ HYPOT

#define HYPOT (   A,
  B 
)    pg_hypot(A, B)

Definition at line 91 of file geo_decls.h.

Referenced by circle_div_pt(), circle_mul_pt(), line_distance(), point_box_distance(), point_dt(), and pointToRectBoxDistance().

◆ LinePGetDatum

#define LinePGetDatum (   X)    PointerGetDatum(X)

Definition at line 193 of file geo_decls.h.

◆ LsegPGetDatum

#define LsegPGetDatum (   X)    PointerGetDatum(X)

Definition at line 181 of file geo_decls.h.

Referenced by interpt_pp().

◆ PathPGetDatum

#define PathPGetDatum (   X)    PointerGetDatum(X)

Definition at line 187 of file geo_decls.h.

◆ PG_GETARG_BOX_P

#define PG_GETARG_BOX_P (   n)    DatumGetBoxP(PG_GETARG_DATUM(n))

Definition at line 199 of file geo_decls.h.

Referenced by box_above(), box_above_eq(), box_add(), box_area(), box_below(), box_below_eq(), box_center(), box_circle(), box_contain(), box_contain_pt(), box_contained(), box_diagonal(), box_distance(), box_div(), box_eq(), box_ge(), box_gt(), box_height(), box_intersect(), box_le(), box_left(), box_lt(), box_mul(), box_out(), box_overabove(), box_overbelow(), box_overlap(), box_overleft(), box_overright(), box_poly(), box_right(), box_same(), box_send(), box_sub(), box_width(), boxes_bound_box(), close_lb(), close_pb(), close_sb(), dist_bl(), dist_bp(), dist_bs(), dist_lb(), dist_pb(), dist_sb(), gist_box_consistent(), gist_box_same(), gist_point_consistent(), inter_lb(), inter_sb(), on_pb(), and on_sb().

◆ PG_GETARG_CIRCLE_P

#define PG_GETARG_CIRCLE_P (   n)    DatumGetCircleP(PG_GETARG_DATUM(n))

Definition at line 211 of file geo_decls.h.

Referenced by circle_above(), circle_add_pt(), circle_area(), circle_below(), circle_box(), circle_center(), circle_contain(), circle_contain_pt(), circle_contained(), circle_diameter(), circle_distance(), circle_div_pt(), circle_eq(), circle_ge(), circle_gt(), circle_le(), circle_left(), circle_lt(), circle_mul_pt(), circle_ne(), circle_out(), circle_overabove(), circle_overbelow(), circle_overlap(), circle_overleft(), circle_overright(), circle_poly(), circle_radius(), circle_right(), circle_same(), circle_send(), circle_sub_pt(), dist_cpoint(), dist_cpoly(), dist_pc(), dist_polyc(), gist_circle_consistent(), gist_point_consistent(), and pt_contained_circle().

◆ PG_GETARG_LINE_P

#define PG_GETARG_LINE_P (   n)    DatumGetLineP(PG_GETARG_DATUM(n))

Definition at line 194 of file geo_decls.h.

Referenced by close_lb(), close_ls(), close_pl(), close_sl(), dist_bl(), dist_lb(), dist_lp(), dist_ls(), dist_pl(), dist_sl(), inter_lb(), inter_sl(), line_distance(), line_eq(), line_horizontal(), line_interpt(), line_intersect(), line_out(), line_parallel(), line_perp(), line_send(), line_vertical(), on_pl(), and on_sl().

◆ PG_GETARG_LSEG_P

#define PG_GETARG_LSEG_P (   n)    DatumGetLsegP(PG_GETARG_DATUM(n))

Definition at line 182 of file geo_decls.h.

Referenced by close_ls(), close_lseg(), close_ps(), close_sb(), close_sl(), dist_bs(), dist_ls(), dist_ps(), dist_sb(), dist_sl(), dist_sp(), inter_sb(), inter_sl(), lseg_center(), lseg_distance(), lseg_eq(), lseg_ge(), lseg_gt(), lseg_horizontal(), lseg_interpt(), lseg_intersect(), lseg_le(), lseg_length(), lseg_lt(), lseg_ne(), lseg_out(), lseg_parallel(), lseg_perp(), lseg_send(), lseg_vertical(), on_ps(), on_sb(), and on_sl().

◆ PG_GETARG_PATH_P

#define PG_GETARG_PATH_P (   n)    DatumGetPathP(PG_GETARG_DATUM(n))

Definition at line 188 of file geo_decls.h.

Referenced by dist_pathp(), dist_ppath(), interpt_pp(), on_ppath(), path_add(), path_area(), path_center(), path_distance(), path_inter(), path_isclosed(), path_isopen(), path_length(), path_n_eq(), path_n_ge(), path_n_gt(), path_n_le(), path_n_lt(), path_npoints(), path_out(), path_poly(), and path_send().

◆ PG_GETARG_PATH_P_COPY

#define PG_GETARG_PATH_P_COPY (   n)    DatumGetPathPCopy(PG_GETARG_DATUM(n))

Definition at line 189 of file geo_decls.h.

Referenced by path_add_pt(), path_close(), path_div_pt(), path_mul_pt(), path_open(), and path_sub_pt().

◆ PG_GETARG_POINT_P

#define PG_GETARG_POINT_P (   n)    DatumGetPointP(PG_GETARG_DATUM(n))

Definition at line 177 of file geo_decls.h.

Referenced by box_add(), box_contain_pt(), box_div(), box_mul(), box_sub(), circle_add_pt(), circle_contain_pt(), circle_div_pt(), circle_mul_pt(), circle_sub_pt(), close_pb(), close_pl(), close_ps(), cr_circle(), dist_bp(), dist_cpoint(), dist_lp(), dist_pathp(), dist_pb(), dist_pc(), dist_pl(), dist_polyp(), dist_ppath(), dist_ppoly(), dist_ps(), dist_sp(), geo_distance(), gist_point_consistent(), gist_point_distance(), line_construct_pp(), lseg_construct(), makepoint(), on_pb(), on_pl(), on_ppath(), on_ps(), path_add_pt(), path_div_pt(), path_mul_pt(), path_sub_pt(), point_above(), point_add(), point_below(), point_box(), point_distance(), point_div(), point_eq(), point_horiz(), point_left(), point_mul(), point_ne(), point_out(), point_right(), point_send(), point_slope(), point_sub(), point_vert(), points_box(), poly_contain_pt(), pt_contained_circle(), pt_contained_poly(), and pt_in_widget().

◆ PG_GETARG_POLYGON_P

#define PG_GETARG_POLYGON_P (   n)    DatumGetPolygonP(PG_GETARG_DATUM(n))

Definition at line 205 of file geo_decls.h.

Referenced by dist_cpoly(), dist_polyc(), dist_polyp(), dist_ppoly(), gist_point_consistent(), gist_poly_consistent(), poly_above(), poly_below(), poly_box(), poly_center(), poly_circle(), poly_contain(), poly_contain_pt(), poly_contained(), poly_distance(), poly_left(), poly_npoints(), poly_out(), poly_overabove(), poly_overbelow(), poly_overlap(), poly_overleft(), poly_overright(), poly_path(), poly_right(), poly_same(), poly_send(), pt_contained_poly(), and spg_poly_quad_compress().

◆ PG_GETARG_POLYGON_P_COPY

#define PG_GETARG_POLYGON_P_COPY (   n)    DatumGetPolygonPCopy(PG_GETARG_DATUM(n))

Definition at line 206 of file geo_decls.h.

◆ PG_RETURN_BOX_P

#define PG_RETURN_BOX_P (   x)    return BoxPGetDatum(x)

Definition at line 200 of file geo_decls.h.

Referenced by box_add(), box_div(), box_in(), box_intersect(), box_mul(), box_recv(), box_sub(), boxes_bound_box(), circle_box(), point_box(), points_box(), poly_box(), and spg_poly_quad_compress().

◆ PG_RETURN_CIRCLE_P

#define PG_RETURN_CIRCLE_P (   x)    return CirclePGetDatum(x)

Definition at line 212 of file geo_decls.h.

Referenced by box_circle(), circle_add_pt(), circle_div_pt(), circle_in(), circle_mul_pt(), circle_recv(), circle_sub_pt(), cr_circle(), and poly_circle().

◆ PG_RETURN_LINE_P

#define PG_RETURN_LINE_P (   x)    return LinePGetDatum(x)

Definition at line 195 of file geo_decls.h.

Referenced by line_construct_pp(), line_in(), and line_recv().

◆ PG_RETURN_LSEG_P

#define PG_RETURN_LSEG_P (   x)    return LsegPGetDatum(x)

Definition at line 183 of file geo_decls.h.

Referenced by box_diagonal(), lseg_construct(), lseg_in(), and lseg_recv().

◆ PG_RETURN_PATH_P

#define PG_RETURN_PATH_P (   x)    return PathPGetDatum(x)

Definition at line 190 of file geo_decls.h.

Referenced by path_add(), path_add_pt(), path_close(), path_div_pt(), path_in(), path_mul_pt(), path_open(), path_recv(), path_sub_pt(), and poly_path().

◆ PG_RETURN_POINT_P

#define PG_RETURN_POINT_P (   x)    return PointPGetDatum(x)

Definition at line 178 of file geo_decls.h.

Referenced by box_center(), circle_center(), close_ls(), close_lseg(), close_pb(), close_pl(), close_ps(), close_sb(), close_sl(), construct_point(), line_interpt(), lseg_center(), lseg_interpt(), makepoint(), point_add(), point_div(), point_in(), point_mul(), point_recv(), point_sub(), and poly_center().

◆ PG_RETURN_POLYGON_P

#define PG_RETURN_POLYGON_P (   x)    return PolygonPGetDatum(x)

Definition at line 207 of file geo_decls.h.

Referenced by box_poly(), circle_poly(), path_poly(), poly_in(), and poly_recv().

◆ PointPGetDatum

#define PointPGetDatum (   X)    PointerGetDatum(X)

Definition at line 176 of file geo_decls.h.

Referenced by gist_point_consistent(), pt_in_widget(), spg_kd_choose(), spg_kd_picksplit(), spg_quad_choose(), and spg_quad_picksplit().

◆ PolygonPGetDatum

#define PolygonPGetDatum (   X)    PointerGetDatum(X)

Definition at line 204 of file geo_decls.h.

Referenced by gist_point_consistent().

Function Documentation

◆ FPeq()

static bool FPeq ( double  A,
double  B 
)
inlinestatic

Definition at line 47 of file geo_decls.h.

References EPSILON.

Referenced by box_eq(), circle_eq(), circle_same(), gist_point_consistent_internal(), line_eq(), line_interpt_line(), line_perp(), lseg_contain_point(), lseg_horizontal(), lseg_parallel(), lseg_perp(), lseg_vertical(), on_ppath(), point_eq_point(), point_horiz(), point_invsl(), point_sl(), and point_vert().

48 {
49  return A == B || fabs(A - B) <= EPSILON;
50 }
EPSILON
#define EPSILON
Definition: geo_decls.h:41

◆ FPge()

static bool FPge ( double  A,
double  B 
)
inlinestatic

Definition at line 77 of file geo_decls.h.

References EPSILON.

Referenced by box_above_eq(), box_contain_box(), box_ge(), box_overabove(), box_overright(), circle_ge(), circle_overabove(), circle_overright(), contain2D(), contained2D(), gist_point_consistent_internal(), lseg_crossing(), lseg_ge(), overHigher2D(), and overlap2D().

78 {
79  return A + EPSILON >= B;
80 }
EPSILON
#define EPSILON
Definition: geo_decls.h:41

◆ FPgt()

static bool FPgt ( double  A,
double  B 
)
inlinestatic

Definition at line 71 of file geo_decls.h.

References EPSILON.

Referenced by box_above(), box_gt(), box_right(), circle_above(), circle_gt(), circle_right(), gist_point_consistent_internal(), higher2D(), lseg_crossing(), lseg_gt(), point_above(), point_right(), and spg_kd_inner_consistent().

72 {
73  return A > B + EPSILON;
74 }
EPSILON
#define EPSILON
Definition: geo_decls.h:41

◆ FPle()

static bool FPle ( double  A,
double  B 
)
inlinestatic

Definition at line 65 of file geo_decls.h.

References EPSILON.

Referenced by box_below_eq(), box_contain_box(), box_le(), box_ov(), box_overbelow(), box_overleft(), circle_contain(), circle_contained(), circle_le(), circle_overbelow(), circle_overlap(), circle_overleft(), contain2D(), contained2D(), gist_point_consistent_internal(), lseg_crossing(), lseg_le(), overlap2D(), and overLower2D().

66 {
67  return A <= B + EPSILON;
68 }
EPSILON
#define EPSILON
Definition: geo_decls.h:41

◆ FPlt()

static bool FPlt ( double  A,
double  B 
)
inlinestatic

Definition at line 59 of file geo_decls.h.

References EPSILON.

Referenced by box_below(), box_left(), box_lt(), circle_below(), circle_left(), circle_lt(), gist_point_consistent_internal(), lower2D(), lseg_crossing(), lseg_lt(), point_below(), point_left(), and spg_kd_inner_consistent().

60 {
61  return A + EPSILON < B;
62 }
EPSILON
#define EPSILON
Definition: geo_decls.h:41

◆ FPne()

static bool FPne ( double  A,
double  B 
)
inlinestatic

Definition at line 53 of file geo_decls.h.

References EPSILON.

Referenced by circle_ne().

54 {
55  return A != B && fabs(A - B) > EPSILON;
56 }
EPSILON
#define EPSILON
Definition: geo_decls.h:41

◆ pg_hypot()

float8 pg_hypot ( float8  x,
float8  y 
)

Definition at line 5526 of file geo_ops.c.

References float_overflow_error(), float_underflow_error(), get_float8_infinity(), get_float8_nan(), and unlikely.

5527 {
5528  float8 yx,
5529  result;
5530 
5531  /* Handle INF and NaN properly */
5532  if (isinf(x) || isinf(y))
5533  return get_float8_infinity();
5534 
5535  if (isnan(x) || isnan(y))
5536  return get_float8_nan();
5537 
5538  /* Else, drop any minus signs */
5539  x = fabs(x);
5540  y = fabs(y);
5541 
5542  /* Swap x and y if needed to make x the larger one */
5543  if (x < y)
5544  {
5545  float8 temp = x;
5546 
5547  x = y;
5548  y = temp;
5549  }
5550 
5551  /*
5552  * If y is zero, the hypotenuse is x. This test saves a few cycles in
5553  * such cases, but more importantly it also protects against
5554  * divide-by-zero errors, since now x >= y.
5555  */
5556  if (y == 0.0)
5557  return x;
5558 
5559  /* Determine the hypotenuse */
5560  yx = y / x;
5561  result = x * sqrt(1.0 + (yx * yx));
5562 
5563  if (unlikely(isinf(result)))
5564  float_overflow_error();
5565  if (unlikely(result == 0.0))
5566  float_underflow_error();
5567 
5568  return result;
5569 }
get_float8_infinity
static float8 get_float8_infinity(void)
Definition: float.h:93
float_underflow_error
pg_noinline void float_underflow_error(void)
Definition: float.c:92
float8
double float8
Definition: c.h:565
get_float8_nan
static float8 get_float8_nan(void)
Definition: float.h:122
float_overflow_error
pg_noinline void float_overflow_error(void)
Definition: float.c:84
unlikely
#define unlikely(x)
Definition: c.h:273