ivector.h

Go to the documentation of this file.

/******************************************************************************
The MIT License(MIT)

Embedded Template Library.

Copyright(c) 2014 jwellbelove

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 __ETL_IVECTOR__
#define __ETL_IVECTOR__
#define __ETL_IN_IVECTOR_H__

#include <iterator>
#include <algorithm>
#include <functional>
#include <stddef.h>

#include "vector_base.h"
#include "type_traits.h"
#include "parameter_type.h"

#ifndef ETL_THROW_EXCEPTIONS
#include "error_handler.h"
#endif

namespace etl
{
  //***************************************************************************
  //***************************************************************************
  template <typename T>
  class ivector : public vector_base
  {
  public:

    typedef T                                     value_type;
    typedef T&                                    reference;
    typedef const T&                              const_reference;
    typedef T*                                    pointer;
    typedef const T*                              const_pointer;
    typedef T*                                    iterator;
    typedef const T*                              const_iterator;
    typedef std::reverse_iterator<iterator>       reverse_iterator;
    typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
    typedef size_t                                size_type;
    typedef typename std::iterator_traits<iterator>::difference_type difference_type;

  protected:

    typedef typename parameter_type<T>::type parameter_t;

  public:

    // Use the base class void push_back().
    using vector_base::push_back;

    //*********************************************************************
    //*********************************************************************
    ivector& operator = (ivector& other)
    {
      const size_t length = std::min(MAX_SIZE, other.size());

      std::copy(other.begin(), other.begin() + length, p_buffer);
      current_size = length;

      return *this;
    }

    //*********************************************************************
    //*********************************************************************
    iterator begin()
    {
      return &p_buffer[0];
    }
    
    //*********************************************************************
    //*********************************************************************
    const_iterator begin() const
    {
      return &p_buffer[0];
    }        

    //*********************************************************************
    //*********************************************************************
    iterator end()
    {
      return &p_buffer[current_size];
    }

    //*********************************************************************
    //*********************************************************************
    const_iterator end() const
    {
      return &p_buffer[current_size];
    }

    //*********************************************************************
    //*********************************************************************
    const_iterator cbegin() const
    {
      return &p_buffer[0];
    } 

    //*********************************************************************
    //*********************************************************************
    const_iterator cend() const
    {
      return &p_buffer[current_size];
    }

    //*********************************************************************
    //*********************************************************************
    reverse_iterator rbegin()
    {
        return reverse_iterator(end());
    }
    
    //*********************************************************************
    //*********************************************************************
    const_reverse_iterator rbegin() const
    {
        return const_reverse_iterator(end());
    }        

    //*********************************************************************
    //*********************************************************************
    reverse_iterator rend()
    {
      return reverse_iterator(begin());
    }

    //*********************************************************************
    //*********************************************************************
    const_reverse_iterator rend() const
    {
      return const_reverse_iterator(begin());
    }

    //*********************************************************************
    //*********************************************************************
    const_reverse_iterator crbegin() const
    {
        return const_reverse_iterator(cend());
    } 

    //*********************************************************************
    //*********************************************************************
    const_reverse_iterator crend() const
    {
        return const_reverse_iterator(cbegin());
    }

    //*********************************************************************
    //*********************************************************************
    void resize(size_t newSize, T value = T())
    {

      if (newSize > MAX_SIZE)
      {
#ifdef ETL_THROW_EXCEPTIONS
        throw vector_full();
#else
        error_handler::error(vector_full());
#endif
      }

        if (newSize > current_size)
        {
            std::fill(&p_buffer[current_size], &p_buffer[newSize], value);
        }

        current_size = newSize;
    }

    //*********************************************************************
    //*********************************************************************
    reference operator [](size_t i)
    {
      return p_buffer[i];
    }

    //*********************************************************************
    //*********************************************************************
    const_reference operator [](size_t i) const
    {
      return p_buffer[i];
    }

    //*********************************************************************
    //*********************************************************************
    reference at(size_t i)
    {

      if (i >= current_size)
      {
#ifdef ETL_THROW_EXCEPTIONS
        throw vector_out_of_bounds();
#else
        error_handler::error(vector_out_of_bounds());
#endif
      }

      return p_buffer[i];
    }

    //*********************************************************************
    //*********************************************************************
    const_reference at(size_t i) const
    {

      if (i >= current_size)
      {
#ifdef ETL_THROW_EXCEPTIONS
        throw vector_out_of_bounds();
#else
        error_handler::error(vector_out_of_bounds());
#endif
      }

      return p_buffer[i];
    }

    //*********************************************************************
    //*********************************************************************
    reference front()
    {
      return p_buffer[0];
    }

    //*********************************************************************
    //*********************************************************************
    const_reference front() const
    {
      return p_buffer[0];
    }

    //*********************************************************************
    //*********************************************************************
    reference back()
    {
      return p_buffer[current_size - 1];
    }

    //*********************************************************************
    //*********************************************************************
    const_reference back() const
    {
      return p_buffer[current_size - 1];
    }

    //*********************************************************************
    //*********************************************************************
    pointer data()
    {
      return p_buffer;
    }

    //*********************************************************************
    //*********************************************************************
    const_pointer data() const
    {
      return p_buffer;
    }

    //*********************************************************************
    //*********************************************************************
    template <typename TIterator>
    void assign(TIterator first, TIterator last)
    {
      difference_type count = std::distance(first, last);

      if (count < 0)
      {
#ifdef ETL_THROW_EXCEPTIONS
        throw vector_iterator();
#else
        error_handler::error((vector_iterator));
#endif
      }
      else if (static_cast<size_t>(count) > MAX_SIZE)
      {
#ifdef ETL_THROW_EXCEPTIONS
        throw vector_full();
#else
        error_handler::error(vector_full());
#endif
      }
      else
      {
        // Safe to copy.
        std::copy(first, last, begin());
        current_size = count;
      }
    }

    //*********************************************************************
    //*********************************************************************
    void assign(size_t n, parameter_t value)
    {
      if (n > MAX_SIZE)
      {
#ifdef ETL_THROW_EXCEPTIONS
        throw vector_full();
#else
        error_handler::error(vector_full());
#endif
      }
      else
      {
        std::fill_n(begin(), n, value);
        current_size = n;
      }
    }

    //*********************************************************************
    //*********************************************************************
    void push_back(parameter_t value)
    {
      if (current_size == MAX_SIZE)
      {
#ifdef ETL_THROW_EXCEPTIONS
        throw vector_full();
#else
        error_handler::error(vector_full());
#endif
      }
      else
      {
        p_buffer[current_size++] = value;
      }
    }

    //*********************************************************************
    //*********************************************************************
    iterator insert(iterator position, parameter_t value)
    {
      if (position == end())
      {
        push_back(value);
        return iterator(&back());
      }
      else
      {
        if ((current_size + 1) > MAX_SIZE)
        {
#ifdef ETL_THROW_EXCEPTIONS
          throw vector_full();
#else
          error_handler::error(vector_full());
#endif
        }
        else
        {
          ++current_size;
          std::copy_backward(position, end() - 1, end());
          *position = value;
        }

        return position;
      }
    }

    //*********************************************************************
    //*********************************************************************
    void insert(iterator position, size_t n, parameter_t value)
    {
      if ((current_size + n) > MAX_SIZE)
      {
#ifdef ETL_THROW_EXCEPTIONS
        throw vector_full();
#else
        error_handler::error(vector_full());
#endif
      }
      else
      {
        current_size += n;
        std::copy_backward(position, end() - n, end());
        std::fill_n(position, n, value);
      }
    }

    //*********************************************************************
    //*********************************************************************
    template <class TIterator>
    void insert(iterator position, TIterator first, TIterator last)
    {
      size_t count = std::distance(first, last);

      if ((current_size + count) > MAX_SIZE)
      {
#ifdef ETL_THROW_EXCEPTIONS
        throw vector_full();
#else
        error_handler::error(vector_full());
#endif
      }
      else
      {
        current_size += count;
        std::copy_backward(position, end() - count, end());
        std::copy(first, first + count, position);
      }
    }

    //*********************************************************************
    //*********************************************************************
    iterator erase(iterator iElement)
    {
      std::copy(iElement + 1, end(), iElement);
      --current_size;

      return iElement;
    }

    //*********************************************************************
    //*********************************************************************
    iterator erase(iterator first, iterator last)
    {
      std::copy(last, end(), first);
      current_size -= std::distance(first, last);

      return first;
    }

    //*********************************************************************
    //*********************************************************************
    void clear()
    {
        current_size = 0;
    }

  protected:

    //*********************************************************************
    //*********************************************************************
    ivector(T* p_buffer, size_t MAX_SIZE)
      : vector_base(MAX_SIZE),
        p_buffer(p_buffer)
    {
    }

  private:

    T* p_buffer;
  };

  //***************************************************************************
  //***************************************************************************
  template <typename T>
  bool operator ==(const etl::ivector<T>& lhs, const etl::ivector<T>& rhs)
  {
    return (lhs.size() == rhs.size()) && std::equal(lhs.begin(), lhs.end(), rhs.begin());
  }

  //***************************************************************************
  //***************************************************************************
  template <typename T>
  bool operator !=(const etl::ivector<T>& lhs, const etl::ivector<T>& rhs)
  {
    return !(lhs == rhs);
  }

  //***************************************************************************
  //***************************************************************************
  template <typename T>
  bool operator <(const etl::ivector<T>& lhs, const etl::ivector<T>& rhs)
  {
    return std::lexicographical_compare(lhs.begin(), lhs.end(), rhs.begin(), rhs.end());
  }

  //***************************************************************************
  //***************************************************************************
  template <typename T>
  bool operator >(const etl::ivector<T>& lhs, const etl::ivector<T>& rhs)
  {
    return std::lexicographical_compare(lhs.begin(), lhs.end(), rhs.begin(), rhs.end(), std::greater<T>());
  }

  //***************************************************************************
  //***************************************************************************
  template <typename T>
  bool operator <=(const etl::ivector<T>& lhs, const etl::ivector<T>& rhs)
  {
    return !operator >(lhs, rhs);
  }

  //***************************************************************************
  //***************************************************************************
  template <typename T>
  bool operator >=(const etl::ivector<T>& lhs, const etl::ivector<T>& rhs)
  {
    return !operator <(lhs, rhs);
  }
}

#undef __etl_in_ivector_h__
#endif