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	FPeq(A, B)   (fabs((A) - (B)) <= EPSILON)
#define	FPne(A, B)   (fabs((A) - (B)) > EPSILON)
#define	FPlt(A, B)   ((B) - (A) > EPSILON)
#define	FPle(A, B)   ((A) - (B) <= EPSILON)
#define	FPgt(A, B)   ((A) - (B) > EPSILON)
#define	FPge(A, B)   ((B) - (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
double	point_dt (Point *pt1, Point *pt2)
double	point_sl (Point *pt1, Point *pt2)
double	pg_hypot (double x, double y)
BOX *	box_copy (BOX *box)

Macro Definition Documentation

BoxPGetDatum

#define BoxPGetDatum

(

X

)

PointerGetDatum(X)

Definition at line 160 of file geo_decls.h.

Referenced by close_pb(), close_sb(), dist_pb(), dist_sb(), fallbackSplit(), gist_point_compress(), inter_sb(), on_sb(), poly_contain(), spg_box_quad_choose(), spg_box_quad_leaf_consistent(), and spg_box_quad_picksplit().

CirclePGetDatum

#define CirclePGetDatum

(

X

)

PointerGetDatum(X)

Definition at line 172 of file geo_decls.h.

Referenced by gist_point_consistent(), and poly_center().

DatumGetBoxP

#define DatumGetBoxP

(

X

)

((BOX *) DatumGetPointer(X))

Definition at line 159 of file geo_decls.h.

Referenced by fallbackSplit(), gist_bbox_distance(), 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(), and spg_quad_inner_consistent().

DatumGetCircleP

#define DatumGetCircleP

(

X

)

((CIRCLE *) DatumGetPointer(X))

Definition at line 171 of file geo_decls.h.

Referenced by gist_circle_compress(), and poly_center().

DatumGetLineP

#define DatumGetLineP

(

X

)

((LINE *) DatumGetPointer(X))

Definition at line 154 of file geo_decls.h.

DatumGetLsegP

#define DatumGetLsegP

(

X

)

((LSEG *) DatumGetPointer(X))

Definition at line 142 of file geo_decls.h.

DatumGetPathP

#define DatumGetPathP

(

X

)

((PATH *) PG_DETOAST_DATUM(X))

Definition at line 147 of file geo_decls.h.

DatumGetPathPCopy

#define DatumGetPathPCopy

(

X

)

((PATH *) PG_DETOAST_DATUM_COPY(X))

Definition at line 148 of file geo_decls.h.

DatumGetPointP

#define DatumGetPointP

(

X

)

((Point *) DatumGetPointer(X))

Definition at line 137 of file geo_decls.h.

Referenced by box_div(), box_mul(), circle_div_pt(), circle_mul_pt(), close_lseg(), dist_pb(), dist_sb(), gist_bbox_distance(), gist_point_compress(), path_div_pt(), path_mul_pt(), spg_kd_choose(), spg_kd_inner_consistent(), spg_kd_picksplit(), 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 164 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 165 of file geo_decls.h.

EPSILON

#define EPSILON   1.0E-06

Definition at line 33 of file geo_decls.h.

FPeq

#define FPeq	(		A,
			B
	)		(fabs((A) - (B)) <= EPSILON)

Definition at line 37 of file geo_decls.h.

Referenced by box_eq(), box_same(), circle_eq(), circle_same(), close_ps(), gist_point_consistent_internal(), line_construct_pts(), line_eq(), line_in(), line_parallel(), line_perp(), lseg_eq(), lseg_horizontal(), lseg_interpt_internal(), lseg_ne(), lseg_parallel(), lseg_perp(), lseg_vertical(), on_ppath(), on_ps_internal(), plist_same(), point_eq(), point_horiz(), point_sl(), and point_vert().

FPge

#define FPge	(		A,
			B
	)		((B) - (A) <= EPSILON)

Definition at line 42 of file geo_decls.h.

Referenced by box_above_eq(), box_contain(), box_contained(), 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().

FPgt

#define FPgt	(		A,
			B
	)		((A) - (B) > EPSILON)

Definition at line 41 of file geo_decls.h.

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().

FPle

#define FPle	(		A,
			B
	)		((A) - (B) <= EPSILON)

Definition at line 40 of file geo_decls.h.

Referenced by box_below_eq(), box_contain(), box_contained(), 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().

FPlt

#define FPlt	(		A,
			B
	)		((B) - (A) > EPSILON)

Definition at line 39 of file geo_decls.h.

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().

FPne

#define FPne	(		A,
			B
	)		(fabs((A) - (B)) > EPSILON)

Definition at line 38 of file geo_decls.h.

Referenced by circle_ne(), and point_ne().

FPzero

#define FPzero

(

A

)

(fabs(A) <= EPSILON)

Definition at line 36 of file geo_decls.h.

Referenced by circle_poly(), close_pl(), line_distance(), line_eq(), line_horizontal(), line_in(), line_interpt_internal(), line_parallel(), line_perp(), line_vertical(), lseg_crossing(), lseg_perp(), and on_pl().

HYPOT

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

Definition at line 53 of file geo_decls.h.

Referenced by box_distance(), circle_div_pt(), circle_mul_pt(), dist_pl_internal(), point_distance(), and point_dt().

LinePGetDatum

