LCOV - code coverage report
Current view: top level - contrib/cube - cube.c (source / functions) Hit Total Coverage
Test: PostgreSQL 19devel Lines: 720 817 88.1 %
Date: 2026-02-02 14:17:46 Functions: 89 95 93.7 %
Legend: Lines: hit not hit

          Line data    Source code
       1             : /******************************************************************************
       2             :   contrib/cube/cube.c
       3             : 
       4             :   This file contains routines that can be bound to a Postgres backend and
       5             :   called by the backend in the process of processing queries.  The calling
       6             :   format for these routines is dictated by Postgres architecture.
       7             : ******************************************************************************/
       8             : 
       9             : #include "postgres.h"
      10             : 
      11             : #include <math.h>
      12             : 
      13             : #include "access/gist.h"
      14             : #include "access/stratnum.h"
      15             : #include "cubedata.h"
      16             : #include "libpq/pqformat.h"
      17             : #include "utils/array.h"
      18             : #include "utils/float.h"
      19             : 
      20           6 : PG_MODULE_MAGIC_EXT(
      21             :                     .name = "cube",
      22             :                     .version = PG_VERSION
      23             : );
      24             : 
      25             : /*
      26             :  * Taken from the intarray contrib header
      27             :  */
      28             : #define ARRPTR(x)  ( (double *) ARR_DATA_PTR(x) )
      29             : #define ARRNELEMS(x)  ArrayGetNItems( ARR_NDIM(x), ARR_DIMS(x))
      30             : 
      31             : /*
      32             : ** Input/Output routines
      33             : */
      34          12 : PG_FUNCTION_INFO_V1(cube_in);
      35           8 : PG_FUNCTION_INFO_V1(cube_a_f8_f8);
      36           8 : PG_FUNCTION_INFO_V1(cube_a_f8);
      37          10 : PG_FUNCTION_INFO_V1(cube_out);
      38           6 : PG_FUNCTION_INFO_V1(cube_send);
      39           6 : PG_FUNCTION_INFO_V1(cube_recv);
      40          10 : PG_FUNCTION_INFO_V1(cube_f8);
      41           8 : PG_FUNCTION_INFO_V1(cube_f8_f8);
      42          10 : PG_FUNCTION_INFO_V1(cube_c_f8);
      43           8 : PG_FUNCTION_INFO_V1(cube_c_f8_f8);
      44          10 : PG_FUNCTION_INFO_V1(cube_dim);
      45          10 : PG_FUNCTION_INFO_V1(cube_ll_coord);
      46          10 : PG_FUNCTION_INFO_V1(cube_ur_coord);
      47           8 : PG_FUNCTION_INFO_V1(cube_coord);
      48           8 : PG_FUNCTION_INFO_V1(cube_coord_llur);
      49           8 : PG_FUNCTION_INFO_V1(cube_subset);
      50             : 
      51             : /*
      52             : ** GiST support methods
      53             : */
      54             : 
      55           8 : PG_FUNCTION_INFO_V1(g_cube_consistent);
      56           6 : PG_FUNCTION_INFO_V1(g_cube_compress);
      57           6 : PG_FUNCTION_INFO_V1(g_cube_decompress);
      58           8 : PG_FUNCTION_INFO_V1(g_cube_penalty);
      59           8 : PG_FUNCTION_INFO_V1(g_cube_picksplit);
      60           8 : PG_FUNCTION_INFO_V1(g_cube_union);
      61           8 : PG_FUNCTION_INFO_V1(g_cube_same);
      62           8 : PG_FUNCTION_INFO_V1(g_cube_distance);
      63             : 
      64             : /*
      65             : ** B-tree support functions
      66             : */
      67           8 : PG_FUNCTION_INFO_V1(cube_eq);
      68           8 : PG_FUNCTION_INFO_V1(cube_ne);
      69           8 : PG_FUNCTION_INFO_V1(cube_lt);
      70           8 : PG_FUNCTION_INFO_V1(cube_gt);
      71           6 : PG_FUNCTION_INFO_V1(cube_le);
      72           6 : PG_FUNCTION_INFO_V1(cube_ge);
      73           8 : PG_FUNCTION_INFO_V1(cube_cmp);
      74             : 
      75             : /*
      76             : ** R-tree support functions
      77             : */
      78             : 
      79          10 : PG_FUNCTION_INFO_V1(cube_contains);
      80           8 : PG_FUNCTION_INFO_V1(cube_contained);
      81           8 : PG_FUNCTION_INFO_V1(cube_overlap);
      82           8 : PG_FUNCTION_INFO_V1(cube_union);
      83           8 : PG_FUNCTION_INFO_V1(cube_inter);
      84           8 : PG_FUNCTION_INFO_V1(cube_size);
      85             : 
      86             : /*
      87             : ** miscellaneous
      88             : */
      89           8 : PG_FUNCTION_INFO_V1(distance_taxicab);
      90          10 : PG_FUNCTION_INFO_V1(cube_distance);
      91           8 : PG_FUNCTION_INFO_V1(distance_chebyshev);
      92          10 : PG_FUNCTION_INFO_V1(cube_is_point);
      93          10 : PG_FUNCTION_INFO_V1(cube_enlarge);
      94             : 
      95             : /*
      96             : ** For internal use only
      97             : */
      98             : int32       cube_cmp_v0(NDBOX *a, NDBOX *b);
      99             : bool        cube_contains_v0(NDBOX *a, NDBOX *b);
     100             : bool        cube_overlap_v0(NDBOX *a, NDBOX *b);
     101             : NDBOX      *cube_union_v0(NDBOX *a, NDBOX *b);
     102             : void        rt_cube_size(NDBOX *a, double *size);
     103             : NDBOX      *g_cube_binary_union(NDBOX *r1, NDBOX *r2, int *sizep);
     104             : bool        g_cube_leaf_consistent(NDBOX *key, NDBOX *query, StrategyNumber strategy);
     105             : bool        g_cube_internal_consistent(NDBOX *key, NDBOX *query, StrategyNumber strategy);
     106             : 
     107             : /*
     108             : ** Auxiliary functions
     109             : */
     110             : static double distance_1D(double a1, double a2, double b1, double b2);
     111             : static bool cube_is_point_internal(NDBOX *cube);
     112             : 
     113             : 
     114             : /*****************************************************************************
     115             :  * Input/Output functions
     116             :  *****************************************************************************/
     117             : 
     118             : /* NdBox = [(lowerleft),(upperright)] */
     119             : /* [(xLL(1)...xLL(N)),(xUR(1)...xUR(n))] */
     120             : Datum
     121        6870 : cube_in(PG_FUNCTION_ARGS)
     122             : {
     123        6870 :     char       *str = PG_GETARG_CSTRING(0);
     124             :     NDBOX      *result;
     125             :     Size        scanbuflen;
     126             :     yyscan_t    scanner;
     127             : 
     128        6870 :     cube_scanner_init(str, &scanbuflen, &scanner);
     129             : 
     130        6870 :     cube_yyparse(&result, scanbuflen, fcinfo->context, scanner);
     131             : 
     132             :     /* We might as well run this even on failure. */
     133        6810 :     cube_scanner_finish(scanner);
     134             : 
     135        6810 :     PG_RETURN_NDBOX_P(result);
     136             : }
     137             : 
     138             : 
     139             : /*
     140             : ** Allows the construction of a cube from 2 float[]'s
     141             : */
     142             : Datum
     143          44 : cube_a_f8_f8(PG_FUNCTION_ARGS)
     144             : {
     145          44 :     ArrayType  *ur = PG_GETARG_ARRAYTYPE_P(0);
     146          44 :     ArrayType  *ll = PG_GETARG_ARRAYTYPE_P(1);
     147             :     NDBOX      *result;
     148             :     int         i;
     149             :     int         dim;
     150             :     int         size;
     151             :     bool        point;
     152             :     double     *dur,
     153             :                *dll;
     154             : 
     155          44 :     if (array_contains_nulls(ur) || array_contains_nulls(ll))
     156           0 :         ereport(ERROR,
     157             :                 (errcode(ERRCODE_ARRAY_ELEMENT_ERROR),
     158             :                  errmsg("cannot work with arrays containing NULLs")));
     159             : 
     160          44 :     dim = ARRNELEMS(ur);
     161          44 :     if (dim > CUBE_MAX_DIM)
     162           2 :         ereport(ERROR,
     163             :                 (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
     164             :                  errmsg("can't extend cube"),
     165             :                  errdetail("A cube cannot have more than %d dimensions.",
     166             :                            CUBE_MAX_DIM)));
     167             : 
     168          42 :     if (ARRNELEMS(ll) != dim)
     169           2 :         ereport(ERROR,
     170             :                 (errcode(ERRCODE_ARRAY_ELEMENT_ERROR),
     171             :                  errmsg("UR and LL arrays must be of same length")));
     172             : 
     173          40 :     dur = ARRPTR(ur);
     174          40 :     dll = ARRPTR(ll);
     175             : 
     176             :     /* Check if it's a point */
     177          40 :     point = true;
     178         446 :     for (i = 0; i < dim; i++)
     179             :     {
     180         440 :         if (dur[i] != dll[i])
     181             :         {
     182          34 :             point = false;
     183          34 :             break;
     184             :         }
     185             :     }
     186             : 
     187          40 :     size = point ? POINT_SIZE(dim) : CUBE_SIZE(dim);
     188          40 :     result = (NDBOX *) palloc0(size);
     189          40 :     SET_VARSIZE(result, size);
     190          40 :     SET_DIM(result, dim);
     191             : 
     192         548 :     for (i = 0; i < dim; i++)
     193         508 :         result->x[i] = dur[i];
     194             : 
     195          40 :     if (!point)
     196             :     {
     197         136 :         for (i = 0; i < dim; i++)
     198         102 :             result->x[i + dim] = dll[i];
     199             :     }
     200             :     else
     201           6 :         SET_POINT_BIT(result);
     202             : 
     203          40 :     PG_RETURN_NDBOX_P(result);
     204             : }
     205             : 
     206             : /*
     207             : ** Allows the construction of a zero-volume cube from a float[]
     208             : */
     209             : Datum
     210          16 : cube_a_f8(PG_FUNCTION_ARGS)
     211             : {
     212          16 :     ArrayType  *ur = PG_GETARG_ARRAYTYPE_P(0);
     213             :     NDBOX      *result;
     214             :     int         i;
     215             :     int         dim;
     216             :     int         size;
     217             :     double     *dur;
     218             : 
     219          16 :     if (array_contains_nulls(ur))
     220           0 :         ereport(ERROR,
     221             :                 (errcode(ERRCODE_ARRAY_ELEMENT_ERROR),
     222             :                  errmsg("cannot work with arrays containing NULLs")));
     223             : 
     224          16 :     dim = ARRNELEMS(ur);
     225          16 :     if (dim > CUBE_MAX_DIM)
     226           2 :         ereport(ERROR,
     227             :                 (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
     228             :                  errmsg("array is too long"),
     229             :                  errdetail("A cube cannot have more than %d dimensions.",
     230             :                            CUBE_MAX_DIM)));
     231             : 
     232          14 :     dur = ARRPTR(ur);
     233             : 
     234          14 :     size = POINT_SIZE(dim);
     235          14 :     result = (NDBOX *) palloc0(size);
     236          14 :     SET_VARSIZE(result, size);
     237          14 :     SET_DIM(result, dim);
     238          14 :     SET_POINT_BIT(result);
     239             : 
     240         446 :     for (i = 0; i < dim; i++)
     241         432 :         result->x[i] = dur[i];
     242             : 
     243          14 :     PG_RETURN_NDBOX_P(result);
     244             : }
     245             : 
     246             : Datum
     247          12 : cube_subset(PG_FUNCTION_ARGS)
     248             : {
     249          12 :     NDBOX      *c = PG_GETARG_NDBOX_P(0);
     250          12 :     ArrayType  *idx = PG_GETARG_ARRAYTYPE_P(1);
     251             :     NDBOX      *result;
     252             :     int         size,
     253             :                 dim,
     254             :                 i;
     255             :     int        *dx;
     256             : 
     257          12 :     if (array_contains_nulls(idx))
     258           0 :         ereport(ERROR,
     259             :                 (errcode(ERRCODE_ARRAY_ELEMENT_ERROR),
     260             :                  errmsg("cannot work with arrays containing NULLs")));
     261             : 
     262          12 :     dx = (int32 *) ARR_DATA_PTR(idx);
     263             : 
     264          12 :     dim = ARRNELEMS(idx);
     265          12 :     if (dim > CUBE_MAX_DIM)
     266           2 :         ereport(ERROR,
     267             :                 (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
     268             :                  errmsg("array is too long"),
     269             :                  errdetail("A cube cannot have more than %d dimensions.",
     270             :                            CUBE_MAX_DIM)));
     271             : 
     272          10 :     size = IS_POINT(c) ? POINT_SIZE(dim) : CUBE_SIZE(dim);
     273          10 :     result = (NDBOX *) palloc0(size);
     274          10 :     SET_VARSIZE(result, size);
     275          10 :     SET_DIM(result, dim);
     276             : 
     277          10 :     if (IS_POINT(c))
     278           6 :         SET_POINT_BIT(result);
     279             : 
     280         226 :     for (i = 0; i < dim; i++)
     281             :     {
     282         220 :         if ((dx[i] <= 0) || (dx[i] > DIM(c)))
     283           4 :             ereport(ERROR,
     284             :                     (errcode(ERRCODE_ARRAY_ELEMENT_ERROR),
     285             :                      errmsg("Index out of bounds")));
     286         216 :         result->x[i] = c->x[dx[i] - 1];
     287         216 :         if (!IS_POINT(c))
     288           8 :             result->x[i + dim] = c->x[dx[i] + DIM(c) - 1];
     289             :     }
     290             : 
     291           6 :     PG_FREE_IF_COPY(c, 0);
     292           6 :     PG_RETURN_NDBOX_P(result);
     293             : }
     294             : 
     295             : Datum
     296         778 : cube_out(PG_FUNCTION_ARGS)
     297             : {
     298         778 :     NDBOX      *cube = PG_GETARG_NDBOX_P(0);
     299             :     StringInfoData buf;
     300         778 :     int         dim = DIM(cube);
     301             :     int         i;
     302             : 
     303         778 :     initStringInfo(&buf);
     304             : 
     305         778 :     appendStringInfoChar(&buf, '(');
     306        2870 :     for (i = 0; i < dim; i++)
     307             :     {
     308        2092 :         if (i > 0)
     309        1318 :             appendStringInfoString(&buf, ", ");
     310        2092 :         appendStringInfoString(&buf, float8out_internal(LL_COORD(cube, i)));
     311             :     }
     312         778 :     appendStringInfoChar(&buf, ')');
     313             : 
     314         778 :     if (!cube_is_point_internal(cube))
     315             :     {
     316         580 :         appendStringInfoString(&buf, ",(");
     317        1760 :         for (i = 0; i < dim; i++)
     318             :         {
     319        1180 :             if (i > 0)
     320         600 :                 appendStringInfoString(&buf, ", ");
     321        1180 :             appendStringInfoString(&buf, float8out_internal(UR_COORD(cube, i)));
     322             :         }
     323         580 :         appendStringInfoChar(&buf, ')');
     324             :     }
     325             : 
     326         778 :     PG_FREE_IF_COPY(cube, 0);
     327         778 :     PG_RETURN_CSTRING(buf.data);
     328             : }
     329             : 
     330             : /*
     331             :  * cube_send - a binary output handler for cube type
     332             :  */
     333             : Datum
     334           0 : cube_send(PG_FUNCTION_ARGS)
     335             : {
     336           0 :     NDBOX      *cube = PG_GETARG_NDBOX_P(0);
     337             :     StringInfoData buf;
     338             :     int32       i,
     339           0 :                 nitems = DIM(cube);
     340             : 
     341           0 :     pq_begintypsend(&buf);
     342           0 :     pq_sendint32(&buf, cube->header);
     343           0 :     if (!IS_POINT(cube))
     344           0 :         nitems += nitems;
     345             :     /* for symmetry with cube_recv, we don't use LL_COORD/UR_COORD here */
     346           0 :     for (i = 0; i < nitems; i++)
     347           0 :         pq_sendfloat8(&buf, cube->x[i]);
     348             : 
     349           0 :     PG_RETURN_BYTEA_P(pq_endtypsend(&buf));
     350             : }
     351             : 
     352             : /*
     353             :  * cube_recv - a binary input handler for cube type
     354             :  */
     355             : Datum
     356           0 : cube_recv(PG_FUNCTION_ARGS)
     357             : {
     358           0 :     StringInfo  buf = (StringInfo) PG_GETARG_POINTER(0);
     359             :     int32       header;
     360             :     int32       i,
     361             :                 nitems;
     362             :     NDBOX      *cube;
     363             : 
     364           0 :     header = pq_getmsgint(buf, sizeof(int32));
     365           0 :     nitems = (header & DIM_MASK);
     366           0 :     if (nitems > CUBE_MAX_DIM)
     367           0 :         ereport(ERROR,
     368             :                 (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
     369             :                  errmsg("cube dimension is too large"),
     370             :                  errdetail("A cube cannot have more than %d dimensions.",
     371             :                            CUBE_MAX_DIM)));
     372           0 :     if ((header & POINT_BIT) == 0)
     373           0 :         nitems += nitems;
     374           0 :     cube = palloc(offsetof(NDBOX, x) + sizeof(double) * nitems);
     375           0 :     SET_VARSIZE(cube, offsetof(NDBOX, x) + sizeof(double) * nitems);
     376           0 :     cube->header = header;
     377           0 :     for (i = 0; i < nitems; i++)
     378           0 :         cube->x[i] = pq_getmsgfloat8(buf);
     379             : 
     380           0 :     PG_RETURN_NDBOX_P(cube);
     381             : }
     382             : 
     383             : 
     384             : /*****************************************************************************
     385             :  *                         GiST functions
     386             :  *****************************************************************************/
     387             : 
     388             : /*
     389             : ** The GiST Consistent method for boxes
     390             : ** Should return false if for all data items x below entry,
     391             : ** the predicate x op query == false, where op is the oper
     392             : ** corresponding to strategy in the pg_amop table.
     393             : */
     394             : Datum
     395         498 : g_cube_consistent(PG_FUNCTION_ARGS)
     396             : {
     397         498 :     GISTENTRY  *entry = (GISTENTRY *) PG_GETARG_POINTER(0);
     398         498 :     NDBOX      *query = PG_GETARG_NDBOX_P(1);
     399         498 :     StrategyNumber strategy = (StrategyNumber) PG_GETARG_UINT16(2);
     400             : #ifdef NOT_USED
     401             :     Oid         subtype = PG_GETARG_OID(3);
     402             : #endif
     403         498 :     bool       *recheck = (bool *) PG_GETARG_POINTER(4);
     404             :     bool        res;
     405             : 
     406             :     /* All cases served by this function are exact */
     407         498 :     *recheck = false;
     408             : 
     409             :     /*
     410             :      * if entry is not leaf, use g_cube_internal_consistent, else use
     411             :      * g_cube_leaf_consistent
     412             :      */
     413         498 :     if (GIST_LEAF(entry))
     414         288 :         res = g_cube_leaf_consistent(DatumGetNDBOXP(entry->key),
     415             :                                      query, strategy);
     416             :     else
     417         210 :         res = g_cube_internal_consistent(DatumGetNDBOXP(entry->key),
     418             :                                          query, strategy);
     419             : 
     420         498 :     PG_FREE_IF_COPY(query, 1);
     421         498 :     PG_RETURN_BOOL(res);
     422             : }
     423             : 
     424             : 
     425             : /*
     426             : ** The GiST Union method for boxes
     427             : ** returns the minimal bounding box that encloses all the entries in entryvec
     428             : */
     429             : Datum
     430        5924 : g_cube_union(PG_FUNCTION_ARGS)
     431             : {
     432        5924 :     GistEntryVector *entryvec = (GistEntryVector *) PG_GETARG_POINTER(0);
     433        5924 :     int        *sizep = (int *) PG_GETARG_POINTER(1);
     434        5924 :     NDBOX      *out = (NDBOX *) NULL;
     435             :     NDBOX      *tmp;
     436             :     int         i;
     437             : 
     438        5924 :     tmp = DatumGetNDBOXP(entryvec->vector[0].key);
     439             : 
     440             :     /*
     441             :      * sizep = sizeof(NDBOX); -- NDBOX has variable size
     442             :      */
     443        5924 :     *sizep = VARSIZE(tmp);
     444             : 
     445       11848 :     for (i = 1; i < entryvec->n; i++)
     446             :     {
     447        5924 :         out = g_cube_binary_union(tmp,
     448        5924 :                                   DatumGetNDBOXP(entryvec->vector[i].key),
     449             :                                   sizep);
     450        5924 :         tmp = out;
     451             :     }
     452             : 
     453        5924 :     PG_RETURN_POINTER(out);
     454             : }
     455             : 
     456             : /*
     457             : ** GiST Compress and Decompress methods for boxes
     458             : ** do not do anything.
     459             : */
     460             : 
     461             : Datum
     462           0 : g_cube_compress(PG_FUNCTION_ARGS)
     463             : {
     464           0 :     PG_RETURN_DATUM(PG_GETARG_DATUM(0));
     465             : }
     466             : 
     467             : Datum
     468           0 : g_cube_decompress(PG_FUNCTION_ARGS)
     469             : {
     470           0 :     GISTENTRY  *entry = (GISTENTRY *) PG_GETARG_POINTER(0);
     471           0 :     NDBOX      *key = DatumGetNDBOXP(entry->key);
     472             : 
     473           0 :     if (key != DatumGetNDBOXP(entry->key))
     474             :     {
     475           0 :         GISTENTRY  *retval = palloc_object(GISTENTRY);
     476             : 
     477           0 :         gistentryinit(*retval, PointerGetDatum(key),
     478             :                       entry->rel, entry->page,
     479             :                       entry->offset, false);
     480           0 :         PG_RETURN_POINTER(retval);
     481             :     }
     482           0 :     PG_RETURN_POINTER(entry);
     483             : }
     484             : 
     485             : 
     486             : /*
     487             : ** The GiST Penalty method for boxes
     488             : ** As in the R-tree paper, we use change in area as our penalty metric
     489             : */
     490             : Datum
     491       86362 : g_cube_penalty(PG_FUNCTION_ARGS)
     492             : {
     493       86362 :     GISTENTRY  *origentry = (GISTENTRY *) PG_GETARG_POINTER(0);
     494       86362 :     GISTENTRY  *newentry = (GISTENTRY *) PG_GETARG_POINTER(1);
     495       86362 :     float      *result = (float *) PG_GETARG_POINTER(2);
     496             :     NDBOX      *ud;
     497             :     double      tmp1,
     498             :                 tmp2;
     499             : 
     500       86362 :     ud = cube_union_v0(DatumGetNDBOXP(origentry->key),
     501       86362 :                        DatumGetNDBOXP(newentry->key));
     502       86362 :     rt_cube_size(ud, &tmp1);
     503       86362 :     rt_cube_size(DatumGetNDBOXP(origentry->key), &tmp2);
     504       86362 :     *result = (float) (tmp1 - tmp2);
     505             : 
     506       86362 :     PG_RETURN_FLOAT8(*result);
     507             : }
     508             : 
     509             : 
     510             : 
     511             : /*
     512             : ** The GiST PickSplit method for boxes
     513             : ** We use Guttman's poly time split algorithm
     514             : */
     515             : Datum
     516          68 : g_cube_picksplit(PG_FUNCTION_ARGS)
     517             : {
     518          68 :     GistEntryVector *entryvec = (GistEntryVector *) PG_GETARG_POINTER(0);
     519          68 :     GIST_SPLITVEC *v = (GIST_SPLITVEC *) PG_GETARG_POINTER(1);
     520             :     OffsetNumber i,
     521             :                 j;
     522             :     NDBOX      *datum_alpha,
     523             :                *datum_beta;
     524             :     NDBOX      *datum_l,
     525             :                *datum_r;
     526             :     NDBOX      *union_d,
     527             :                *union_dl,
     528             :                *union_dr;
     529             :     NDBOX      *inter_d;
     530             :     bool        firsttime;
     531             :     double      size_alpha,
     532             :                 size_beta,
     533             :                 size_union,
     534             :                 size_inter;
     535             :     double      size_waste,
     536             :                 waste;
     537             :     double      size_l,
     538             :                 size_r;
     539             :     int         nbytes;
     540          68 :     OffsetNumber seed_1 = 1,
     541          68 :                 seed_2 = 2;
     542             :     OffsetNumber *left,
     543             :                *right;
     544             :     OffsetNumber maxoff;
     545             : 
     546          68 :     maxoff = entryvec->n - 2;
     547          68 :     nbytes = (maxoff + 2) * sizeof(OffsetNumber);
     548          68 :     v->spl_left = (OffsetNumber *) palloc(nbytes);
     549          68 :     v->spl_right = (OffsetNumber *) palloc(nbytes);
     550             : 
     551          68 :     firsttime = true;
     552          68 :     waste = 0.0;
     553             : 
     554        9520 :     for (i = FirstOffsetNumber; i < maxoff; i = OffsetNumberNext(i))
     555             :     {
     556        9452 :         datum_alpha = DatumGetNDBOXP(entryvec->vector[i].key);
     557      671092 :         for (j = OffsetNumberNext(i); j <= maxoff; j = OffsetNumberNext(j))
     558             :         {
     559      661640 :             datum_beta = DatumGetNDBOXP(entryvec->vector[j].key);
     560             : 
     561             :             /* compute the wasted space by unioning these guys */
     562             :             /* size_waste = size_union - size_inter; */
     563      661640 :             union_d = cube_union_v0(datum_alpha, datum_beta);
     564      661640 :             rt_cube_size(union_d, &size_union);
     565      661640 :             inter_d = DatumGetNDBOXP(DirectFunctionCall2(cube_inter,
     566             :                                                          entryvec->vector[i].key,
     567             :                                                          entryvec->vector[j].key));
     568      661640 :             rt_cube_size(inter_d, &size_inter);
     569      661640 :             size_waste = size_union - size_inter;
     570             : 
     571             :             /*
     572             :              * are these a more promising split than what we've already seen?
     573             :              */
     574             : 
     575      661640 :             if (size_waste > waste || firsttime)
     576             :             {
     577         896 :                 waste = size_waste;
     578         896 :                 seed_1 = i;
     579         896 :                 seed_2 = j;
     580         896 :                 firsttime = false;
     581             :             }
     582             :         }
     583             :     }
     584             : 
     585          68 :     left = v->spl_left;
     586          68 :     v->spl_nleft = 0;
     587          68 :     right = v->spl_right;
     588          68 :     v->spl_nright = 0;
     589             : 
     590          68 :     datum_alpha = DatumGetNDBOXP(entryvec->vector[seed_1].key);
     591          68 :     datum_l = cube_union_v0(datum_alpha, datum_alpha);
     592          68 :     rt_cube_size(datum_l, &size_l);
     593          68 :     datum_beta = DatumGetNDBOXP(entryvec->vector[seed_2].key);
     594          68 :     datum_r = cube_union_v0(datum_beta, datum_beta);
     595          68 :     rt_cube_size(datum_r, &size_r);
     596             : 
     597             :     /*
     598             :      * Now split up the regions between the two seeds.  An important property
     599             :      * of this split algorithm is that the split vector v has the indices of
     600             :      * items to be split in order in its left and right vectors.  We exploit
     601             :      * this property by doing a merge in the code that actually splits the
     602             :      * page.
     603             :      *
     604             :      * For efficiency, we also place the new index tuple in this loop. This is
     605             :      * handled at the very end, when we have placed all the existing tuples
     606             :      * and i == maxoff + 1.
     607             :      */
     608             : 
     609          68 :     maxoff = OffsetNumberNext(maxoff);
     610        9656 :     for (i = FirstOffsetNumber; i <= maxoff; i = OffsetNumberNext(i))
     611             :     {
     612             :         /*
     613             :          * If we've already decided where to place this item, just put it on
     614             :          * the right list.  Otherwise, we need to figure out which page needs
     615             :          * the least enlargement in order to store the item.
     616             :          */
     617             : 
     618        9588 :         if (i == seed_1)
     619             :         {
     620          68 :             *left++ = i;
     621          68 :             v->spl_nleft++;
     622          68 :             continue;
     623             :         }
     624        9520 :         else if (i == seed_2)
     625             :         {
     626          68 :             *right++ = i;
     627          68 :             v->spl_nright++;
     628          68 :             continue;
     629             :         }
     630             : 
     631             :         /* okay, which page needs least enlargement? */
     632        9452 :         datum_alpha = DatumGetNDBOXP(entryvec->vector[i].key);
     633        9452 :         union_dl = cube_union_v0(datum_l, datum_alpha);
     634        9452 :         union_dr = cube_union_v0(datum_r, datum_alpha);
     635        9452 :         rt_cube_size(union_dl, &size_alpha);
     636        9452 :         rt_cube_size(union_dr, &size_beta);
     637             : 
     638             :         /* pick which page to add it to */
     639        9452 :         if (size_alpha - size_l < size_beta - size_r)
     640             :         {
     641        4604 :             datum_l = union_dl;
     642        4604 :             size_l = size_alpha;
     643        4604 :             *left++ = i;
     644        4604 :             v->spl_nleft++;
     645             :         }
     646             :         else
     647             :         {
     648        4848 :             datum_r = union_dr;
     649        4848 :             size_r = size_beta;
     650        4848 :             *right++ = i;
     651        4848 :             v->spl_nright++;
     652             :         }
     653             :     }
     654          68 :     *left = *right = FirstOffsetNumber; /* sentinel value */
     655             : 
     656          68 :     v->spl_ldatum = PointerGetDatum(datum_l);
     657          68 :     v->spl_rdatum = PointerGetDatum(datum_r);
     658             : 
     659          68 :     PG_RETURN_POINTER(v);
     660             : }
     661             : 
     662             : /*
     663             : ** Equality method
     664             : */
     665             : Datum
     666        5924 : g_cube_same(PG_FUNCTION_ARGS)
     667             : {
     668        5924 :     NDBOX      *b1 = PG_GETARG_NDBOX_P(0);
     669        5924 :     NDBOX      *b2 = PG_GETARG_NDBOX_P(1);
     670        5924 :     bool       *result = (bool *) PG_GETARG_POINTER(2);
     671             : 
     672        5924 :     if (cube_cmp_v0(b1, b2) == 0)
     673        5620 :         *result = true;
     674             :     else
     675         304 :         *result = false;
     676             : 
     677        5924 :     PG_RETURN_NDBOX_P(result);
     678             : }
     679             : 
     680             : /*
     681             : ** SUPPORT ROUTINES
     682             : */
     683             : bool
     684         288 : g_cube_leaf_consistent(NDBOX *key,
     685             :                        NDBOX *query,
     686             :                        StrategyNumber strategy)
     687             : {
     688             :     bool        retval;
     689             : 
     690         288 :     switch (strategy)
     691             :     {
     692         192 :         case RTOverlapStrategyNumber:
     693         192 :             retval = cube_overlap_v0(key, query);
     694         192 :             break;
     695           0 :         case RTSameStrategyNumber:
     696           0 :             retval = (cube_cmp_v0(key, query) == 0);
     697           0 :             break;
     698           0 :         case RTContainsStrategyNumber:
     699             :         case RTOldContainsStrategyNumber:
     700           0 :             retval = cube_contains_v0(key, query);
     701           0 :             break;
     702          96 :         case RTContainedByStrategyNumber:
     703             :         case RTOldContainedByStrategyNumber:
     704          96 :             retval = cube_contains_v0(query, key);
     705          96 :             break;
     706           0 :         default:
     707           0 :             retval = false;
     708             :     }
     709         288 :     return retval;
     710             : }
     711             : 
     712             : bool
     713         210 : g_cube_internal_consistent(NDBOX *key,
     714             :                            NDBOX *query,
     715             :                            StrategyNumber strategy)
     716             : {
     717             :     bool        retval;
     718             : 
     719         210 :     switch (strategy)
     720             :     {
     721         140 :         case RTOverlapStrategyNumber:
     722         140 :             retval = cube_overlap_v0(key, query);
     723         140 :             break;
     724           0 :         case RTSameStrategyNumber:
     725             :         case RTContainsStrategyNumber:
     726             :         case RTOldContainsStrategyNumber:
     727           0 :             retval = cube_contains_v0(key, query);
     728           0 :             break;
     729          70 :         case RTContainedByStrategyNumber:
     730             :         case RTOldContainedByStrategyNumber:
     731          70 :             retval = cube_overlap_v0(key, query);
     732          70 :             break;
     733           0 :         default:
     734           0 :             retval = false;
     735             :     }
     736         210 :     return retval;
     737             : }
     738             : 
     739             : NDBOX *
     740        5924 : g_cube_binary_union(NDBOX *r1, NDBOX *r2, int *sizep)
     741             : {
     742             :     NDBOX      *retval;
     743             : 
     744        5924 :     retval = cube_union_v0(r1, r2);
     745        5924 :     *sizep = VARSIZE(retval);
     746             : 
     747        5924 :     return retval;
     748             : }
     749             : 
     750             : 
     751             : /* cube_union_v0 */
     752             : NDBOX *
     753      772976 : cube_union_v0(NDBOX *a, NDBOX *b)
     754             : {
     755             :     int         i;
     756             :     NDBOX      *result;
     757             :     int         dim;
     758             :     int         size;
     759             : 
     760             :     /* trivial case */
     761      772976 :     if (a == b)
     762         136 :         return a;
     763             : 
     764             :     /* swap the arguments if needed, so that 'a' is always larger than 'b' */
     765      772840 :     if (DIM(a) < DIM(b))
     766             :     {
     767           6 :         NDBOX      *tmp = b;
     768             : 
     769           6 :         b = a;
     770           6 :         a = tmp;
     771             :     }
     772      772840 :     dim = DIM(a);
     773             : 
     774      772840 :     size = CUBE_SIZE(dim);
     775      772840 :     result = palloc0(size);
     776      772840 :     SET_VARSIZE(result, size);
     777      772840 :     SET_DIM(result, dim);
     778             : 
     779             :     /* First compute the union of the dimensions present in both args */
     780     2318448 :     for (i = 0; i < DIM(b); i++)
     781             :     {
     782     1545608 :         result->x[i] = Min(Min(LL_COORD(a, i), UR_COORD(a, i)),
     783             :                            Min(LL_COORD(b, i), UR_COORD(b, i)));
     784     1545608 :         result->x[i + DIM(a)] = Max(Max(LL_COORD(a, i), UR_COORD(a, i)),
     785             :                                     Max(LL_COORD(b, i), UR_COORD(b, i)));
     786             :     }
     787             :     /* continue on the higher dimensions only present in 'a' */
     788      772920 :     for (; i < DIM(a); i++)
     789             :     {
     790          80 :         result->x[i] = Min(0,
     791             :                            Min(LL_COORD(a, i), UR_COORD(a, i))
     792             :             );
     793          80 :         result->x[i + dim] = Max(0,
     794             :                                  Max(LL_COORD(a, i), UR_COORD(a, i))
     795             :             );
     796             :     }
     797             : 
     798             :     /*
     799             :      * Check if the result was in fact a point, and set the flag in the datum
     800             :      * accordingly. (we don't bother to repalloc it smaller)
     801             :      */
     802      772840 :     if (cube_is_point_internal(result))
     803             :     {
     804           4 :         size = POINT_SIZE(dim);
     805           4 :         SET_VARSIZE(result, size);
     806           4 :         SET_POINT_BIT(result);
     807             :     }
     808             : 
     809      772840 :     return result;
     810             : }
     811             : 
     812             : Datum
     813          10 : cube_union(PG_FUNCTION_ARGS)
     814             : {
     815          10 :     NDBOX      *a = PG_GETARG_NDBOX_P(0);
     816          10 :     NDBOX      *b = PG_GETARG_NDBOX_P(1);
     817             :     NDBOX      *res;
     818             : 
     819          10 :     res = cube_union_v0(a, b);
     820             : 
     821          10 :     PG_FREE_IF_COPY(a, 0);
     822          10 :     PG_FREE_IF_COPY(b, 1);
     823          10 :     PG_RETURN_NDBOX_P(res);
     824             : }
     825             : 
     826             : /* cube_inter */
     827             : Datum
     828      661654 : cube_inter(PG_FUNCTION_ARGS)
     829             : {
     830      661654 :     NDBOX      *a = PG_GETARG_NDBOX_P(0);
     831      661654 :     NDBOX      *b = PG_GETARG_NDBOX_P(1);
     832             :     NDBOX      *result;
     833      661654 :     bool        swapped = false;
     834             :     int         i;
     835             :     int         dim;
     836             :     int         size;
     837             : 
     838             :     /* swap the arguments if needed, so that 'a' is always larger than 'b' */
     839      661654 :     if (DIM(a) < DIM(b))
     840             :     {
     841           0 :         NDBOX      *tmp = b;
     842             : 
     843           0 :         b = a;
     844           0 :         a = tmp;
     845           0 :         swapped = true;
     846             :     }
     847      661654 :     dim = DIM(a);
     848             : 
     849      661654 :     size = CUBE_SIZE(dim);
     850      661654 :     result = (NDBOX *) palloc0(size);
     851      661654 :     SET_VARSIZE(result, size);
     852      661654 :     SET_DIM(result, dim);
     853             : 
     854             :     /* First compute intersection of the dimensions present in both args */
     855     1984966 :     for (i = 0; i < DIM(b); i++)
     856             :     {
     857     1323312 :         result->x[i] = Max(Min(LL_COORD(a, i), UR_COORD(a, i)),
     858             :                            Min(LL_COORD(b, i), UR_COORD(b, i)));
     859     1323312 :         result->x[i + DIM(a)] = Min(Max(LL_COORD(a, i), UR_COORD(a, i)),
     860             :                                     Max(LL_COORD(b, i), UR_COORD(b, i)));
     861             :     }
     862             :     /* continue on the higher dimensions only present in 'a' */
     863      661654 :     for (; i < DIM(a); i++)
     864             :     {
     865           0 :         result->x[i] = Max(0,
     866             :                            Min(LL_COORD(a, i), UR_COORD(a, i))
     867             :             );
     868           0 :         result->x[i + DIM(a)] = Min(0,
     869             :                                     Max(LL_COORD(a, i), UR_COORD(a, i))
     870             :             );
     871             :     }
     872             : 
     873             :     /*
     874             :      * Check if the result was in fact a point, and set the flag in the datum
     875             :      * accordingly. (we don't bother to repalloc it smaller)
     876             :      */
     877      661654 :     if (cube_is_point_internal(result))
     878             :     {
     879           4 :         size = POINT_SIZE(dim);
     880           4 :         result = repalloc(result, size);
     881           4 :         SET_VARSIZE(result, size);
     882           4 :         SET_POINT_BIT(result);
     883             :     }
     884             : 
     885      661654 :     if (swapped)
     886             :     {
     887           0 :         PG_FREE_IF_COPY(b, 0);
     888           0 :         PG_FREE_IF_COPY(a, 1);
     889             :     }
     890             :     else
     891             :     {
     892      661654 :         PG_FREE_IF_COPY(a, 0);
     893      661654 :         PG_FREE_IF_COPY(b, 1);
     894             :     }
     895             : 
     896             :     /*
     897             :      * Is it OK to return a non-null intersection for non-overlapping boxes?
     898             :      */
     899      661654 :     PG_RETURN_NDBOX_P(result);
     900             : }
     901             : 
     902             : /* cube_size */
     903             : Datum
     904           4 : cube_size(PG_FUNCTION_ARGS)
     905             : {
     906           4 :     NDBOX      *a = PG_GETARG_NDBOX_P(0);
     907             :     double      result;
     908             : 
     909           4 :     rt_cube_size(a, &result);
     910           4 :     PG_FREE_IF_COPY(a, 0);
     911           4 :     PG_RETURN_FLOAT8(result);
     912             : }
     913             : 
     914             : void
     915     1515048 : rt_cube_size(NDBOX *a, double *size)
     916             : {
     917             :     double      result;
     918             :     int         i;
     919             : 
     920     1515048 :     if (a == (NDBOX *) NULL)
     921             :     {
     922             :         /* special case for GiST */
     923           0 :         result = 0.0;
     924             :     }
     925     1515048 :     else if (IS_POINT(a) || DIM(a) == 0)
     926             :     {
     927             :         /* necessarily has zero size */
     928           2 :         result = 0.0;
     929             :     }
     930             :     else
     931             :     {
     932     1515046 :         result = 1.0;
     933     4545138 :         for (i = 0; i < DIM(a); i++)
     934     3030092 :             result *= fabs(UR_COORD(a, i) - LL_COORD(a, i));
     935             :     }
     936     1515048 :     *size = result;
     937     1515048 : }
     938             : 
     939             : /* make up a metric in which one box will be 'lower' than the other
     940             :    -- this can be useful for sorting and to determine uniqueness */
     941             : int32
     942        6020 : cube_cmp_v0(NDBOX *a, NDBOX *b)
     943             : {
     944             :     int         i;
     945             :     int         dim;
     946             : 
     947        6020 :     dim = Min(DIM(a), DIM(b));
     948             : 
     949             :     /* compare the common dimensions */
     950       17722 :     for (i = 0; i < dim; i++)
     951             :     {
     952       23828 :         if (Min(LL_COORD(a, i), UR_COORD(a, i)) >
     953       11914 :             Min(LL_COORD(b, i), UR_COORD(b, i)))
     954         182 :             return 1;
     955       23464 :         if (Min(LL_COORD(a, i), UR_COORD(a, i)) <
     956       11732 :             Min(LL_COORD(b, i), UR_COORD(b, i)))
     957          30 :             return -1;
     958             :     }
     959       17192 :     for (i = 0; i < dim; i++)
     960             :     {
     961       23080 :         if (Max(LL_COORD(a, i), UR_COORD(a, i)) >
     962       11540 :             Max(LL_COORD(b, i), UR_COORD(b, i)))
     963           0 :             return 1;
     964       23080 :         if (Max(LL_COORD(a, i), UR_COORD(a, i)) <
     965       11540 :             Max(LL_COORD(b, i), UR_COORD(b, i)))
     966         156 :             return -1;
     967             :     }
     968             : 
     969             :     /* compare extra dimensions to zero */
     970        5652 :     if (DIM(a) > DIM(b))
     971             :     {
     972          48 :         for (i = dim; i < DIM(a); i++)
     973             :         {
     974          36 :             if (Min(LL_COORD(a, i), UR_COORD(a, i)) > 0)
     975           0 :                 return 1;
     976          36 :             if (Min(LL_COORD(a, i), UR_COORD(a, i)) < 0)
     977           0 :                 return -1;
     978             :         }
     979          40 :         for (i = dim; i < DIM(a); i++)
     980             :         {
     981          36 :             if (Max(LL_COORD(a, i), UR_COORD(a, i)) > 0)
     982           8 :                 return 1;
     983          28 :             if (Max(LL_COORD(a, i), UR_COORD(a, i)) < 0)
     984           0 :                 return -1;
     985             :         }
     986             : 
     987             :         /*
     988             :          * if all common dimensions are equal, the cube with more dimensions
     989             :          * wins
     990             :          */
     991           4 :         return 1;
     992             :     }
     993        5640 :     if (DIM(a) < DIM(b))
     994             :     {
     995          64 :         for (i = dim; i < DIM(b); i++)
     996             :         {
     997          48 :             if (Min(LL_COORD(b, i), UR_COORD(b, i)) > 0)
     998           0 :                 return -1;
     999          48 :             if (Min(LL_COORD(b, i), UR_COORD(b, i)) < 0)
    1000           0 :                 return 1;
    1001             :         }
    1002          54 :         for (i = dim; i < DIM(b); i++)
    1003             :         {
    1004          48 :             if (Max(LL_COORD(b, i), UR_COORD(b, i)) > 0)
    1005          10 :                 return -1;
    1006          38 :             if (Max(LL_COORD(b, i), UR_COORD(b, i)) < 0)
    1007           0 :                 return 1;
    1008             :         }
    1009             : 
    1010             :         /*
    1011             :          * if all common dimensions are equal, the cube with more dimensions
    1012             :          * wins
    1013             :          */
    1014           6 :         return -1;
    1015             :     }
    1016             : 
    1017             :     /* They're really equal */
    1018        5624 :     return 0;
    1019             : }
    1020             : 
    1021             : Datum
    1022          44 : cube_cmp(PG_FUNCTION_ARGS)
    1023             : {
    1024          44 :     NDBOX      *a = PG_GETARG_NDBOX_P(0),
    1025          44 :                *b = PG_GETARG_NDBOX_P(1);
    1026             :     int32       res;
    1027             : 
    1028          44 :     res = cube_cmp_v0(a, b);
    1029             : 
    1030          44 :     PG_FREE_IF_COPY(a, 0);
    1031          44 :     PG_FREE_IF_COPY(b, 1);
    1032          44 :     PG_RETURN_INT32(res);
    1033             : }
    1034             : 
    1035             : 
    1036             : Datum
    1037          16 : cube_eq(PG_FUNCTION_ARGS)
    1038             : {
    1039          16 :     NDBOX      *a = PG_GETARG_NDBOX_P(0),
    1040          16 :                *b = PG_GETARG_NDBOX_P(1);
    1041             :     int32       res;
    1042             : 
    1043          16 :     res = cube_cmp_v0(a, b);
    1044             : 
    1045          16 :     PG_FREE_IF_COPY(a, 0);
    1046          16 :     PG_FREE_IF_COPY(b, 1);
    1047          16 :     PG_RETURN_BOOL(res == 0);
    1048             : }
    1049             : 
    1050             : 
    1051             : Datum
    1052           4 : cube_ne(PG_FUNCTION_ARGS)
    1053             : {
    1054           4 :     NDBOX      *a = PG_GETARG_NDBOX_P(0),
    1055           4 :                *b = PG_GETARG_NDBOX_P(1);
    1056             :     int32       res;
    1057             : 
    1058           4 :     res = cube_cmp_v0(a, b);
    1059             : 
    1060           4 :     PG_FREE_IF_COPY(a, 0);
    1061           4 :     PG_FREE_IF_COPY(b, 1);
    1062           4 :     PG_RETURN_BOOL(res != 0);
    1063             : }
    1064             : 
    1065             : 
    1066             : Datum
    1067          16 : cube_lt(PG_FUNCTION_ARGS)
    1068             : {
    1069          16 :     NDBOX      *a = PG_GETARG_NDBOX_P(0),
    1070          16 :                *b = PG_GETARG_NDBOX_P(1);
    1071             :     int32       res;
    1072             : 
    1073          16 :     res = cube_cmp_v0(a, b);
    1074             : 
    1075          16 :     PG_FREE_IF_COPY(a, 0);
    1076          16 :     PG_FREE_IF_COPY(b, 1);
    1077          16 :     PG_RETURN_BOOL(res < 0);
    1078             : }
    1079             : 
    1080             : 
    1081             : Datum
    1082          16 : cube_gt(PG_FUNCTION_ARGS)
    1083             : {
    1084          16 :     NDBOX      *a = PG_GETARG_NDBOX_P(0),
    1085          16 :                *b = PG_GETARG_NDBOX_P(1);
    1086             :     int32       res;
    1087             : 
    1088          16 :     res = cube_cmp_v0(a, b);
    1089             : 
    1090          16 :     PG_FREE_IF_COPY(a, 0);
    1091          16 :     PG_FREE_IF_COPY(b, 1);
    1092          16 :     PG_RETURN_BOOL(res > 0);
    1093             : }
    1094             : 
    1095             : 
    1096             : Datum
    1097           0 : cube_le(PG_FUNCTION_ARGS)
    1098             : {
    1099           0 :     NDBOX      *a = PG_GETARG_NDBOX_P(0),
    1100           0 :                *b = PG_GETARG_NDBOX_P(1);
    1101             :     int32       res;
    1102             : 
    1103           0 :     res = cube_cmp_v0(a, b);
    1104             : 
    1105           0 :     PG_FREE_IF_COPY(a, 0);
    1106           0 :     PG_FREE_IF_COPY(b, 1);
    1107           0 :     PG_RETURN_BOOL(res <= 0);
    1108             : }
    1109             : 
    1110             : 
    1111             : Datum
    1112           0 : cube_ge(PG_FUNCTION_ARGS)
    1113             : {
    1114           0 :     NDBOX      *a = PG_GETARG_NDBOX_P(0),
    1115           0 :                *b = PG_GETARG_NDBOX_P(1);
    1116             :     int32       res;
    1117             : 
    1118           0 :     res = cube_cmp_v0(a, b);
    1119             : 
    1120           0 :     PG_FREE_IF_COPY(a, 0);
    1121           0 :     PG_FREE_IF_COPY(b, 1);
    1122           0 :     PG_RETURN_BOOL(res >= 0);
    1123             : }
    1124             : 
    1125             : 
    1126             : /* Contains */
    1127             : /* Box(A) CONTAINS Box(B) IFF pt(A) < pt(B) */
    1128             : bool
    1129         188 : cube_contains_v0(NDBOX *a, NDBOX *b)
    1130             : {
    1131             :     int         i;
    1132             : 
    1133         188 :     if ((a == NULL) || (b == NULL))
    1134           0 :         return false;
    1135             : 
    1136         188 :     if (DIM(a) < DIM(b))
    1137             :     {
    1138             :         /*
    1139             :          * the further comparisons will make sense if the excess dimensions of
    1140             :          * (b) were zeroes Since both UL and UR coordinates must be zero, we
    1141             :          * can check them all without worrying about which is which.
    1142             :          */
    1143           0 :         for (i = DIM(a); i < DIM(b); i++)
    1144             :         {
    1145           0 :             if (LL_COORD(b, i) != 0)
    1146           0 :                 return false;
    1147           0 :             if (UR_COORD(b, i) != 0)
    1148           0 :                 return false;
    1149             :         }
    1150             :     }
    1151             : 
    1152             :     /* Can't care less about the excess dimensions of (a), if any */
    1153         380 :     for (i = 0; i < Min(DIM(a), DIM(b)); i++)
    1154             :     {
    1155         624 :         if (Min(LL_COORD(a, i), UR_COORD(a, i)) >
    1156         312 :             Min(LL_COORD(b, i), UR_COORD(b, i)))
    1157          14 :             return false;
    1158         596 :         if (Max(LL_COORD(a, i), UR_COORD(a, i)) <
    1159         298 :             Max(LL_COORD(b, i), UR_COORD(b, i)))
    1160         106 :             return false;
    1161             :     }
    1162             : 
    1163          68 :     return true;
    1164             : }
    1165             : 
    1166             : Datum
    1167          62 : cube_contains(PG_FUNCTION_ARGS)
    1168             : {
    1169          62 :     NDBOX      *a = PG_GETARG_NDBOX_P(0),
    1170          62 :                *b = PG_GETARG_NDBOX_P(1);
    1171             :     bool        res;
    1172             : 
    1173          62 :     res = cube_contains_v0(a, b);
    1174             : 
    1175          62 :     PG_FREE_IF_COPY(a, 0);
    1176          62 :     PG_FREE_IF_COPY(b, 1);
    1177          62 :     PG_RETURN_BOOL(res);
    1178             : }
    1179             : 
    1180             : /* Contained */
    1181             : /* Box(A) Contained by Box(B) IFF Box(B) Contains Box(A) */
    1182             : Datum
    1183          30 : cube_contained(PG_FUNCTION_ARGS)
    1184             : {
    1185          30 :     NDBOX      *a = PG_GETARG_NDBOX_P(0),
    1186          30 :                *b = PG_GETARG_NDBOX_P(1);
    1187             :     bool        res;
    1188             : 
    1189          30 :     res = cube_contains_v0(b, a);
    1190             : 
    1191          30 :     PG_FREE_IF_COPY(a, 0);
    1192          30 :     PG_FREE_IF_COPY(b, 1);
    1193          30 :     PG_RETURN_BOOL(res);
    1194             : }
    1195             : 
    1196             : /* Overlap */
    1197             : /* Box(A) Overlap Box(B) IFF (pt(a)LL < pt(B)UR) && (pt(b)LL < pt(a)UR) */
    1198             : bool
    1199         418 : cube_overlap_v0(NDBOX *a, NDBOX *b)
    1200             : {
    1201             :     int         i;
    1202             : 
    1203         418 :     if ((a == NULL) || (b == NULL))
    1204           0 :         return false;
    1205             : 
    1206             :     /* swap the box pointers if needed */
    1207         418 :     if (DIM(a) < DIM(b))
    1208             :     {
    1209           0 :         NDBOX      *tmp = b;
    1210             : 
    1211           0 :         b = a;
    1212           0 :         a = tmp;
    1213             :     }
    1214             : 
    1215             :     /* compare within the dimensions of (b) */
    1216         574 :     for (i = 0; i < DIM(b); i++)
    1217             :     {
    1218         536 :         if (Min(LL_COORD(a, i), UR_COORD(a, i)) > Max(LL_COORD(b, i), UR_COORD(b, i)))
    1219         376 :             return false;
    1220         160 :         if (Max(LL_COORD(a, i), UR_COORD(a, i)) < Min(LL_COORD(b, i), UR_COORD(b, i)))
    1221           4 :             return false;
    1222             :     }
    1223             : 
    1224             :     /* compare to zero those dimensions in (a) absent in (b) */
    1225          48 :     for (i = DIM(b); i < DIM(a); i++)
    1226             :     {
    1227          10 :         if (Min(LL_COORD(a, i), UR_COORD(a, i)) > 0)
    1228           0 :             return false;
    1229          10 :         if (Max(LL_COORD(a, i), UR_COORD(a, i)) < 0)
    1230           0 :             return false;
    1231             :     }
    1232             : 
    1233          38 :     return true;
    1234             : }
    1235             : 
    1236             : 
    1237             : Datum
    1238          16 : cube_overlap(PG_FUNCTION_ARGS)
    1239             : {
    1240          16 :     NDBOX      *a = PG_GETARG_NDBOX_P(0),
    1241          16 :                *b = PG_GETARG_NDBOX_P(1);
    1242             :     bool        res;
    1243             : 
    1244          16 :     res = cube_overlap_v0(a, b);
    1245             : 
    1246          16 :     PG_FREE_IF_COPY(a, 0);
    1247          16 :     PG_FREE_IF_COPY(b, 1);
    1248          16 :     PG_RETURN_BOOL(res);
    1249             : }
    1250             : 
    1251             : 
    1252             : /* Distance */
    1253             : /* The distance is computed as a per axis sum of the squared distances
    1254             :    between 1D projections of the boxes onto Cartesian axes. Assuming zero
    1255             :    distance between overlapping projections, this metric coincides with the
    1256             :    "common sense" geometric distance */
    1257             : Datum
    1258        6846 : cube_distance(PG_FUNCTION_ARGS)
    1259             : {
    1260        6846 :     NDBOX      *a = PG_GETARG_NDBOX_P(0),
    1261        6846 :                *b = PG_GETARG_NDBOX_P(1);
    1262        6846 :     bool        swapped = false;
    1263             :     double      d,
    1264             :                 distance;
    1265             :     int         i;
    1266             : 
    1267             :     /* swap the box pointers if needed */
    1268        6846 :     if (DIM(a) < DIM(b))
    1269             :     {
    1270           6 :         NDBOX      *tmp = b;
    1271             : 
    1272           6 :         b = a;
    1273           6 :         a = tmp;
    1274           6 :         swapped = true;
    1275             :     }
    1276             : 
    1277        6846 :     distance = 0.0;
    1278             :     /* compute within the dimensions of (b) */
    1279       20204 :     for (i = 0; i < DIM(b); i++)
    1280             :     {
    1281       13358 :         d = distance_1D(LL_COORD(a, i), UR_COORD(a, i), LL_COORD(b, i), UR_COORD(b, i));
    1282       13358 :         distance += d * d;
    1283             :     }
    1284             : 
    1285             :     /* compute distance to zero for those dimensions in (a) absent in (b) */
    1286        7638 :     for (i = DIM(b); i < DIM(a); i++)
    1287             :     {
    1288         792 :         d = distance_1D(LL_COORD(a, i), UR_COORD(a, i), 0.0, 0.0);
    1289         792 :         distance += d * d;
    1290             :     }
    1291             : 
    1292        6846 :     if (swapped)
    1293             :     {
    1294           6 :         PG_FREE_IF_COPY(b, 0);
    1295           6 :         PG_FREE_IF_COPY(a, 1);
    1296             :     }
    1297             :     else
    1298             :     {
    1299        6840 :         PG_FREE_IF_COPY(a, 0);
    1300        6840 :         PG_FREE_IF_COPY(b, 1);
    1301             :     }
    1302             : 
    1303        6846 :     PG_RETURN_FLOAT8(sqrt(distance));
    1304             : }
    1305             : 
    1306             : Datum
    1307        6390 : distance_taxicab(PG_FUNCTION_ARGS)
    1308             : {
    1309        6390 :     NDBOX      *a = PG_GETARG_NDBOX_P(0),
    1310        6390 :                *b = PG_GETARG_NDBOX_P(1);
    1311        6390 :     bool        swapped = false;
    1312             :     double      distance;
    1313             :     int         i;
    1314             : 
    1315             :     /* swap the box pointers if needed */
    1316        6390 :     if (DIM(a) < DIM(b))
    1317             :     {
    1318           2 :         NDBOX      *tmp = b;
    1319             : 
    1320           2 :         b = a;
    1321           2 :         a = tmp;
    1322           2 :         swapped = true;
    1323             :     }
    1324             : 
    1325        6390 :     distance = 0.0;
    1326             :     /* compute within the dimensions of (b) */
    1327       19168 :     for (i = 0; i < DIM(b); i++)
    1328       12778 :         distance += fabs(distance_1D(LL_COORD(a, i), UR_COORD(a, i),
    1329       12778 :                                      LL_COORD(b, i), UR_COORD(b, i)));
    1330             : 
    1331             :     /* compute distance to zero for those dimensions in (a) absent in (b) */
    1332        6392 :     for (i = DIM(b); i < DIM(a); i++)
    1333           2 :         distance += fabs(distance_1D(LL_COORD(a, i), UR_COORD(a, i),
    1334             :                                      0.0, 0.0));
    1335             : 
    1336        6390 :     if (swapped)
    1337             :     {
    1338           2 :         PG_FREE_IF_COPY(b, 0);
    1339           2 :         PG_FREE_IF_COPY(a, 1);
    1340             :     }
    1341             :     else
    1342             :     {
    1343        6388 :         PG_FREE_IF_COPY(a, 0);
    1344        6388 :         PG_FREE_IF_COPY(b, 1);
    1345             :     }
    1346             : 
    1347        6390 :     PG_RETURN_FLOAT8(distance);
    1348             : }
    1349             : 
    1350             : Datum
    1351        6390 : distance_chebyshev(PG_FUNCTION_ARGS)
    1352             : {
    1353        6390 :     NDBOX      *a = PG_GETARG_NDBOX_P(0),
    1354        6390 :                *b = PG_GETARG_NDBOX_P(1);
    1355        6390 :     bool        swapped = false;
    1356             :     double      d,
    1357             :                 distance;
    1358             :     int         i;
    1359             : 
    1360             :     /* swap the box pointers if needed */
    1361        6390 :     if (DIM(a) < DIM(b))
    1362             :     {
    1363           2 :         NDBOX      *tmp = b;
    1364             : 
    1365           2 :         b = a;
    1366           2 :         a = tmp;
    1367           2 :         swapped = true;
    1368             :     }
    1369             : 
    1370        6390 :     distance = 0.0;
    1371             :     /* compute within the dimensions of (b) */
    1372       19168 :     for (i = 0; i < DIM(b); i++)
    1373             :     {
    1374       12778 :         d = fabs(distance_1D(LL_COORD(a, i), UR_COORD(a, i),
    1375       12778 :                              LL_COORD(b, i), UR_COORD(b, i)));
    1376       12778 :         if (d > distance)
    1377        9440 :             distance = d;
    1378             :     }
    1379             : 
    1380             :     /* compute distance to zero for those dimensions in (a) absent in (b) */
    1381        6392 :     for (i = DIM(b); i < DIM(a); i++)
    1382             :     {
    1383           2 :         d = fabs(distance_1D(LL_COORD(a, i), UR_COORD(a, i), 0.0, 0.0));
    1384           2 :         if (d > distance)
    1385           0 :             distance = d;
    1386             :     }
    1387             : 
    1388        6390 :     if (swapped)
    1389             :     {
    1390           2 :         PG_FREE_IF_COPY(b, 0);
    1391           2 :         PG_FREE_IF_COPY(a, 1);
    1392             :     }
    1393             :     else
    1394             :     {
    1395        6388 :         PG_FREE_IF_COPY(a, 0);
    1396        6388 :         PG_FREE_IF_COPY(b, 1);
    1397             :     }
    1398             : 
    1399        6390 :     PG_RETURN_FLOAT8(distance);
    1400             : }
    1401             : 
    1402             : Datum
    1403        8234 : g_cube_distance(PG_FUNCTION_ARGS)
    1404             : {
    1405        8234 :     GISTENTRY  *entry = (GISTENTRY *) PG_GETARG_POINTER(0);
    1406        8234 :     StrategyNumber strategy = (StrategyNumber) PG_GETARG_UINT16(2);
    1407        8234 :     NDBOX      *cube = DatumGetNDBOXP(entry->key);
    1408             :     double      retval;
    1409             : 
    1410        8234 :     if (strategy == CubeKNNDistanceCoord)
    1411             :     {
    1412             :         /*
    1413             :          * Handle ordering by ~> operator.  See comments of cube_coord_llur()
    1414             :          * for details
    1415             :          */
    1416        7730 :         int         coord = PG_GETARG_INT32(1);
    1417        7730 :         bool        isLeaf = GistPageIsLeaf(entry->page);
    1418        7730 :         bool        inverse = false;
    1419             : 
    1420             :         /* 0 is the only unsupported coordinate value */
    1421        7730 :         if (coord == 0)
    1422           0 :             ereport(ERROR,
    1423             :                     (errcode(ERRCODE_ARRAY_ELEMENT_ERROR),
    1424             :                      errmsg("zero cube index is not defined")));
    1425             : 
    1426             :         /* Return inversed value for negative coordinate */
    1427        7730 :         if (coord < 0)
    1428             :         {
    1429        4746 :             coord = -coord;
    1430        4746 :             inverse = true;
    1431             :         }
    1432             : 
    1433        7730 :         if (coord <= 2 * DIM(cube))
    1434             :         {
    1435             :             /* dimension index */
    1436        7726 :             int         index = (coord - 1) / 2;
    1437             : 
    1438             :             /* whether this is upper bound (lower bound otherwise) */
    1439        7726 :             bool        upper = ((coord - 1) % 2 == 1);
    1440             : 
    1441        7726 :             if (IS_POINT(cube))
    1442             :             {
    1443          20 :                 retval = cube->x[index];
    1444             :             }
    1445             :             else
    1446             :             {
    1447        7706 :                 if (isLeaf)
    1448             :                 {
    1449             :                     /* For leaf just return required upper/lower bound */
    1450        7146 :                     if (upper)
    1451        3440 :                         retval = Max(cube->x[index], cube->x[index + DIM(cube)]);
    1452             :                     else
    1453        3706 :                         retval = Min(cube->x[index], cube->x[index + DIM(cube)]);
    1454             :                 }
    1455             :                 else
    1456             :                 {
    1457             :                     /*
    1458             :                      * For non-leaf we should always return lower bound,
    1459             :                      * because even upper bound of a child in the subtree can
    1460             :                      * be as small as our lower bound.  For inversed case we
    1461             :                      * return upper bound because it becomes lower bound for
    1462             :                      * inversed value.
    1463             :                      */
    1464         560 :                     if (!inverse)
    1465         280 :                         retval = Min(cube->x[index], cube->x[index + DIM(cube)]);
    1466             :                     else
    1467         280 :                         retval = Max(cube->x[index], cube->x[index + DIM(cube)]);
    1468             :                 }
    1469             :             }
    1470             :         }
    1471             :         else
    1472             :         {
    1473           4 :             retval = 0.0;
    1474             :         }
    1475             : 
    1476             :         /* Inverse return value if needed */
    1477        7730 :         if (inverse)
    1478        4746 :             retval = -retval;
    1479             :     }
    1480             :     else
    1481             :     {
    1482         504 :         NDBOX      *query = PG_GETARG_NDBOX_P(1);
    1483             : 
    1484         504 :         switch (strategy)
    1485             :         {
    1486         168 :             case CubeKNNDistanceTaxicab:
    1487         168 :                 retval = DatumGetFloat8(DirectFunctionCall2(distance_taxicab,
    1488             :                                                             PointerGetDatum(cube), PointerGetDatum(query)));
    1489         168 :                 break;
    1490         168 :             case CubeKNNDistanceEuclid:
    1491         168 :                 retval = DatumGetFloat8(DirectFunctionCall2(cube_distance,
    1492             :                                                             PointerGetDatum(cube), PointerGetDatum(query)));
    1493         168 :                 break;
    1494         168 :             case CubeKNNDistanceChebyshev:
    1495         168 :                 retval = DatumGetFloat8(DirectFunctionCall2(distance_chebyshev,
    1496             :                                                             PointerGetDatum(cube), PointerGetDatum(query)));
    1497         168 :                 break;
    1498           0 :             default:
    1499           0 :                 elog(ERROR, "unrecognized cube strategy number: %d", strategy);
    1500             :                 retval = 0;     /* keep compiler quiet */
    1501             :                 break;
    1502             :         }
    1503             :     }
    1504        8234 :     PG_RETURN_FLOAT8(retval);
    1505             : }
    1506             : 
    1507             : static double
    1508       39710 : distance_1D(double a1, double a2, double b1, double b2)
    1509             : {
    1510             :     /* interval (a) is entirely on the left of (b) */
    1511       39710 :     if ((a1 <= b1) && (a2 <= b1) && (a1 <= b2) && (a2 <= b2))
    1512         752 :         return (Min(b1, b2) - Max(a1, a2));
    1513             : 
    1514             :     /* interval (a) is entirely on the right of (b) */
    1515       38958 :     if ((a1 > b1) && (a2 > b1) && (a1 > b2) && (a2 > b2))
    1516       38488 :         return (Min(a1, a2) - Max(b1, b2));
    1517             : 
    1518             :     /* the rest are all sorts of intersections */
    1519         470 :     return 0.0;
    1520             : }
    1521             : 
    1522             : /* Test if a box is also a point */
    1523             : Datum
    1524         402 : cube_is_point(PG_FUNCTION_ARGS)
    1525             : {
    1526         402 :     NDBOX      *cube = PG_GETARG_NDBOX_P(0);
    1527             :     bool        result;
    1528             : 
    1529         402 :     result = cube_is_point_internal(cube);
    1530         402 :     PG_FREE_IF_COPY(cube, 0);
    1531         402 :     PG_RETURN_BOOL(result);
    1532             : }
    1533             : 
    1534             : static bool
    1535     1435782 : cube_is_point_internal(NDBOX *cube)
    1536             : {
    1537             :     int         i;
    1538             : 
    1539     1435782 :     if (IS_POINT(cube))
    1540         594 :         return true;
    1541             : 
    1542             :     /*
    1543             :      * Even if the point-flag is not set, all the lower-left coordinates might
    1544             :      * match the upper-right coordinates, so that the value is in fact a
    1545             :      * point. Such values don't arise with current code - the point flag is
    1546             :      * always set if appropriate - but they might be present on-disk in
    1547             :      * clusters upgraded from pre-9.4 versions.
    1548             :      */
    1549     1435456 :     for (i = 0; i < DIM(cube); i++)
    1550             :     {
    1551     1435432 :         if (LL_COORD(cube, i) != UR_COORD(cube, i))
    1552     1435164 :             return false;
    1553             :     }
    1554          24 :     return true;
    1555             : }
    1556             : 
    1557             : /* Return dimensions in use in the data structure */
    1558             : Datum
    1559         400 : cube_dim(PG_FUNCTION_ARGS)
    1560             : {
    1561         400 :     NDBOX      *c = PG_GETARG_NDBOX_P(0);
    1562         400 :     int         dim = DIM(c);
    1563             : 
    1564         400 :     PG_FREE_IF_COPY(c, 0);
    1565         400 :     PG_RETURN_INT32(dim);
    1566             : }
    1567             : 
    1568             : /* Return a specific normalized LL coordinate */
    1569             : Datum
    1570         302 : cube_ll_coord(PG_FUNCTION_ARGS)
    1571             : {
    1572         302 :     NDBOX      *c = PG_GETARG_NDBOX_P(0);
    1573         302 :     int         n = PG_GETARG_INT32(1);
    1574             :     double      result;
    1575             : 
    1576         302 :     if (DIM(c) >= n && n > 0)
    1577         296 :         result = Min(LL_COORD(c, n - 1), UR_COORD(c, n - 1));
    1578             :     else
    1579           6 :         result = 0;
    1580             : 
    1581         302 :     PG_FREE_IF_COPY(c, 0);
    1582         302 :     PG_RETURN_FLOAT8(result);
    1583             : }
    1584             : 
    1585             : /* Return a specific normalized UR coordinate */
    1586             : Datum
    1587          36 : cube_ur_coord(PG_FUNCTION_ARGS)
    1588             : {
    1589          36 :     NDBOX      *c = PG_GETARG_NDBOX_P(0);
    1590          36 :     int         n = PG_GETARG_INT32(1);
    1591             :     double      result;
    1592             : 
    1593          36 :     if (DIM(c) >= n && n > 0)
    1594          30 :         result = Max(LL_COORD(c, n - 1), UR_COORD(c, n - 1));
    1595             :     else
    1596           6 :         result = 0;
    1597             : 
    1598          36 :     PG_FREE_IF_COPY(c, 0);
    1599          36 :     PG_RETURN_FLOAT8(result);
    1600             : }
    1601             : 
    1602             : /*
    1603             :  * Function returns cube coordinate.
    1604             :  * Numbers from 1 to DIM denotes first corner coordinates.
    1605             :  * Numbers from DIM+1 to 2*DIM denotes second corner coordinates.
    1606             :  */
    1607             : Datum
    1608          20 : cube_coord(PG_FUNCTION_ARGS)
    1609             : {
    1610          20 :     NDBOX      *cube = PG_GETARG_NDBOX_P(0);
    1611          20 :     int         coord = PG_GETARG_INT32(1);
    1612             : 
    1613          20 :     if (coord <= 0 || coord > 2 * DIM(cube))
    1614          10 :         ereport(ERROR,
    1615             :                 (errcode(ERRCODE_ARRAY_ELEMENT_ERROR),
    1616             :                  errmsg("cube index %d is out of bounds", coord)));
    1617             : 
    1618          10 :     if (IS_POINT(cube))
    1619           4 :         PG_RETURN_FLOAT8(cube->x[(coord - 1) % DIM(cube)]);
    1620             :     else
    1621           6 :         PG_RETURN_FLOAT8(cube->x[coord - 1]);
    1622             : }
    1623             : 
    1624             : 
    1625             : /*----
    1626             :  * This function works like cube_coord(), but rearranges coordinates in the
    1627             :  * way suitable to support coordinate ordering using KNN-GiST.  For historical
    1628             :  * reasons this extension allows us to create cubes in form ((2,1),(1,2)) and
    1629             :  * instead of normalizing such cube to ((1,1),(2,2)) it stores cube in original
    1630             :  * way.  But in order to get cubes ordered by one of dimensions from the index
    1631             :  * without explicit sort step we need this representation-independent coordinate
    1632             :  * getter.  Moreover, indexed dataset may contain cubes of different dimensions
    1633             :  * number.  Accordingly, this coordinate getter should be able to return
    1634             :  * lower/upper bound for particular dimension independently on number of cube
    1635             :  * dimensions.  Also, KNN-GiST supports only ascending sorting.  In order to
    1636             :  * support descending sorting, this function returns inverse of value when
    1637             :  * negative coordinate is given.
    1638             :  *
    1639             :  * Long story short, this function uses following meaning of coordinates:
    1640             :  * # (2 * N - 1) -- lower bound of Nth dimension,
    1641             :  * # (2 * N) -- upper bound of Nth dimension,
    1642             :  * # - (2 * N - 1) -- negative of lower bound of Nth dimension,
    1643             :  * # - (2 * N) -- negative of upper bound of Nth dimension.
    1644             :  *
    1645             :  * When given coordinate exceeds number of cube dimensions, then 0 returned
    1646             :  * (reproducing logic of GiST indexing of variable-length cubes).
    1647             :  */
    1648             : Datum
    1649       49906 : cube_coord_llur(PG_FUNCTION_ARGS)
    1650             : {
    1651       49906 :     NDBOX      *cube = PG_GETARG_NDBOX_P(0);
    1652       49906 :     int         coord = PG_GETARG_INT32(1);
    1653       49906 :     bool        inverse = false;
    1654             :     float8      result;
    1655             : 
    1656             :     /* 0 is the only unsupported coordinate value */
    1657       49906 :     if (coord == 0)
    1658           2 :         ereport(ERROR,
    1659             :                 (errcode(ERRCODE_ARRAY_ELEMENT_ERROR),
    1660             :                  errmsg("zero cube index is not defined")));
    1661             : 
    1662             :     /* Return inversed value for negative coordinate */
    1663       49904 :     if (coord < 0)
    1664             :     {
    1665       24946 :         coord = -coord;
    1666       24946 :         inverse = true;
    1667             :     }
    1668             : 
    1669       49904 :     if (coord <= 2 * DIM(cube))
    1670             :     {
    1671             :         /* dimension index */
    1672       49892 :         int         index = (coord - 1) / 2;
    1673             : 
    1674             :         /* whether this is upper bound (lower bound otherwise) */
    1675       49892 :         bool        upper = ((coord - 1) % 2 == 1);
    1676             : 
    1677       49892 :         if (IS_POINT(cube))
    1678             :         {
    1679          60 :             result = cube->x[index];
    1680             :         }
    1681             :         else
    1682             :         {
    1683       49832 :             if (upper)
    1684       24914 :                 result = Max(cube->x[index], cube->x[index + DIM(cube)]);
    1685             :             else
    1686       24918 :                 result = Min(cube->x[index], cube->x[index + DIM(cube)]);
    1687             :         }
    1688             :     }
    1689             :     else
    1690             :     {
    1691             :         /*
    1692             :          * Return zero if coordinate is out of bound.  That reproduces logic
    1693             :          * of how cubes with low dimension number are expanded during GiST
    1694             :          * indexing.
    1695             :          */
    1696          12 :         result = 0.0;
    1697             :     }
    1698             : 
    1699             :     /* Inverse value if needed */
    1700       49904 :     if (inverse)
    1701       24946 :         result = -result;
    1702             : 
    1703       49904 :     PG_RETURN_FLOAT8(result);
    1704             : }
    1705             : 
    1706             : /* Increase or decrease box size by a radius in at least n dimensions. */
    1707             : Datum
    1708         108 : cube_enlarge(PG_FUNCTION_ARGS)
    1709             : {
    1710         108 :     NDBOX      *a = PG_GETARG_NDBOX_P(0);
    1711         108 :     double      r = PG_GETARG_FLOAT8(1);
    1712         108 :     int32       n = PG_GETARG_INT32(2);
    1713             :     NDBOX      *result;
    1714         108 :     int         dim = 0;
    1715             :     int         size;
    1716             :     int         i,
    1717             :                 j;
    1718             : 
    1719         108 :     if (n > CUBE_MAX_DIM)
    1720           0 :         n = CUBE_MAX_DIM;
    1721         108 :     if (r > 0 && n > 0)
    1722          80 :         dim = n;
    1723         108 :     if (DIM(a) > dim)
    1724          30 :         dim = DIM(a);
    1725             : 
    1726         108 :     size = CUBE_SIZE(dim);
    1727         108 :     result = (NDBOX *) palloc0(size);
    1728         108 :     SET_VARSIZE(result, size);
    1729         108 :     SET_DIM(result, dim);
    1730             : 
    1731         376 :     for (i = 0, j = dim; i < DIM(a); i++, j++)
    1732             :     {
    1733         268 :         if (LL_COORD(a, i) >= UR_COORD(a, i))
    1734             :         {
    1735         252 :             result->x[i] = UR_COORD(a, i) - r;
    1736         252 :             result->x[j] = LL_COORD(a, i) + r;
    1737             :         }
    1738             :         else
    1739             :         {
    1740          16 :             result->x[i] = LL_COORD(a, i) - r;
    1741          16 :             result->x[j] = UR_COORD(a, i) + r;
    1742             :         }
    1743         268 :         if (result->x[i] > result->x[j])
    1744             :         {
    1745          16 :             result->x[i] = (result->x[i] + result->x[j]) / 2;
    1746          16 :             result->x[j] = result->x[i];
    1747             :         }
    1748             :     }
    1749             :     /* dim > a->dim only if r > 0 */
    1750         116 :     for (; i < dim; i++, j++)
    1751             :     {
    1752           8 :         result->x[i] = -r;
    1753           8 :         result->x[j] = r;
    1754             :     }
    1755             : 
    1756             :     /*
    1757             :      * Check if the result was in fact a point, and set the flag in the datum
    1758             :      * accordingly. (we don't bother to repalloc it smaller)
    1759             :      */
    1760         108 :     if (cube_is_point_internal(result))
    1761             :     {
    1762          16 :         size = POINT_SIZE(dim);
    1763          16 :         SET_VARSIZE(result, size);
    1764          16 :         SET_POINT_BIT(result);
    1765             :     }
    1766             : 
    1767         108 :     PG_FREE_IF_COPY(a, 0);
    1768         108 :     PG_RETURN_NDBOX_P(result);
    1769             : }
    1770             : 
    1771             : /* Create a one dimensional box with identical upper and lower coordinates */
    1772             : Datum
    1773         388 : cube_f8(PG_FUNCTION_ARGS)
    1774             : {
    1775         388 :     double      x = PG_GETARG_FLOAT8(0);
    1776             :     NDBOX      *result;
    1777             :     int         size;
    1778             : 
    1779         388 :     size = POINT_SIZE(1);
    1780         388 :     result = (NDBOX *) palloc0(size);
    1781         388 :     SET_VARSIZE(result, size);
    1782         388 :     SET_DIM(result, 1);
    1783         388 :     SET_POINT_BIT(result);
    1784         388 :     result->x[0] = x;
    1785             : 
    1786         388 :     PG_RETURN_NDBOX_P(result);
    1787             : }
    1788             : 
    1789             : /* Create a one dimensional box */
    1790             : Datum
    1791          24 : cube_f8_f8(PG_FUNCTION_ARGS)
    1792             : {
    1793          24 :     double      x0 = PG_GETARG_FLOAT8(0);
    1794          24 :     double      x1 = PG_GETARG_FLOAT8(1);
    1795             :     NDBOX      *result;
    1796             :     int         size;
    1797             : 
    1798          24 :     if (x0 == x1)
    1799             :     {
    1800           8 :         size = POINT_SIZE(1);
    1801           8 :         result = (NDBOX *) palloc0(size);
    1802           8 :         SET_VARSIZE(result, size);
    1803           8 :         SET_DIM(result, 1);
    1804           8 :         SET_POINT_BIT(result);
    1805           8 :         result->x[0] = x0;
    1806             :     }
    1807             :     else
    1808             :     {
    1809          16 :         size = CUBE_SIZE(1);
    1810          16 :         result = (NDBOX *) palloc0(size);
    1811          16 :         SET_VARSIZE(result, size);
    1812          16 :         SET_DIM(result, 1);
    1813          16 :         result->x[0] = x0;
    1814          16 :         result->x[1] = x1;
    1815             :     }
    1816             : 
    1817          24 :     PG_RETURN_NDBOX_P(result);
    1818             : }
    1819             : 
    1820             : /* Add a dimension to an existing cube with the same values for the new
    1821             :    coordinate */
    1822             : Datum
    1823         774 : cube_c_f8(PG_FUNCTION_ARGS)
    1824             : {
    1825         774 :     NDBOX      *cube = PG_GETARG_NDBOX_P(0);
    1826         774 :     double      x = PG_GETARG_FLOAT8(1);
    1827             :     NDBOX      *result;
    1828             :     int         size;
    1829             :     int         i;
    1830             : 
    1831         774 :     if (DIM(cube) + 1 > CUBE_MAX_DIM)
    1832           2 :         ereport(ERROR,
    1833             :                 (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
    1834             :                  errmsg("can't extend cube"),
    1835             :                  errdetail("A cube cannot have more than %d dimensions.",
    1836             :                            CUBE_MAX_DIM)));
    1837             : 
    1838         772 :     if (IS_POINT(cube))
    1839             :     {
    1840         766 :         size = POINT_SIZE((DIM(cube) + 1));
    1841         766 :         result = (NDBOX *) palloc0(size);
    1842         766 :         SET_VARSIZE(result, size);
    1843         766 :         SET_DIM(result, DIM(cube) + 1);
    1844         766 :         SET_POINT_BIT(result);
    1845        1914 :         for (i = 0; i < DIM(cube); i++)
    1846        1148 :             result->x[i] = cube->x[i];
    1847         766 :         result->x[DIM(result) - 1] = x;
    1848             :     }
    1849             :     else
    1850             :     {
    1851           6 :         size = CUBE_SIZE((DIM(cube) + 1));
    1852           6 :         result = (NDBOX *) palloc0(size);
    1853           6 :         SET_VARSIZE(result, size);
    1854           6 :         SET_DIM(result, DIM(cube) + 1);
    1855          14 :         for (i = 0; i < DIM(cube); i++)
    1856             :         {
    1857           8 :             result->x[i] = cube->x[i];
    1858           8 :             result->x[DIM(result) + i] = cube->x[DIM(cube) + i];
    1859             :         }
    1860           6 :         result->x[DIM(result) - 1] = x;
    1861           6 :         result->x[2 * DIM(result) - 1] = x;
    1862             :     }
    1863             : 
    1864         772 :     PG_FREE_IF_COPY(cube, 0);
    1865         772 :     PG_RETURN_NDBOX_P(result);
    1866             : }
    1867             : 
    1868             : /* Add a dimension to an existing cube */
    1869             : Datum
    1870          18 : cube_c_f8_f8(PG_FUNCTION_ARGS)
    1871             : {
    1872          18 :     NDBOX      *cube = PG_GETARG_NDBOX_P(0);
    1873          18 :     double      x1 = PG_GETARG_FLOAT8(1);
    1874          18 :     double      x2 = PG_GETARG_FLOAT8(2);
    1875             :     NDBOX      *result;
    1876             :     int         size;
    1877             :     int         i;
    1878             : 
    1879          18 :     if (DIM(cube) + 1 > CUBE_MAX_DIM)
    1880           2 :         ereport(ERROR,
    1881             :                 (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
    1882             :                  errmsg("can't extend cube"),
    1883             :                  errdetail("A cube cannot have more than %d dimensions.",
    1884             :                            CUBE_MAX_DIM)));
    1885             : 
    1886          16 :     if (IS_POINT(cube) && (x1 == x2))
    1887             :     {
    1888           2 :         size = POINT_SIZE((DIM(cube) + 1));
    1889           2 :         result = (NDBOX *) palloc0(size);
    1890           2 :         SET_VARSIZE(result, size);
    1891           2 :         SET_DIM(result, DIM(cube) + 1);
    1892           2 :         SET_POINT_BIT(result);
    1893           4 :         for (i = 0; i < DIM(cube); i++)
    1894           2 :             result->x[i] = cube->x[i];
    1895           2 :         result->x[DIM(result) - 1] = x1;
    1896             :     }
    1897             :     else
    1898             :     {
    1899          14 :         size = CUBE_SIZE((DIM(cube) + 1));
    1900          14 :         result = (NDBOX *) palloc0(size);
    1901          14 :         SET_VARSIZE(result, size);
    1902          14 :         SET_DIM(result, DIM(cube) + 1);
    1903          30 :         for (i = 0; i < DIM(cube); i++)
    1904             :         {
    1905          16 :             result->x[i] = LL_COORD(cube, i);
    1906          16 :             result->x[DIM(result) + i] = UR_COORD(cube, i);
    1907             :         }
    1908          14 :         result->x[DIM(result) - 1] = x1;
    1909          14 :         result->x[2 * DIM(result) - 1] = x2;
    1910             :     }
    1911             : 
    1912          16 :     PG_FREE_IF_COPY(cube, 0);
    1913          16 :     PG_RETURN_NDBOX_P(result);
    1914             : }

Generated by: LCOV version 1.16