Vector.h

Go to the documentation of this file.

/*
   Copyright (c) 2018 DIVIDE-Studio
   Copyright (c) 2009 Ionut Cava
 
   This file is part of DIVIDE Framework.
 
   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.
 
   */
 
#pragma once
#ifndef DVD_VECTOR_H_
#define DVD_VECTOR_H_
 
#include <EASTL/sort.h>
#include <EASTL/vector.h>
 
namespace Divide
{
    template<typename Type>
    using vector = eastl::vector<Type>;
 
    template<typename T, typename Type>
    concept is_non_fixed_vector = std::is_same_v<T, vector<Type>>;
    template<typename T, typename... Ts>
    concept is_fixed_vector = std::is_same_v<T, eastl::fixed_vector<Ts...>>;
    template<typename T, typename... Ts>
    concept is_vector = is_non_fixed_vector<T, std::tuple_element_t<0, std::tuple<Ts...>>> || is_fixed_vector<T, Ts...>;
 
    template <typename T, size_t nodeCount, bool bEnableOverflow = true, typename OverflowAllocator = typename eastl::type_select<bEnableOverflow, EASTLAllocatorType, EASTLDummyAllocatorType>::type>
    inline void efficient_clear(eastl::fixed_vector<T, nodeCount, bEnableOverflow, OverflowAllocator> & fixed_vector)
    {
        if constexpr (bEnableOverflow)
        {
            fixed_vector.clear();
        }
        else
        {
            fixed_vector.reset_lose_memory();
        }
    }
 
    template< typename T, typename A>
    inline void efficient_clear( eastl::vector<T, A>& vec )
    {
        vec.resize(0);
    }
 
    template< typename T, typename Pred, typename A>
    typename eastl::vector<T, A>::iterator insert_sorted( eastl::vector<T, A>& vec, T const& item, Pred&& pred )
    {
        return vec.insert( eastl::upper_bound( eastl::begin( vec ), eastl::end( vec ), item, pred ), item );
    }
 
    template<typename T, typename A>
    void insert_unique( eastl::vector<T, A>& target, const T& item )
    {
        if ( eastl::find( eastl::cbegin( target ), eastl::cend( target ), item ) == eastl::cend( target ) )
        {
            target.push_back( item );
        }
 
    }
 
    template<typename T, typename A1, typename A2>
    void insert_unique( eastl::vector<T, A1>& target, const eastl::vector<T, A2>& source )
    {
        eastl::for_each( eastl::cbegin( source ), eastl::cend( source ),
                         [&target]( T const& item )
                         {
                             insert_unique( target, item );
                         } );
    }
 
    template<typename T, typename A1, typename A2>
    void insert( eastl::vector<T, A1>& target, const eastl::vector<T, A2>& source )
    {
        target.insert( end( target ), begin( source ), end( source ) );
    }
 
    template <typename T, typename A>
    bool contains( eastl::vector<T, A>& vec, const T& val )
    {
        return eastl::find( vec.cbegin(), vec.cend(), val ) != vec.cend();
    }
 
    template <typename T, typename A, class Predicate>
    bool dvd_erase_if( eastl::vector<T, A>& vec, Predicate&& pred )
    {
        return erase_if( vec, pred ) > 0u;
    }
 
    template<typename T, typename A>
    void pop_front( eastl::vector<T, A>& vec )
    {
        assert( !vec.empty() );
        vec.erase( eastl::begin( vec ) );
    }
 
    template<typename T, typename A1, typename A2>
    void unchecked_copy( eastl::vector<T, A1>& dst, const eastl::vector<T, A2>& src )
    {
        dst.resize( src.size() );
        memcpy( dst.data(), src.data(), src.size() * sizeof( T ) );
    }
 
    template<typename T, typename U, typename A>
    eastl::vector<T, A> convert( const eastl::vector<U, A>& data )
    {
        return eastl::vector<T, A>( eastl::cbegin( data ), eastl::cend( data ) );
    }
 
    template<typename Cont, typename It>
    auto ToggleIndices( Cont& cont, It beg, It end ) -> decltype(eastl::end( cont ))
    {
        int helpIndx = 0;
        return eastl::stable_partition( eastl::begin( cont ), eastl::end( cont ),
                                        [&]( [[maybe_unused]] decltype(*eastl::begin( cont )) const& val ) -> bool
                                        {
                                            return eastl::find( beg, end, helpIndx++ ) == end;
                                        } );
    }
 
    template<typename Cont, typename IndCont>
    void EraseIndicesSorted( Cont& cont, IndCont& indices )
    {
        for ( auto it = indices.rbegin(); it != indices.rend(); ++it )
        {
            cont.erase( cont.begin() + *it );
        }
    }
 
    template<typename Cont, typename IndCont>
    void EraseIndices( Cont& cont, IndCont& indices )
    {
        eastl::sort( indices.begin(), indices.end() );
        EraseIndicesSorted( cont, indices );
    }
 
    //ref: https://stackoverflow.com/questions/7571937/how-to-delete-items-from-a-stdvector-given-a-list-of-indices
 
    template<typename T, typename A1, typename A2>
    eastl::vector<T, A1> erase_indices( const eastl::vector<T, A1>& data, eastl::vector<size_t, A2>& indicesToDelete/* can't assume copy elision, don't pass-by-value */ )
    {
        eastl::sort( begin( indicesToDelete ), end( indicesToDelete ) );
        return erase_sorted_indices( data, indicesToDelete );
    }
 
    template<typename T, typename A1, typename A2>
    eastl::vector<T, A1> erase_sorted_indices( const eastl::vector<T, A1>& data, eastl::vector<size_t, A2>& indicesToDelete/* can't assume copy elision, don't pass-by-value */ )
    {
        if ( indicesToDelete.empty() )
        {
            return data;
        }
        assert( indicesToDelete.size() <= data.size() );
 
        eastl::vector<T, A1> ret;
        ret.reserve( data.size() - indicesToDelete.size() );
 
        // new we can assume there is at least 1 element to delete. copy blocks at a time.
        typename eastl::vector<T, A1>::const_iterator itBlockBegin = eastl::cbegin( data );
        for ( size_t it : indicesToDelete )
        {
            typename eastl::vector<T, A1>::const_iterator itBlockEnd = eastl::cbegin( data ) + it;
            if ( itBlockBegin != itBlockEnd )
            {
                eastl::copy( itBlockBegin, itBlockEnd, eastl::back_inserter( ret ) );
            }
            itBlockBegin = itBlockEnd + 1;
        }
 
        // copy last block.
        if ( itBlockBegin != data.end() )
        {
            eastl::copy( itBlockBegin, eastl::cend( data ), eastl::back_inserter( ret ) );
        }
 
        return ret;
    }
}; //namespace Divide
 
#endif //DVD_VECTOR_H_