MobilityDB/master-dev/mobilitydb_2pg__include_2pg__geo_2tspatial_8h_source.html

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

 *

 * This MobilityDB code is provided under The PostgreSQL License.

 * Copyright (c) 2016-2025, 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-2025, 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 __PG_TSPATIAL_H__

#define __PG_TSPATIAL_H__


/* PostgreSQL */

#include <postgres.h>

#include <utils/array.h>

#include <fmgr.h>


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


/* Fetch from and store in the cache the fcinfo of the external function */

extern FunctionCallInfo fetch_fcinfo(void);

extern void store_fcinfo(FunctionCallInfo fcinfo);


extern Temporal *tspatial_valid_typmod(Temporal *temp, int32_t typmod);

extern uint32 tspatial_typmod_in(ArrayType *arr, int is_point, int is_geodetic);

extern Datum Spatialarr_as_text_ext(FunctionCallInfo fcinfo, bool extended);


extern Datum EAcomp_tspatial_geo(FunctionCallInfo fcinfo,

  int (*func)(const Temporal *, const GSERIALIZED *));

extern Datum EAcomp_geo_tspatial(FunctionCallInfo fcinfo,

  int (*func)(const GSERIALIZED *, const Temporal *));


extern Datum Tcomp_geo_tspatial(FunctionCallInfo fcinfo,

  Temporal * (*func)(const GSERIALIZED *, const Temporal *));

extern Datum Tcomp_tspatial_geo(FunctionCallInfo fcinfo,

  Temporal * (*func)(const Temporal *, const GSERIALIZED *));


extern Datum EA_spatialrel_geo_tspatial(FunctionCallInfo fcinfo,

  int (*func)(const GSERIALIZED *, const Temporal *, bool), bool ever);

extern Datum EA_spatialrel_tspatial_geo(FunctionCallInfo fcinfo,

  int (*func)(const Temporal *, const GSERIALIZED *, bool), bool ever);

extern Datum EA_spatialrel_tspatial_tspatial(FunctionCallInfo fcinfo,

  int (*func)(const Temporal *, const Temporal *, bool), bool ever);


extern Datum Tspatialrel_geo_tspatial(FunctionCallInfo fcinfo,

  Temporal * (*func)(const GSERIALIZED *, const Temporal *, bool, bool));

extern Datum Tspatialrel_tspatial_geo(FunctionCallInfo fcinfo,

  Temporal * (*func)(const Temporal *, const GSERIALIZED *, bool, bool));

extern Datum Tspatialrel_tspatial_tspatial(FunctionCallInfo fcinfo,

  Temporal * (*func)(const Temporal *, const Temporal *, bool, bool));


extern Datum EA_dwithin_tspatial_geo(FunctionCallInfo fcinfo,

  int (*func)(const Temporal *, const GSERIALIZED *, double dist, bool),

  bool ever);

extern Datum EA_dwithin_geo_tspatial(FunctionCallInfo fcinfo,

  int (*func)(const Temporal *, const GSERIALIZED *, double dist, bool),

  bool ever);


extern Datum Tdwithin_geo_tspatial(FunctionCallInfo fcinfo,

  Temporal * (*func)(const GSERIALIZED *, const Temporal *, double, bool, bool));

extern Datum Tdwithin_tspatial_geo(FunctionCallInfo fcinfo,

  Temporal * (*func)(const Temporal *, const GSERIALIZED *, double, bool, bool));

extern Datum Tdwithin_tspatial_tspatial(FunctionCallInfo fcinfo,

  Temporal * (*func)(const Temporal *, const Temporal *, double, bool, bool));


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


#endif /* __PG_TSPATIAL_H__ */

fetch_fcinfo
FunctionCallInfo fetch_fcinfo(void)
Spatial functions for temporal points.
Definition: temporal.c:104

EA_dwithin_tspatial_geo
Datum EA_dwithin_tspatial_geo(FunctionCallInfo fcinfo, int(*func)(const Temporal *, const GSERIALIZED *, double dist, bool), bool ever)
Return true if a spatiotemporal value and a geometry are ever/always within a distance.
Definition: tgeo_spatialrels.c:149

Tspatialrel_tspatial_geo
Datum Tspatialrel_tspatial_geo(FunctionCallInfo fcinfo, Temporal *(*func)(const Temporal *, const GSERIALIZED *, bool, bool))
Return a temporal boolean that states whether a spatial temporal value and a geometry satisfy a spati...
Definition: tspatial_tempspatialrels.c:92

EA_spatialrel_tspatial_geo
Datum EA_spatialrel_tspatial_geo(FunctionCallInfo fcinfo, int(*func)(const Temporal *, const GSERIALIZED *, bool), bool ever)
Return true if a spatiotemporal value and a geometry ever/always satisfy a spatial relationship.
Definition: tgeo_spatialrels.c:88

Tcomp_geo_tspatial
Datum Tcomp_geo_tspatial(FunctionCallInfo fcinfo, Temporal *(*func)(const GSERIALIZED *, const Temporal *))
Generic function for the temporal comparison operators.
Definition: tgeo_compops.c:281