#define LinePGetDatum

(

X

)

PointerGetDatum(X)

Definition at line 155 of file geo_decls.h.

Referenced by line_distance(), line_interpt_internal(), line_intersect(), and on_sl().

LsegPGetDatum

#define LsegPGetDatum

(

X

)

PointerGetDatum(X)

Definition at line 143 of file geo_decls.h.

Referenced by close_lseg(), close_pb(), close_sb(), dist_sb(), interpt_pp(), and path_distance().

PathPGetDatum

#define PathPGetDatum

(

X

)

PointerGetDatum(X)

Definition at line 149 of file geo_decls.h.

PG_GETARG_BOX_P

#define PG_GETARG_BOX_P

(

n

)

DatumGetBoxP(PG_GETARG_DATUM(n))

Definition at line 161 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_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 173 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(), 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 156 of file geo_decls.h.

Referenced by close_lb(), close_ls(), close_pl(), close_sl(), dist_lb(), 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 144 of file geo_decls.h.

Referenced by close_ls(), close_lseg(), close_ps(), close_sb(), close_sl(), dist_ps(), dist_sb(), dist_sl(), 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 150 of file geo_decls.h.

Referenced by 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 151 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 139 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_cpoint(), dist_pb(), dist_pc(), dist_pl(), dist_polyp(), dist_ppath(), dist_ppoly(), dist_ps(), 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 167 of file geo_decls.h.

Referenced by dist_cpoly(), 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_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 168 of file geo_decls.h.

PG_RETURN_BOX_P

#define PG_RETURN_BOX_P

(

x

)

return BoxPGetDatum(x)

Definition at line 162 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 174 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 157 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 145 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 152 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 140 of file geo_decls.h.

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

PG_RETURN_POLYGON_P

#define PG_RETURN_POLYGON_P

(

x

)

return PolygonPGetDatum(x)

Definition at line 169 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 138 of file geo_decls.h.

Referenced by box_div(), box_mul(), circle_div_pt(), circle_mul_pt(), close_lseg(), close_pb(), close_sb(), dist_pb(), dist_sb(), gist_point_consistent(), inter_sb(), on_sb(), on_sl(), path_div_pt(), path_mul_pt(), spg_kd_choose(), spg_kd_picksplit(), spg_quad_choose(), and spg_quad_picksplit().

PolygonPGetDatum

#define PolygonPGetDatum

(

X

)

PointerGetDatum(X)

Definition at line 166 of file geo_decls.h.

Referenced by gist_point_consistent(), and poly_center().

Function Documentation

box_copy()

BOX* box_copy

(

BOX *

box

)

Definition at line 485 of file geo_ops.c.

References palloc().

Referenced by poly_box(), and spg_poly_quad_compress().

{
    BOX        *result = (BOX *) palloc(sizeof(BOX));

    memcpy((char *) result, (char *) box, sizeof(BOX));

    return result;
}

pg_hypot()

double pg_hypot	(	double	x,
		double	y
	)

Definition at line 5453 of file geo_ops.c.

References get_float8_infinity(), get_float8_nan(), and isinf().

{
    double      yx;

    /* Handle INF and NaN properly */
    if (isinf(x) || isinf(y))
        return get_float8_infinity();

    if (isnan(x) || isnan(y))
        return get_float8_nan();

    /* Else, drop any minus signs */
    x = fabs(x);
    y = fabs(y);

    /* Swap x and y if needed to make x the larger one */
    if (x < y)
    {
        double      temp = x;

        x = y;
        y = temp;
    }

    /*
     * If y is zero, the hypotenuse is x.  This test saves a few cycles in
     * such cases, but more importantly it also protects against
     * divide-by-zero errors, since now x >= y.
     */
    if (y == 0.0)
        return x;

    /* Determine the hypotenuse */
    yx = y / x;
    return x * sqrt(1.0 + (yx * yx));
}

point_dt()

double point_dt	(	Point *	pt1,
		Point *	pt2
	)

Definition at line 1905 of file geo_ops.c.

References HYPOT, Point::x, and Point::y.

Referenced by box_circle(), circle_contain(), circle_contain_pt(), circle_contained(), circle_distance(), circle_overlap(), dist_cpoint(), dist_pb(), dist_pc(), dist_ppath(), dist_ps_internal(), lseg_ge(), lseg_gt(), lseg_le(), lseg_length(), lseg_lt(), on_ppath(), on_ps_internal(), path_length(), poly_circle(), pt_contained_circle(), and pt_in_widget().

{
#ifdef GEODEBUG
    printf("point_dt- segment (%f,%f),(%f,%f) length is %f\n",
           pt1->x, pt1->y, pt2->x, pt2->y, HYPOT(pt1->x - pt2->x, pt1->y - pt2->y));
#endif
    return HYPOT(pt1->x - pt2->x, pt1->y - pt2->y);
}

point_sl()

double point_sl	(	Point *	pt1,
		Point *	pt2
	)

Definition at line 1925 of file geo_ops.c.

References FPeq, Point::x, and Point::y.

Referenced by close_ps(), lseg_parallel(), lseg_perp(), and point_slope().

{
    return (FPeq(pt1->x, pt2->x)
            ? (double) DBL_MAX
            : (pt1->y - pt2->y) / (pt1->x - pt2->x));
}