iapi.h

/* File: $Id$
   Author: John Wu <John.Wu at acm.org>
      Lawrence Berkeley National Laboratory
   Copyright (c) 2001-20164-2014 the Regents of the University of California
*/
#ifndef IBIS_IAPI_H
#define IBIS_IAPI_H

#include "const.h"      // common definitions and declarations
#include "capi.h"       // reuse the definitions from capi.h

typedef enum FastBitDataType {
    FastBitDataTypeUnknown,
    FastBitDataTypeByte,
    FastBitDataTypeUByte,
    FastBitDataTypeShort,
    FastBitDataTypeUShort,
    FastBitDataTypeInt,
    FastBitDataTypeUInt,
    FastBitDataTypeLong,
    FastBitDataTypeULong,
    FastBitDataTypeFloat,
    FastBitDataTypeDouble,
    FastBitDataTypeBitRaw,
    FastBitDataTypeBitCompressed
} FastBitDataType;

typedef enum FastBitCompareType {
    FastBitCompareLess,
    FastBitCompareLessEqual,
    FastBitCompareGreater,
    FastBitCompareGreaterEqual,
    FastBitCompareEqual,
    FastBitCompareNotEqual,
} FastBitCompareType;

typedef enum FastBitCombineType {
    FastBitCombineAnd,
    FastBitCombineOr,
    FastBitCombineXor,
    FastBitCombineNand,
    FastBitCombineNor,
} FastBitCombineType;

#ifdef __cplusplus
typedef ibis::qExpr* FastBitSelectionHandle;
#else
typedef void* FastBitSelectionHandle;
#endif
typedef void* FastBitIndexHandle;

#ifdef __cplusplus
extern "C" {
#endif

    FastBitSelectionHandle fastbit_selection_osr
    (const char*, FastBitCompareType, double);

    void fastbit_selection_free(FastBitSelectionHandle);

    FastBitSelectionHandle fastbit_selection_combine
    (FastBitSelectionHandle, FastBitCombineType, FastBitSelectionHandle);

    int64_t fastbit_selection_estimate(FastBitSelectionHandle);

    int64_t fastbit_selection_evaluate(FastBitSelectionHandle);

    int64_t fastbit_selection_get_coordinates
    (FastBitSelectionHandle, uint64_t*, uint64_t, uint64_t);

    int64_t fastbit_selection_read
    (FastBitDataType, const void *, uint64_t, FastBitSelectionHandle,
     void *, uint64_t, uint64_t);

    void fastbit_selection_purge_results(FastBitSelectionHandle);
    void fastbit_iapi_free_all();
    void fastbit_iapi_free_array(const char *);
    void fastbit_iapi_free_array_by_addr(void *);
    int fastbit_iapi_register_array
    (const char*, FastBitDataType, void*, uint64_t);
    int fastbit_iapi_extend_array
    (const char*, FastBitDataType, void*, uint64_t);
    int fastbit_iapi_register_array_nd
    (const char*, FastBitDataType, void*, uint64_t*, uint64_t);
    int fastbit_iapi_register_array_ext
    (const char*, FastBitDataType, uint64_t*, uint64_t, void*,
     FastBitReadExtArray);
    int fastbit_iapi_register_array_index_only
    (const char*, FastBitDataType, uint64_t*, uint64_t,
     double*, uint64_t, int64_t*, uint64_t, void*, FastBitReadBitmaps);
    int fastbit_iapi_register_selection_as_bit_array
    (const char*, FastBitSelectionHandle);
    int fastbit_iapi_extend_bit_array_with_selection
    (const char*, FastBitSelectionHandle);

    int fastbit_iapi_build_index(const char*, const char*);

    int fastbit_iapi_deconstruct_index
    (const char*, double**keys, uint64_t*nkeys,
     int64_t**offsets, uint64_t*noffsets,
     uint32_t**bms, uint64_t*nbms);

    int fastbit_iapi_attach_full_index
    (const char*, double*, uint64_t, int64_t*, uint64_t, uint32_t*, uint64_t);

    int fastbit_iapi_attach_index
    (const char*, double*, uint64_t, int64_t*, uint64_t,
     void*, FastBitReadBitmaps);

    FastBitIndexHandle fastbit_iapi_reconstruct_index
    (double*, uint64_t, int64_t*, uint64_t);

    int fastbit_iapi_resolve_range
    (FastBitIndexHandle, FastBitCompareType, double, uint32_t *,
     uint32_t *, uint32_t *, uint32_t *);

    int64_t fastbit_iapi_get_number_of_hits
    (FastBitIndexHandle, uint32_t, uint32_t, uint32_t*);

    FastBitSelectionHandle fastbit_selection_create
    (FastBitDataType, void*, uint64_t, FastBitCompareType, void*);

    FastBitSelectionHandle fastbit_selection_create_nd
    (FastBitDataType, void*, uint64_t*, uint64_t, FastBitCompareType, void*);
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif