tbox.h

Go to the documentation of this file.

/*****************************************************************************
 *
 * This MobilityDB code is provided under The PostgreSQL License.
 *
 * Copyright (c) 2016-2021, Université libre de Bruxelles and MobilityDB
 * contributors
 *
 * MobilityDB includes portions of PostGIS version 3 source code released
 * under the GNU General Public License (GPLv2 or later).
 * Copyright (c) 2001-2021, PostGIS contributors
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation for any purpose, without fee, and without a written
 * agreement is hereby granted, provided that the above copyright notice and
 * this paragraph and the following two paragraphs appear in all copies.
 *
 * IN NO EVENT SHALL UNIVERSITE LIBRE DE BRUXELLES BE LIABLE TO ANY PARTY FOR
 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING
 * LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION,
 * EVEN IF UNIVERSITE LIBRE DE BRUXELLES HAS BEEN ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
 * UNIVERSITE LIBRE DE BRUXELLES SPECIFICALLY DISCLAIMS ANY WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS ON
 * AN "AS IS" BASIS, AND UNIVERSITE LIBRE DE BRUXELLES HAS NO OBLIGATIONS TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. 
 *
 *****************************************************************************/

#ifndef __TBOX_H__
#define __TBOX_H__

#include <postgres.h>
#include <catalog/pg_type.h>
#include <utils/rangetypes.h>
#if POSTGRESQL_VERSION_NUMBER < 110000
#include <utils/timestamp.h>
#endif

#include "timetypes.h"

/*****************************************************************************/

typedef struct
{
  double      xmin;   
  double      xmax;   
  TimestampTz tmin;   
  TimestampTz tmax;   
  int16       flags;  
} TBOX;

/* fmgr macros temporal types */

#define DatumGetTboxP(X)  ((TBOX *) DatumGetPointer(X))
#define TboxPGetDatum(X)  PointerGetDatum(X)
#define PG_GETARG_TBOX_P(n) DatumGetTboxP(PG_GETARG_DATUM(n))
#define PG_RETURN_TBOX_P(x) return TboxPGetDatum(x)

/* Miscellaneous functions */

extern TBOX *tbox_make(bool hasx, bool hast, double xmin, double xmax,
  TimestampTz tmin, TimestampTz tmax);
extern void tbox_set(TBOX *box, bool hasx, bool hast, double xmin,
  double xmax, TimestampTz tmin, TimestampTz tmax);
extern TBOX *tbox_copy(const TBOX *box);
extern void tbox_expand(TBOX *box1, const TBOX *box2);
extern void tbox_shift_tscale(TBOX *box, const Interval *start,
  const Interval *duration);

/* Parameter tests */

extern void ensure_has_X_tbox(const TBOX *box);
extern void ensure_has_T_tbox(const TBOX *box);
extern void ensure_same_dimensionality_tbox(const TBOX *box1, const TBOX *box2);

/* Input/output functions */

extern Datum tbox_in(PG_FUNCTION_ARGS);
extern Datum tbox_out(PG_FUNCTION_ARGS);

/* Constructor functions */

extern Datum tbox_constructor(PG_FUNCTION_ARGS);
extern Datum tbox_constructor_t(PG_FUNCTION_ARGS);

/* Casting */

extern Datum tbox_to_floatrange(PG_FUNCTION_ARGS);
extern Datum tbox_to_period(PG_FUNCTION_ARGS);

/* Transform a type to a TBOX */

extern Datum int_to_tbox(PG_FUNCTION_ARGS);
extern Datum float_to_tbox(PG_FUNCTION_ARGS);
extern Datum number_to_tbox(PG_FUNCTION_ARGS);
extern Datum range_to_tbox(PG_FUNCTION_ARGS);
extern Datum timestamp_to_tbox(PG_FUNCTION_ARGS);
extern Datum period_to_tbox(PG_FUNCTION_ARGS);
extern Datum timestampset_to_tbox(PG_FUNCTION_ARGS);
extern Datum periodset_to_tbox(PG_FUNCTION_ARGS);
extern Datum int_timestamp_to_tbox(PG_FUNCTION_ARGS);
extern Datum float_timestamp_to_tbox(PG_FUNCTION_ARGS);
extern Datum int_period_to_tbox(PG_FUNCTION_ARGS);
extern Datum float_period_to_tbox(PG_FUNCTION_ARGS);
extern Datum range_timestamp_to_tbox(PG_FUNCTION_ARGS);
extern Datum range_period_to_tbox(PG_FUNCTION_ARGS);

