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

/**
 * @brief Skiplist data structure used for performing temporal aggregates
 */

#ifndef __SKIPLIST_H__
#define __SKIPLIST_H__

/* PostgreSQL */
#include <postgres.h>
/* MEOS */
#include <meos.h>
#include "general/temporal.h"

/*****************************************************************************
 * fmgr macros
 *****************************************************************************/

#define DatumGetSkipListP(X)      ((SkipList *) DatumGetPointer(X))
#define SkipListPGetDatum(X)      PointerGetDatum(X)
#define PG_GETARG_SKIPLIST_P(n)   DatumGetSkipListP(PG_GETARG_DATUM(n))
#define PG_RETURN_SKIPLIST_P(x)   return SkipListPGetDatum(x)

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

extern bool ensure_same_skiplist_subtype(SkipList *state, uint8 subtype);

extern void aggstate_set_extra(SkipList *state, void *data, size_t size);

extern SkipList *skiplist_make(void **values, int count);
extern void *skiplist_headval(SkipList *list);
extern void skiplist_splice(SkipList *list, void **values, int count,
  datum_func2 func, bool crossings);
extern void **skiplist_values(SkipList *list);
extern Temporal **skiplist_temporal_values(SkipList *list);
extern void skiplist_free(SkipList *list);

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

#endif
