JASS_anytime_api.h

Go to the documentation of this file.

/*
    JASS_ANYTIME_API.H
    ------------------
    Copyright (c) 2021 Andrew Trotman
    Released under the 2-clause BSD license (See:https://en.wikipedia.org/wiki/BSD_licenses)
*/
#pragma once

#include "query.h"
#include "top_k_limit.h"
#include "parser_query.h"
#include "JASS_anytime_query.h"
#include "JASS_anytime_stats.h"
#include "deserialised_jass_v2.h"
#include "JASS_anytime_result.h"
#include "JASS_anytime_thread_result.h"

/*
    ENUM JASS_ERROR
    ---------------
*/
enum JASS_ERROR
    {
    JASS_ERROR_NO_INDEX = -1,               
    JASS_ERROR_OK = 0,                      
    JASS_ERROR_BAD_INDEX_VERSION,           
    JASS_ERROR_FAIL,                            
    JASS_ERROR_TOO_MANY_DOCUMENTS,      
    JASS_ERROR_TOO_LARGE,                   
    JASS_ERROR_INDEX_ALREADY_LOADED,        
};

/*
    CLASS JASS_ANYTIME_API
    ----------------------
*/
class JASS_anytime_api
    {
    private:
        static constexpr size_t MAX_QUANTUM = 0x0FFF;           
        static constexpr size_t MAX_TERMS_PER_QUERY = 1024; 

    private:
        /*
            @class thread_data
            @brief thread local data - one of these is needed per thread
        */
        class thread_data
            {
            public:
                std::unique_ptr<JASS::deserialised_jass_v1::segment_header[]> segment_order;
                JASS::query *jass_query;
            };

    private:
        JASS::deserialised_jass_v1 *index;                          
        size_t postings_to_process;                                 
        double relative_postings_to_process;                        
        size_t top_k;                                                       
        JASS::parser_query::parser_type which_query_parser; 
        size_t accumulator_width;                                       
        JASS_anytime_stats stats;                                       
        std::map<size_t, thread_data> thread_local_data;        
        std::string accumulator_manager;                                

    private:
        /*
            JASS_ANYTIME_API::JASS_ANYTIME_API()
            ------------------------------------
            Boilerplate the class to prevent assignment and copying.
        */
        JASS_anytime_api(JASS_anytime_api &from) = delete;
        JASS_anytime_api(JASS_anytime_api &&from) = delete;

        /*
            JASS_ANYTIME_API::OPERATOR=()
            -----------------------------
            Boilerplate the class to prevent assignment and copying.
        */
        JASS_anytime_api &operator=(JASS_anytime_api &from) = delete;
        JASS_anytime_api &operator=(JASS_anytime_api &&from) = delete;

        /*
            JASS_ANYTIME_API::ANYTIME()
            ---------------------------
        */
        void anytime(JASS_anytime_thread_result &output, std::vector<JASS_anytime_query> &query_list, size_t thread_number = 0);

        /*
            JASS_ANYTIME_API::ANYTIME_BOOTSTRAP()
            -------------------------------------
        */
        static void anytime_bootstrap(JASS_anytime_api *thiss, JASS_anytime_thread_result &output, std::vector<JASS_anytime_query> &query_list, size_t thread_number);

        /*
            JASS_ANYTIME_API::GET_THREAD_LOCAL_DATA()
            -----------------------------------------
        */
        thread_data &get_thread_local_data(size_t thread_number);

    public:
        /*
            JASS_ANYTIME_API::JASS_ANYTIME_API()
            ------------------------------------
        */
        JASS_anytime_api();

        /*
            JASS_ANYTIME_API::~JASS_ANYTIME_API()
            -------------------------------------
        */
        virtual ~JASS_anytime_api();

        /*
            JASS_ANYTIME_API::LOAD_INDEX()
            ------------------------------
        */
        JASS_ERROR load_index(size_t index_version, const std::string &directory = "", bool verbose = false);       // verbose prints progress as it loads the index

        /*
            JASS_ANYTIME_API::GET_DOCUMENT_COUNT()
            --------------------------------------
        */
        uint32_t get_document_count(void);

        /*
            JASS_ANYTIME_API::GET_ENCODING_SCHEME()
            ---------------------------------------
        */
        JASS_ERROR get_encoding_scheme(std::string &codex_name, int32_t &d_ness);

        /*
            JASS_ANYTIME_API::GET_ENCODING_SCHEME_NAME()
            --------------------------------------------
        */
        std::string get_encoding_scheme_name(void);

        /*
            JASS_ANYTIME_API::GET_ENCODING_SCHEME_D()
            -----------------------------------------
        */
        int32_t get_encoding_scheme_d(void);

        /*
            JASS_ANYTIME_API::SET_ACCUMULATOR_MANAGER()
            -------------------------------------------
        */
        void set_accumulator_manager(const std::string &name)
            {
            accumulator_manager = name;
            }

        /*
            JASS_ANYTIME_API::SET_POSTINGS_TO_PROCESS_PROPORTION()
            ------------------------------------------------------
        */
        JASS_ERROR set_postings_to_process_proportion(double percent);


        /*
            JASS_ANYTIME_API::SET_POSTINGS_TO_PROCESS_RELATIVE()
            ----------------------------------------------------
        */
        JASS_ERROR set_postings_to_process_relative(double percent);


        /*
            JASS_ANYTIME_API::SET_POSTINGS_TO_PROCESS()
            -------------------------------------------
        */
        JASS_ERROR set_postings_to_process(size_t count);

        /*
            JASS_ANYTIME_API::GET_POSTINGS_TO_PROCESS()
            -------------------------------------------
        */
        uint32_t get_postings_to_process(void);

        /*
            JASS_ANYTIME_API::GET_MAX_TOP_K()
            ---------------------------------
        */
        uint32_t get_max_top_k(void);

        /*
            JASS_ANYTIME_API::SET_TOP_K()
            -----------------------------
        */
        JASS_ERROR set_top_k(size_t k);

        /*
            JASS_ANYTIME_API::GET_TOP_K()
            -----------------------------
        */
        size_t get_top_k(void);

        /*
            JASS_ANYTIME_API::SET_ACCUMULATOR_WIDTH()
            -----------------------------------------
        */
        JASS_ERROR set_accumulator_width(size_t width);

        /*
            JASS_ANYTIME_API::USE_ASCII_PARSER()
            ------------------------------------
        */
        JASS_ERROR use_ascii_parser(void);

        /*
            JASS_ANYTIME_API::USE_QUERY_PARSER()
            ------------------------------------
        */
        JASS_ERROR use_query_parser(void);

        /*
            JASS_ANYTIME_API::SEARCH()
            --------------------------
        */
        JASS_anytime_result search(const std::string &query);

        /*
            JASS_ANYTIME_API::SEARCH()
            --------------------------
        */
        JASS_ERROR search(std::vector<JASS_anytime_thread_result> &output, std::vector<JASS_anytime_query> &query_list, size_t thread_count);

        /*
            JASS_ANYTIME_API::THREADED_SEARCH()
            -----------------------------------
        */
        std::vector<JASS_anytime_thread_result> threaded_search(std::vector<std::string> &query_list, size_t thread_count);
    } ;

/*
    CLASS ANYTIME
    -------------
*/
class anytime : public JASS_anytime_api
    {
    /*
        Nothing
    */
    };