multi_type_matrix.hpp

/*************************************************************************
 *
 * Copyright (c) 2012-2018 Kohei Yoshida
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 ************************************************************************/

#ifndef __MDDS_MULTI_TYPE_MATRIX_HPP__
#define __MDDS_MULTI_TYPE_MATRIX_HPP__

#ifdef MDDS_MULTI_TYPE_MATRIX_DEBUG
#ifndef MDDS_MULTI_TYPE_VECTOR_DEBUG
#define MDDS_MULTI_TYPE_VECTOR_DEBUG 1
#endif
#endif

#include "multi_type_vector.hpp"
#include "multi_type_vector_trait.hpp"

namespace mdds {

namespace mtm {

enum element_t
{
    element_empty   = mdds::mtv::element_type_empty,
    element_boolean = mdds::mtv::element_type_boolean,
    element_string  = mdds::mtv::element_type_string,
    element_numeric = mdds::mtv::element_type_numeric,
    element_integer = mdds::mtv::element_type_int
};

struct std_string_trait
{
    typedef mdds::mtv::int_element_block integer_element_block;
    typedef mdds::mtv::string_element_block string_element_block;

    typedef mdds::mtv::element_block_func element_block_func;
};

}

template<typename _MtxTrait>
class multi_type_matrix
{
    typedef _MtxTrait matrix_trait;
public:
    typedef typename matrix_trait::string_element_block string_block_type;
    typedef typename matrix_trait::integer_element_block integer_block_type;

    typedef typename string_block_type::value_type string_type;
    typedef typename integer_block_type::value_type integer_type;
    typedef size_t      size_type;

private:
    typedef mdds::multi_type_vector<typename matrix_trait::element_block_func> store_type;

public:
    typedef typename store_type::position_type position_type;
    typedef typename store_type::const_position_type const_position_type;

    typedef typename store_type::element_block_type element_block_type;

    typedef typename mtv::boolean_element_block boolean_block_type;
    typedef typename mtv::numeric_element_block numeric_block_type;

    struct size_pair_type
    {
        size_type row;
        size_type column;
        size_pair_type() : row(0), column(0) {}
        size_pair_type(size_type _row, size_type _column) : row(_row), column(_column) {}
        size_pair_type(std::initializer_list<size_type> vs)
        {
            if (vs.size() != 2)
                throw invalid_arg_error("size_pair_type requires exactly 2 elements.");

            size_type* ptrs[2] = { &row, &column };
            size_type** p = ptrs;

            for (size_type v : vs)
                **p++ = v;
        }

        bool operator== (const size_pair_type& r) const { return row == r.row && column == r.column; }
        bool operator!= (const size_pair_type& r) const { return !operator== (r); }
    };

    struct element_block_node_type
    {
        friend class multi_type_matrix;

        mtm::element_t type;
        size_type offset;
        size_type size;
        const element_block_type* data;

        element_block_node_type();
        element_block_node_type(const element_block_node_type& other);

        template<typename _Blk>
        typename _Blk::const_iterator begin() const;

        template<typename _Blk>
        typename _Blk::const_iterator end() const;

    private:
        void assign(const const_position_type& pos, size_type section_size);
    };

    static mtm::element_t to_mtm_type(mdds::mtv::element_t mtv_type)
    {
        switch (mtv_type)
        {
            case string_block_type::block_type:
                return mdds::mtm::element_string;
            case integer_block_type::block_type:
                return mdds::mtm::element_integer;
            case mdds::mtv::element_type_numeric:
            case mdds::mtv::element_type_boolean:
            case mdds::mtv::element_type_empty:
                // These types share the same numeric values.
                return static_cast<mtm::element_t>(mtv_type);
            default:
                throw type_error("multi_type_matrix: unknown element type.");
        }
    }

private:
    template<typename _Func>
    struct walk_func
    {
        _Func& m_func;
        walk_func(_Func& func) : m_func(func) {}

        void operator() (const typename store_type::const_iterator::value_type& mtv_node)
        {
            element_block_node_type mtm_node;
            mtm_node.type = to_mtm_type(mtv_node.type);
            mtm_node.size = mtv_node.size;
            mtm_node.data = mtv_node.data;
            m_func(mtm_node);
        }
    };

public:
    static position_type next_position(const position_type& pos);

