Dictionary.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
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.
 
Library: Base
File: Dictionary
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/BaseValues.h>
#include <NDEVR/LibAssert.h>
#include <NDEVR/Buffer.h>
#define NDEVR_USE_ROBIN_MAP 1
#if NDEVR_USE_ROBIN_MAP
    #include "tsl/robin_map.h"
    #define MAP_BASE tsl::robin_map
#else
    #include <unordered_map>
    #define MAP_BASE MAP_BASE
#endif
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief A dummy base class for all Dictionary templates
    Used to more easily track inheritance for the templated Dictionary class
    **/
    class DictionaryBase
    {};
    /**--------------------------------------------------------------------------------------------------
    \brief A hash-based key-value store, useful for quick associative lookups.
    Key features include:
        - Uses tsl robin library as backing logic and hashmap. Proven to be significantly faster in 
            almost all metrics over std::unordered_set on modern architecture
        - Easy functions for converting to other NDEVR containers
    **/
    template<class t_key, class t_value, class t_hash = std::hash<t_key>>
    class Dictionary : public MAP_BASE<t_key, t_value, t_hash>, public DictionaryBase
    {
    public:
        Dictionary()
            : MAP_BASE<t_key, t_value, t_hash>()
        {}
        [[nodiscard]] bool hasKey(const t_key& key) const
        {
            return MAP_BASE<t_key, t_value, t_hash>::find(key) != MAP_BASE<t_key, t_value, t_hash>::end();
        }
        void add(const t_key& key, const t_value& value)
        {
            MAP_BASE<t_key, t_value, t_hash>::try_emplace(key, value);
        }
        
        void add(const t_key& key)
        {
            MAP_BASE<t_key, t_value, t_hash>::try_emplace(key);
        }
        void add(t_key&& key)
        {
            MAP_BASE<t_key, t_value>::try_emplace(std::move(key));
        }
        [[nodiscard]] const t_value& get(const t_key& key) const
        {
            return MAP_BASE<t_key, t_value, t_hash>::at(key);
        }
        [[nodiscard]] t_value& get(const t_key& key)
        {
            lib_assert(hasKey(key), "Tried to get from Dictionary, without having key");
            return MAP_BASE<t_key, t_value, t_hash>::at(key);
        }
        template<class t_index_type = uint04, class t_memory_allocator = ObjectAllocator<ObjectInfo<t_key>::Primitive, t_index_type>, class t_memory_manager = BufferAllocator<t_key, t_index_type, false>>
        [[nodiscard]] Buffer<t_key, t_index_type, t_memory_allocator, t_memory_manager> keys() const
        {
            Buffer<t_key, t_index_type, t_memory_allocator, t_memory_manager> keys(size());
            for (const auto& kv : (*this)) 
            {
                keys.add(kv.first);
            }
            return keys;
        }
        template<class t_index_type = uint04, class t_memory_allocator = ObjectAllocator<ObjectInfo<t_value>::Primitive, t_index_type>, class t_memory_manager = BufferAllocator<t_value, t_index_type, false>>
        [[nodiscard]] Buffer<t_value, t_index_type, t_memory_allocator, t_memory_manager> values() const
        {
            Buffer<t_value, t_index_type, t_memory_allocator, t_memory_manager> values(size());
            for (const auto& kv : (*this))
            {
                values.add(kv.second);
            }
            return values;
        }
        [[nodiscard]] uint04 indexOf(const t_key& key) const
        {
            uint04 i = 0;
            for (const auto& location : *this)
            {
                if (location.first == key)
                    return i;
                i++;
            }
            return Constant<uint04>::Invalid;
        }
        void removeIndex(uint04 index)
        {
            erase(std::next(MAP_BASE<t_key, t_value, t_hash>::begin(), index)->first);
        }
        [[nodiscard]] const t_value& getFromIndex(uint04 index) const
        {
            return std::next(MAP_BASE<t_key, t_value, t_hash>::begin(), index)->second;
        }
        void set(const t_key& key, const t_value& value)
        {
            MAP_BASE<t_key, t_value, t_hash>::at(key) = value;
        }
        [[nodiscard]] const t_value& operator[](const t_key& key) const
        {
            lib_assert(hasKey(key), "Tried to get from Dictionary, without having key");
            return MAP_BASE<t_key, t_value, t_hash>::at(key);
        }
        [[nodiscard]] t_value& operator[](const t_key& key)
        {
            return MAP_BASE<t_key, t_value, t_hash>::operator[](key);
        }
        [[nodiscard]] uint04 size() const
        {
            return cast<uint04>(MAP_BASE<t_key, t_value, t_hash>::size());
        }
    };
}