extern void number_to_box(TBOX *box, Datum value, Oid basetypid);
extern void range_to_tbox_internal(TBOX *box, const RangeType *r);
extern void int_to_tbox_internal(TBOX *box, int i);
extern void float_to_tbox_internal(TBOX *box, double d);
extern void timestamp_to_tbox_internal(TBOX *box, TimestampTz t);
extern void timestampset_to_tbox_internal(TBOX *box, const TimestampSet *ts);
extern void period_to_tbox_internal(TBOX *box, const Period *p);
extern void periodset_to_tbox_internal(TBOX *box, const PeriodSet *ps);

/* Accessor functions */

extern Datum tbox_xmin(PG_FUNCTION_ARGS);
extern Datum tbox_xmax(PG_FUNCTION_ARGS);
extern Datum tbox_tmin(PG_FUNCTION_ARGS);
extern Datum tbox_tmax(PG_FUNCTION_ARGS);

/* Casting */

extern Datum tbox_expand_value(PG_FUNCTION_ARGS);
extern Datum tbox_expand_temporal(PG_FUNCTION_ARGS);
extern Datum tbox_set_precision(PG_FUNCTION_ARGS);

/* Topological functions */

extern Datum contains_tbox_tbox(PG_FUNCTION_ARGS);
extern Datum contained_tbox_tbox(PG_FUNCTION_ARGS);
extern Datum overlaps_tbox_tbox(PG_FUNCTION_ARGS);
extern Datum same_tbox_tbox(PG_FUNCTION_ARGS);
extern Datum adjacent_tbox_tbox(PG_FUNCTION_ARGS);

extern bool contains_tbox_tbox_internal(const TBOX *box1, const TBOX *box2);
extern bool contained_tbox_tbox_internal(const TBOX *box1, const TBOX *box2);
extern bool overlaps_tbox_tbox_internal(const TBOX *box1, const TBOX *box2);
extern bool same_tbox_tbox_internal(const TBOX *box1, const TBOX *box2);
extern bool adjacent_tbox_tbox_internal(const TBOX *box1, const TBOX *box2);

/* Position functions */

extern Datum left_tbox_tbox(PG_FUNCTION_ARGS);
extern Datum overleft_tbox_tbox(PG_FUNCTION_ARGS);
extern Datum right_tbox_tbox(PG_FUNCTION_ARGS);
extern Datum overright_tbox_tbox(PG_FUNCTION_ARGS);
extern Datum before_tbox_tbox(PG_FUNCTION_ARGS);
extern Datum overbefore_tbox_tbox(PG_FUNCTION_ARGS);
extern Datum after_tbox_tbox(PG_FUNCTION_ARGS);
extern Datum overafter_tbox_tbox(PG_FUNCTION_ARGS);

extern bool left_tbox_tbox_internal(const TBOX *box1, const TBOX *box2);
extern bool overleft_tbox_tbox_internal(const TBOX *box1, const TBOX *box2);
extern bool right_tbox_tbox_internal(const TBOX *box1, const TBOX *box2);
extern bool overright_tbox_tbox_internal(const TBOX *box1, const TBOX *box2);
extern bool before_tbox_tbox_internal(const TBOX *box1, const TBOX *box2);
extern bool overbefore_tbox_tbox_internal(const TBOX *box1, const TBOX *box2);
extern bool after_tbox_tbox_internal(const TBOX *box1, const TBOX *box2);
extern bool overafter_tbox_tbox_internal(const TBOX *box1, const TBOX *box2);

/* Set functions */

extern Datum tbox_union(PG_FUNCTION_ARGS);
extern Datum tbox_intersection(PG_FUNCTION_ARGS);

extern TBOX *tbox_union_internal(const TBOX *box1, const TBOX *box2);
extern TBOX *tbox_minus_internal(const TBOX *box1, const TBOX *box2);
extern TBOX *tbox_intersection_internal(const TBOX *box1, const TBOX *box2);

/* Comparison functions */

extern Datum tbox_cmp(PG_FUNCTION_ARGS);
extern Datum tbox_lt(PG_FUNCTION_ARGS);
extern Datum tbox_le(PG_FUNCTION_ARGS);
extern Datum tbox_gt(PG_FUNCTION_ARGS);
extern Datum tbox_ge(PG_FUNCTION_ARGS);
extern Datum tbox_eq(PG_FUNCTION_ARGS);
extern Datum tbox_ne(PG_FUNCTION_ARGS);

extern int tbox_cmp_internal(const TBOX *box1, const TBOX *box2);
extern bool tbox_eq_internal(const TBOX *box1, const TBOX *box2);

/*****************************************************************************/

#endif