nodes_value_containers.hpp

#ifndef NODE_VALUE_ARR
#define NODE_VALUE_ARR

#include <algorithm>
#include <memory>
#include <vector>

#include<utils/enum.hpp>

namespace node_value_arrs
{
    extern std::vector<double> TEMP_STORAGE_ARR; //!< Array to temporarily store feature values
    extern std::vector<double> VALUES_ARR; //!< Value of the stored features
    extern std::vector<double> TEMP_STORAGE_TEST_ARR; //!< Array to temporarily store feature values
    extern std::vector<double> TEST_VALUES_ARR; //!< Value of the stored features test values
    extern std::vector<double> D_MATRIX; //!< The descriptor matrix
    extern std::vector<int> TEMP_STORAGE_REG; //!< Register to see which feature is stored in each slot
    extern std::vector<int> TEMP_STORAGE_TEST_REG; //!< Register to see which feature is stored in each slot

    extern int N_SELECTED; //!< Number of features selected
    extern int N_SAMPLES; //!< Number of samples in the nodes
    extern int N_SAMPLES_TEST; //!< Number of samples in the nodes
    extern int N_STORE_FEATURES; //!< Number of features with stored values
    extern int N_TEMP_STORE_FEATURES; //!< Number of feature that can be stored in TEMP_STORAGE ARRs values
    extern int N_RUNGS_STORED; //!< Number of rungs with values stored


    /**
     * @brief Get the maximum number of new features for each rung
     *
     * @param new_op operator that will add new features
     * @param n_current_features current number of of features in the rung
     *
     * @return [description]
     */
    int get_number_new_features(std::string new_op, int n_current_features);

    /**
     * @brief Get the maximum number of features to store
     *
     * @param allowed_operators list of allowed operators
     * @param n_dims Number of dimensions to store
     * @param n_feats number of features in Phi_0
     * @return [description]
     */
    int get_max_number_features(std::vector<std::string> allowed_operators, int n_dims, int n_feats);

    /**
     * @brief set of the value arrays
     * @details Take initial parameters and construct the feature arraies
     *
     * @param n_samples number of samples per feature
     * @param n_samples_test number of test samples per feature
     * @param n_primary_feat number of primary features
     */
    void initialize_values_arr(int n_samples, int n_samples_test, int n_primary_feat);

    /**
     * @brief set of the value arrays
     * @details Take initial parameters and construct the feature arraies
     *
     * @param n_dims Number of dimensions to store
     * @param n_feat number of features to store
     * @param use_temp If true keep the temporary_storage
     */
    void resize_values_arr(int n_dims, int n_feat, int max_temp_store, bool use_temp);

    /**
     * @brief set of the value arrays
     * @details Take initial parameters and construct the feature arraies
     *
     * @param n_samples number of samples per feature
     * @param n_primary_feat number of primary features
     */
    void initialize_d_matrix_arr();

    /**
     * @brief set of the value arrays
     * @details Take initial parameters and construct the feature arraies
     *
     * @param n_select Number of features to select
     */
    void resize_d_matrix_arr(int n_select);

    /**
     * @brief Get a reference slot/feature register
     *
     * @param ind Feature index
     * @param offset Offset integer for TEMP_STORE_ARRAY
     *
     * @return The register element for a given feature index and offset
     */
    inline int& temp_storage_reg(int ind, int offset = 0){return TEMP_STORAGE_REG[(ind % N_TEMP_STORE_FEATURES) + (offset % 3) * N_TEMP_STORE_FEATURES];}

    /**
     * @brief Get a reference slot/feature test register
     *
     * @param ind Feature index
     * @param offset Offset integer for TEMP_STORE_TEST_ARRAY
     *
     * @return The register element for a given feature index and offset
     */
    inline int& temp_storage_test_reg(int ind, int offset = 0){return TEMP_STORAGE_TEST_REG[(ind % N_TEMP_STORE_FEATURES) + (offset % 3) * N_TEMP_STORE_FEATURES];}

    /**
     * @brief Access element of the permanent storage array
     *
     * @param feature_ind The feature index to access
     *
     * @return pointer to the feature;s data array
     */
    inline double* access_value_arr(int feature_ind){return VALUES_ARR.data() + feature_ind*N_SAMPLES;}

    /**
     * @brief Access element of the test value array
     *
     * @param feature_ind The feature index to access
     *
     * @return pointer to the feature;s test data array
     */
    inline double* access_test_value_arr(int feature_ind){return TEST_VALUES_ARR.data() + feature_ind*N_SAMPLES_TEST;}

    /**
     * @brief Access element of temporary storage array
     *
     * @param slot The slot of the temporary storage arrays
     *
     * @return pointer to the feature's temporary storage
     */
    inline double* access_temp_storage(int slot){return TEMP_STORAGE_ARR.data() + slot*N_SAMPLES;}

    /**
     * @brief Access element of temporary storage test array
     *
     * @param slot The slot of the temporary storage test arrays
     *
     * @return pointer to the feature's temporary test storage
     */
    inline double* access_temp_storage_test(int slot){return TEMP_STORAGE_TEST_ARR.data() + slot*N_SAMPLES_TEST;}

    /**
     * @brief Access the value_ptr to a feature
     *
     * @param ind Feature index
     * @param offset the offset for the storage
     *
     * @return The value pointer
     */
    double* get_value_ptr(int arr_ind, int feat_ind, int offset = 0);

    /**
     * @brief Access the test_value_ptr to a feature
     *
     * @param ind Feature index
     * @param offset the offset for the storage
     *
     * @return The value pointer
     */
    double* get_test_value_ptr(int arr_ind, int feat_ind, int offset = 0);

    /**
     * @brief Get the pointer to a primary feature
     *
     * @param ind Index of the primary feature
     * @return The pointer to the descriptor matrix's data
     */
    inline double* get_d_matrix_ptr(int ind)
    {
        return D_MATRIX.data() + ind * N_SAMPLES;
    }

    inline void clear_temp_reg(){std::fill_n(TEMP_STORAGE_REG.data(), TEMP_STORAGE_REG.size(), -1);}
    inline void clear_temp_test_reg(){std::fill_n(TEMP_STORAGE_TEST_REG.data(), TEMP_STORAGE_TEST_REG.size(), -1);}
}

#endif