    static const_position_type next_position(const const_position_type& pos);

    multi_type_matrix();

    multi_type_matrix(size_type rows, size_type cols);

    template<typename _T>
    multi_type_matrix(size_type rows, size_type cols, const _T& value);

    template<typename _T>
    multi_type_matrix(size_type rows, size_type cols, const _T& it_begin, const _T& it_end);

    multi_type_matrix(const multi_type_matrix& r);

    ~multi_type_matrix();

    bool operator== (const multi_type_matrix& other) const;
    bool operator!= (const multi_type_matrix& other) const;

    multi_type_matrix& operator= (const multi_type_matrix& r);

    position_type position(size_type row, size_type col);

    position_type position(const position_type& pos_hint, size_type row, size_type col);

    const_position_type position(size_type row, size_type col) const;

    const_position_type position(const const_position_type& pos_hint, size_type row, size_type col) const;

    size_pair_type matrix_position(const const_position_type& pos) const;

    position_type end_position();

    const_position_type end_position() const;

    mtm::element_t get_type(const const_position_type& pos) const;

    mtm::element_t get_type(size_type row, size_type col) const;

    double get_numeric(size_type row, size_type col) const;

    double get_numeric(const const_position_type& pos) const;

    integer_type get_integer(size_type row, size_type col) const;

    integer_type get_integer(const const_position_type& pos) const;

    bool get_boolean(size_type row, size_type col) const;

    bool get_boolean(const const_position_type& pos) const;

    const string_type& get_string(size_type row, size_type col) const;

    const string_type& get_string(const const_position_type& pos) const;

    template<typename _T>
    _T get(size_type row, size_type col) const;

    void set_empty(size_type row, size_type col);

    void set_empty(size_type row, size_type col, size_type length);

    position_type set_empty(const position_type& pos);

    void set_column_empty(size_type col);

    void set_row_empty(size_type row);

    void set(size_type row, size_type col, double val);

    position_type set(const position_type& pos, double val);

    void set(size_type row, size_type col, bool val);

    position_type set(const position_type& pos, bool val);

    void set(size_type row, size_type col, const string_type& str);

    position_type set(const position_type& pos, const string_type& str);

    void set(size_type row, size_type col, integer_type val);

    position_type set(const position_type& pos, integer_type val);

    template<typename _T>
    void set(size_type row, size_type col, const _T& it_begin, const _T& it_end);

    template<typename _T>
    position_type set(const position_type& pos, const _T& it_begin, const _T& it_end);

    template<typename _T>
    void set_column(size_type col, const _T& it_begin, const _T& it_end);

    size_pair_type size() const;

    multi_type_matrix& transpose();

    void copy(const multi_type_matrix& src);

    template<typename _T>
    void copy(size_type rows, size_type cols, const _T& it_begin, const _T& it_end);

    void resize(size_type rows, size_type cols);

    template<typename _T>
    void resize(size_type rows, size_type cols, const _T& value);

    void clear();

    bool numeric() const;

    bool empty() const;

    void swap(multi_type_matrix& r);

    template<typename _Func>
    _Func walk(_Func func) const;

    template<typename _Func>
    _Func walk(_Func func, const size_pair_type& start, const size_pair_type& end) const;

    template<typename _Func>
    _Func walk(_Func func, const multi_type_matrix& right) const;

    template<typename _Func>
    _Func walk(_Func func, const multi_type_matrix& right,
        const size_pair_type& start, const size_pair_type& end) const;


#ifdef MDDS_MULTI_TYPE_MATRIX_DEBUG
    void dump() const
    {
        m_store.dump_blocks(std::cout);
    }
#endif

private:

    inline size_type get_pos(size_type row, size_type col) const
    {
        return m_size.row * col + row;
    }

    inline size_type get_pos(const const_position_type& pos) const
    {
        return pos.first->position + pos.second;
    }

private:
    store_type m_store;
    size_pair_type m_size;
};

}

#include "multi_type_matrix_def.inl"

#endif