MobilityDB 1.3
Loading...
Searching...
No Matches
tbox.h
Go to the documentation of this file.
1/*****************************************************************************
2 *
3 * This MobilityDB code is provided under The PostgreSQL License.
4 * Copyright (c) 2016-2025, Université libre de Bruxelles and MobilityDB
5 * contributors
6 *
7 * MobilityDB includes portions of PostGIS version 3 source code released
8 * under the GNU General Public License (GPLv2 or later).
9 * Copyright (c) 2001-2025, PostGIS contributors
10 *
11 * Permission to use, copy, modify, and distribute this software and its
12 * documentation for any purpose, without fee, and without a written
13 * agreement is hereby granted, provided that the above copyright notice and
14 * this paragraph and the following two paragraphs appear in all copies.
15 *
16 * IN NO EVENT SHALL UNIVERSITE LIBRE DE BRUXELLES BE LIABLE TO ANY PARTY FOR
17 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING
18 * LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION,
19 * EVEN IF UNIVERSITE LIBRE DE BRUXELLES HAS BEEN ADVISED OF THE POSSIBILITY
20 * OF SUCH DAMAGE.
21 *
22 * UNIVERSITE LIBRE DE BRUXELLES SPECIFICALLY DISCLAIMS ANY WARRANTIES,
23 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
24 * AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS ON
25 * AN "AS IS" BASIS, AND UNIVERSITE LIBRE DE BRUXELLES HAS NO OBLIGATIONS TO
26 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
27 *
28 *****************************************************************************/
29
34#ifndef __TBOX_H__
35#define __TBOX_H__
36
37/* PostgreSQL */
38#include <postgres.h>
39/* MEOS */
40#include <meos.h>
41
42/*****************************************************************************/
43
44/* fmgr macros temporal types */
45
46#define DatumGetTboxP(X) ((TBox *) DatumGetPointer(X))
47#define TboxPGetDatum(X) PointerGetDatum(X)
48#define PG_GETARG_TBOX_P(n) DatumGetTboxP(PG_GETARG_DATUM(n))
49#define PG_RETURN_TBOX_P(x) return TboxPGetDatum(x)
50
51/*****************************************************************************/
52
53/* Parameter tests */
54
55extern bool ensure_same_dimensionality_tbox(const TBox *box1, const TBox *box2);
56
57/* Conversion */
58
59extern TBox *set_tbox(const Set *s);
60extern TBox *span_tbox(const Span *s);
61extern Span *tbox_tstzspan(const TBox *box);
62extern Span *tbox_intspan(const TBox *box);
63extern Span *tbox_floatspan(const TBox *box);
64
65/*****************************************************************************/
66
67#endif
Span * tbox_floatspan(const TBox *box)
Convert a temporal box into a float span.
Definition: tbox.c:704
Span * tbox_intspan(const TBox *box)
Convert a temporal box into an integer span.
Definition: tbox.c:670
TBox * span_tbox(const Span *s)
Convert a number span into a temporal box.
Definition: tbox.c:595
Span * tbox_tstzspan(const TBox *box)
Convert a temporal box into a timestamptz span.
Definition: tbox.c:738
TBox * set_tbox(const Set *s)
Convert a number or a timestamptz set into a temporal box.
Definition: tbox.c:526
External API of the Mobility Engine Open Source (MEOS) library.
Structure to represent sets of values.
Definition: meos.h:80
Structure to represent spans (a.k.a.
Definition: meos.h:94
Structure to represent temporal boxes.
Definition: meos.h:124
bool ensure_same_dimensionality_tbox(const TBox *box1, const TBox *box2)
Ensure that a temporal boxes have the same dimensionality.
Definition: tbox.c:67