Tdwithin_geo_tspatial
Datum Tdwithin_geo_tspatial(FunctionCallInfo fcinfo, Temporal *(*func)(const GSERIALIZED *, const Temporal *, double, bool, bool))
Return a temporal boolean that states whether a geometry and a spatiotemporal value are within a give...
Definition: tspatial_tempspatialrels.c:149

EA_spatialrel_geo_tspatial
Datum EA_spatialrel_geo_tspatial(FunctionCallInfo fcinfo, int(*func)(const GSERIALIZED *, const Temporal *, bool), bool ever)
Return true if a geometry and a spatiotemporal value ever/always satisfy a spatial relationship.
Definition: tgeo_spatialrels.c:70

Tspatialrel_tspatial_tspatial
Datum Tspatialrel_tspatial_tspatial(FunctionCallInfo fcinfo, Temporal *(*func)(const Temporal *, const Temporal *, bool, bool))
Return a temporal boolean that states whether two spatial temporal values satisfy a spatial relations...
Definition: tspatial_tempspatialrels.c:119

EAcomp_tspatial_geo
Datum EAcomp_tspatial_geo(FunctionCallInfo fcinfo, int(*func)(const Temporal *, const GSERIALIZED *))
Generic function for the temporal ever/always comparison operators.
Definition: tgeo_compops.c:80

store_fcinfo
void store_fcinfo(FunctionCallInfo fcinfo)
Store in the cache the fcinfo of the external function.
Definition: temporal.c:114

EA_spatialrel_tspatial_tspatial
Datum EA_spatialrel_tspatial_tspatial(FunctionCallInfo fcinfo, int(*func)(const Temporal *, const Temporal *, bool), bool ever)
Return true if two spatiotemporal values ever/always satisfy the spatial relationship.
Definition: tgeo_spatialrels.c:109

EA_dwithin_geo_tspatial
Datum EA_dwithin_geo_tspatial(FunctionCallInfo fcinfo, int(*func)(const Temporal *, const GSERIALIZED *, double dist, bool), bool ever)
Return true if a geometry and a spatiotemporal value are ever/always within a distance.
Definition: tgeo_spatialrels.c:129

Tdwithin_tspatial_tspatial
Datum Tdwithin_tspatial_tspatial(FunctionCallInfo fcinfo, Temporal *(*func)(const Temporal *, const Temporal *, double, bool, bool))
Return a temporal boolean that states whether two spatiotemporal values are within a given distance.
Definition: tspatial_tempspatialrels.c:205

EAcomp_geo_tspatial
Datum EAcomp_geo_tspatial(FunctionCallInfo fcinfo, int(*func)(const GSERIALIZED *, const Temporal *))
Generic function for the temporal ever/always comparison operators.
Definition: tgeo_compops.c:61

tspatial_typmod_in
uint32 tspatial_typmod_in(ArrayType *arr, int is_point, int is_geodetic)
Input typmod information for temporal geos.
Definition: tgeo.c:152

tspatial_valid_typmod
Temporal * tspatial_valid_typmod(Temporal *temp, int32_t typmod)
Check the consistency of the metadata specified in the typmod: temporal subtype, geometry type,...
Definition: tgeo.c:408

Tspatialrel_geo_tspatial
Datum Tspatialrel_geo_tspatial(FunctionCallInfo fcinfo, Temporal *(*func)(const GSERIALIZED *, const Temporal *, bool, bool))
Return a temporal boolean that states whether a geometry and a spatiotemporal value satisfy a spatial...
Definition: tspatial_tempspatialrels.c:65

Tdwithin_tspatial_geo
Datum Tdwithin_tspatial_geo(FunctionCallInfo fcinfo, Temporal *(*func)(const Temporal *, const GSERIALIZED *, double, bool, bool))
Return a temporal boolean that states whether a spatiotemporal value and a geometry are within a give...
Definition: tspatial_tempspatialrels.c:177

Tcomp_tspatial_geo
Datum Tcomp_tspatial_geo(FunctionCallInfo fcinfo, Temporal *(*func)(const Temporal *, const GSERIALIZED *))
Generic function for the temporal comparison operators.
Definition: tgeo_compops.c:301

Spatialarr_as_text_ext
Datum Spatialarr_as_text_ext(FunctionCallInfo fcinfo, bool extended)
Return the (Extended) Well-Known Text (WKT or EWKT) representation of an array of spatial values (ext...
Definition: spatialset.c:144

postgres.h

uint32
unsigned int uint32
Definition: postgres_ext_defs.in.h:16

Datum
uintptr_t Datum
Definition: postgres_ext_defs.in.h:7

GSERIALIZED
Definition: postgis_ext_defs.in.h:170

Temporal
Structure to represent the common structure of temporal values of any temporal subtype.
Definition: meos.h:173

ever
int const GSERIALIZED bool ever
Definition: trgeo_spatialrels.h:53