geo_decls.h

Go to the documentation of this file.

/*-------------------------------------------------------------------------
 *
 * geo_decls.h - Declarations for various 2D constructs.
 *
 *
 * Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group
 * Portions Copyright (c) 1994, Regents of the University of California
 *
 * src/include/utils/geo_decls.h
 *
 * NOTE
 *    These routines do *not* use the float types from adt/.
 *
 *    XXX These routines were not written by a numerical analyst.
 *
 *    XXX I have made some attempt to flesh out the operators
 *      and data types. There are still some more to do. - tgl 97/04/19
 *
 *-------------------------------------------------------------------------
 */
#ifndef GEO_DECLS_H
#define GEO_DECLS_H

#include <math.h>

#include "fmgr.h"

/*--------------------------------------------------------------------
 * Useful floating point utilities and constants.
 *-------------------------------------------------------------------*/


#define EPSILON                 1.0E-06

#ifdef EPSILON
#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)
#else
#define FPzero(A)               ((A) == 0)
#define FPeq(A,B)               ((A) == (B))
#define FPne(A,B)               ((A) != (B))
#define FPlt(A,B)               ((A) < (B))
#define FPle(A,B)               ((A) <= (B))
#define FPgt(A,B)               ((A) > (B))
#define FPge(A,B)               ((A) >= (B))
#endif

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

/*---------------------------------------------------------------------
 * Point - (x,y)
 *-------------------------------------------------------------------*/
typedef struct
{
    double      x,
                y;
} Point;


/*---------------------------------------------------------------------
 * LSEG - A straight line, specified by endpoints.
 *-------------------------------------------------------------------*/
typedef struct
{
    Point       p[2];
} LSEG;


/*---------------------------------------------------------------------
 * PATH - Specified by vertex points.
 *-------------------------------------------------------------------*/
typedef struct
{
    int32       vl_len_;        /* varlena header (do not touch directly!) */
    int32       npts;
    int32       closed;         /* is this a closed polygon? */
    int32       dummy;          /* padding to make it double align */
    Point       p[FLEXIBLE_ARRAY_MEMBER];
} PATH;


/*---------------------------------------------------------------------
 * LINE - Specified by its general equation (Ax+By+C=0).
 *-------------------------------------------------------------------*/
typedef struct
{
    double      A,
                B,
                C;
} LINE;


/*---------------------------------------------------------------------
 * BOX  - Specified by two corner points, which are
 *       sorted to save calculation time later.
 *-------------------------------------------------------------------*/
typedef struct
{
    Point       high,
                low;            /* corner POINTs */
} BOX;

/*---------------------------------------------------------------------
 * POLYGON - Specified by an array of doubles defining the points,
 *      keeping the number of points and the bounding box for
 *      speed purposes.
 *-------------------------------------------------------------------*/
typedef struct
{
    int32       vl_len_;        /* varlena header (do not touch directly!) */
    int32       npts;
    BOX         boundbox;
    Point       p[FLEXIBLE_ARRAY_MEMBER];
} POLYGON;

/*---------------------------------------------------------------------
 * CIRCLE - Specified by a center point and radius.
 *-------------------------------------------------------------------*/
typedef struct
{
    Point       center;
    double      radius;
} CIRCLE;

/*
 * fmgr interface macros
 *
 * Path and Polygon are toastable varlena types, the others are just
 * fixed-size pass-by-reference types.
 */

#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)


/*
 * in geo_ops.c
 */

/* private routines */
extern double point_dt(Point *pt1, Point *pt2);
extern double point_sl(Point *pt1, Point *pt2);
extern double pg_hypot(double x, double y);
extern BOX *box_copy(BOX *box);

#endif                          /* GEO_DECLS_H */