Set.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_set.h"
#define SET_BASE tsl::robin_set
#else
#include <set>
#define SET_BASE std::set
#endif
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief A dummy base class for all Set templates
    **/
    class SetBase
    {};
    /**--------------------------------------------------------------------------------------------------
    \brief Container that stores unique elements in no particular order, and which allow for fast retrieval 
        or insertion of individual elements based on their value.
    **/
    template<class t_value>
    class Set : public SET_BASE<t_value>, public SetBase
    {
    public:
        Set()
            : SET_BASE<t_value>()
        {}
        template<class t_iter>
        Set(const t_iter& begin, const t_iter& end)
            : SET_BASE<t_value>(begin, end)
        {}
        template<class t_type, class t_index_type, class t_memory_allocator, class t_memory_manager>
        Set(const Buffer<t_type, t_index_type, t_memory_allocator, t_memory_manager>& values)
            : SET_BASE<t_value>(values.begin(), values.end())
        {}
        [[nodiscard]] bool hasValue(const t_value& key) const
        {
            return SET_BASE<t_value>::find(key) != SET_BASE<t_value>::end();
        }
        void add(const t_value& key)
        {
            SET_BASE<t_value>::insert(key);
        }
        void add(t_value&& key)
        {
            SET_BASE<t_value>::insert(std::move(key));
        }
        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);
            return values;
        }
        [[nodiscard]] uint04 indexOf(const t_value& key) const
        {
            uint04 i = 0;
            for (const auto& location : *this)
            {
                if (location.first == key)
                    return i;
                i++;
            }
            return Constant<uint04>::Invalid;
        }
        [[nodiscard]] uint04 size() const
        {
            return cast<uint04>(SET_BASE<t_value>::size());
        }
    };
}