array.h

Go to the documentation of this file.

 
 
/******************************************************************************
The MIT License(MIT)
 
Embedded Template Library.
https://github.com/ETLCPP/etl
https://www.etlcpp.com
 
Copyright(c) 2014 John Wellbelove
 
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_ARRAY_INCLUDED
#define ETL_ARRAY_INCLUDED
 
#include "platform.h"
#include "algorithm.h"
#include "iterator.h"
#include "functional.h"
#include "exception.h"
#include "type_traits.h"
#include "parameter_type.h"
#include "static_assert.h"
#include "error_handler.h"
#include "nth_type.h"
#include "initializer_list.h"
 
#include <stddef.h>
 
 
namespace etl
{
  //***************************************************************************
  //***************************************************************************
  class array_exception : public exception
  {
  public:
 
    array_exception(string_type reason_, string_type file_name_, numeric_type line_number_)
      : exception(reason_, file_name_, line_number_)
    {
    }
  };
 
  //***************************************************************************
  //***************************************************************************
  class array_out_of_range : public array_exception
  {
  public:
 
    array_out_of_range(string_type file_name_, numeric_type line_number_)
      : array_exception("array:range", file_name_, line_number_)
    {
    }
  };
 
  //***************************************************************************
  //***************************************************************************
  template <typename T, size_t SIZE_>
  class array
  {
  private:
 
    typedef typename etl::parameter_type<T>::type parameter_t;
 
  public:
 
    static ETL_CONSTANT size_t SIZE = SIZE_;
 
    typedef T                                     value_type;
    typedef size_t                                size_type;
    typedef ptrdiff_t                             difference_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 ETL_OR_STD::reverse_iterator<iterator>       reverse_iterator;
    typedef ETL_OR_STD::reverse_iterator<const_iterator> const_reverse_iterator;
 
    //*************************************************************************
    // Element access
    //*************************************************************************
 
    //*************************************************************************
    //*************************************************************************
    ETL_NODISCARD
    reference at(size_t i)
    {
      ETL_ASSERT(i < SIZE, ETL_ERROR(array_out_of_range));
 
      return _buffer[i];
    }
 
    //*************************************************************************
    //*************************************************************************
    ETL_NODISCARD
#if defined(ETL_THROW_EXCEPTIONS)
    ETL_CONSTEXPR14
#else
    ETL_CONSTEXPR
#endif
    const_reference at(size_t i) const
    {
      ETL_ASSERT(i < SIZE, ETL_ERROR(array_out_of_range));
 
      return _buffer[i];
    }
 
    //*************************************************************************
    //*************************************************************************
    ETL_NODISCARD
    reference operator[](size_t i)
    {
      return _buffer[i];
    }
 
    //*************************************************************************
    //*************************************************************************
    ETL_NODISCARD
    ETL_CONSTEXPR const_reference operator[](size_t i) const
    {
      return _buffer[i];
    }
 
    //*************************************************************************
    //*************************************************************************
    ETL_NODISCARD
    reference front()
    {
      return _buffer[0];
    }
 
    //*************************************************************************
    //*************************************************************************
    ETL_NODISCARD
    ETL_CONSTEXPR const_reference front() const
    {
      return _buffer[0];
    }
 
    //*************************************************************************
    //*************************************************************************
    ETL_NODISCARD
    reference back()
    {
      return _buffer[SIZE - 1];
    }
 
    //*************************************************************************
    //*************************************************************************
    ETL_NODISCARD
    ETL_CONSTEXPR const_reference back() const
    {
      return _buffer[SIZE - 1];
    }
 
    //*************************************************************************
    //*************************************************************************
    ETL_NODISCARD
    pointer data() ETL_NOEXCEPT
    {
      return &_buffer[0];
    }
 
    //*************************************************************************
    //*************************************************************************
    ETL_NODISCARD
    ETL_CONSTEXPR const_pointer data() const ETL_NOEXCEPT
    {
      return &_buffer[0];
    }
 
    //*************************************************************************
    // Iterators
    //*************************************************************************
 
    //*************************************************************************
    //*************************************************************************
    ETL_NODISCARD
    iterator begin() ETL_NOEXCEPT
    {
      return &_buffer[0];
    }
 
    //*************************************************************************
    //*************************************************************************
    ETL_NODISCARD
    ETL_CONSTEXPR const_iterator begin() const ETL_NOEXCEPT
    {
      return &_buffer[0];
    }
 
    //*************************************************************************
    //*************************************************************************
    ETL_NODISCARD
    ETL_CONSTEXPR const_iterator cbegin() const ETL_NOEXCEPT
    {
      return begin();
    }
 
    //*************************************************************************
    //*************************************************************************
    ETL_NODISCARD
    iterator end() ETL_NOEXCEPT
    {
      return _buffer + SIZE;
    }
 
    //*************************************************************************
    //*************************************************************************
    ETL_NODISCARD
    ETL_CONSTEXPR const_iterator end() const ETL_NOEXCEPT
    {
      return _buffer + SIZE;
    }
 
    //*************************************************************************
    // Returns a const iterator to the end of the array.
    //*************************************************************************
    ETL_NODISCARD
    ETL_CONSTEXPR const_iterator cend() const ETL_NOEXCEPT
    {
      return _buffer + SIZE;
    }
 
    //*************************************************************************
    // Returns an reverse iterator to the reverse beginning of the array.
    //*************************************************************************
    ETL_NODISCARD
    reverse_iterator rbegin() ETL_NOEXCEPT
    {
      return reverse_iterator(end());
    }
 
    //*************************************************************************
    //*************************************************************************
    ETL_NODISCARD
    ETL_CONSTEXPR const_reverse_iterator rbegin() const ETL_NOEXCEPT
    {
      return const_reverse_iterator(end());
    }
 
    //*************************************************************************
    //*************************************************************************
    ETL_NODISCARD
    ETL_CONSTEXPR const_reverse_iterator crbegin() const ETL_NOEXCEPT
    {
      return const_reverse_iterator(end());
    }
 
    //*************************************************************************
    //*************************************************************************
    ETL_NODISCARD
    reverse_iterator rend() ETL_NOEXCEPT
    {
      return reverse_iterator(begin());
    }
 
    //*************************************************************************
    //*************************************************************************
    ETL_NODISCARD
    ETL_CONSTEXPR const_reverse_iterator rend() const ETL_NOEXCEPT
    {
      return const_reverse_iterator(begin());
    }
 
    //*************************************************************************
    //*************************************************************************
    ETL_NODISCARD
    ETL_CONSTEXPR const_reverse_iterator crend() const ETL_NOEXCEPT
    {
      return const_reverse_iterator(begin());
    }
 
    //*************************************************************************
    // Capacity
    //*************************************************************************
 
    //*************************************************************************
    //*************************************************************************
    ETL_NODISCARD
    ETL_CONSTEXPR bool empty() const ETL_NOEXCEPT
    {
      return (SIZE == 0);
    }
 
    //*************************************************************************
    //*************************************************************************
    ETL_NODISCARD
    ETL_CONSTEXPR size_t size() const ETL_NOEXCEPT
    {
      return SIZE;
    }
 
    //*************************************************************************
    //*************************************************************************
    ETL_NODISCARD
    ETL_CONSTEXPR size_t max_size() const ETL_NOEXCEPT
    {
      return SIZE;
    }
 
    //*************************************************************************
    // Operations
    //*************************************************************************
 
    //*************************************************************************
    //*************************************************************************
    ETL_CONSTEXPR14 void fill(parameter_t value)
    {
      etl::fill(_buffer, _buffer + SIZE, value);
    }
 
    //*************************************************************************
    //*************************************************************************
    ETL_CONSTEXPR14 void swap(array& other) ETL_NOEXCEPT
    {
      using ETL_OR_STD::swap; // Allow ADL
 
      for (size_t i = 0UL; i < SIZE; ++i)
      {
        swap(_buffer[i], other._buffer[i]);
      }
    }
 
    //*************************************************************************
    //*************************************************************************
    template <typename TIterator>
    void assign(TIterator first, const TIterator last)
    {
      etl::copy_s(first, last, begin(), end());
    }
 
    //*************************************************************************
    //*************************************************************************
    template <typename TIterator>
    void assign(TIterator first, const TIterator last, parameter_t value)
    {
      // Copy from the range.
      iterator p = etl::copy(first, last, begin());
 
      // Initialise any that are left.
      etl::fill(p, end(), value);
    }
 
    //*************************************************************************
    //*************************************************************************
    inline iterator insert_at(size_t position, parameter_t value)
    {
      return insert(begin() + position, value);
    }
 
    //*************************************************************************
    //*************************************************************************
    iterator insert(const_iterator position, parameter_t value)
    {
      iterator p = to_iterator(position);
 
      etl::move_backward(p, end() - 1, end());
      *p = value;
 
      return p;
    }
 
    //*************************************************************************
    //*************************************************************************
    template <typename TIterator>
    inline iterator insert_at(size_t position, TIterator first, const TIterator last)
    {
      return insert(begin() + position, first, last);
    }
 
    //*************************************************************************
    //*************************************************************************
    template <typename TIterator>
    iterator insert(const_iterator position, TIterator first, const TIterator last)
    {
      iterator p = to_iterator(position);
      iterator result(p);
 
      size_t source_size       = etl::distance(first, last);
      size_t destination_space = etl::distance(position, cend());
 
      // Do we need to move anything?
      if (source_size < destination_space)
      {
        size_t length = SIZE - (etl::distance(begin(), p) + source_size);
        etl::move_backward(p, p + length, end());
      }
 
      // Copy from the range.
      etl::copy_s(first, last, p, end());
 
      return result;
    }
 
    //*************************************************************************
    //*************************************************************************
    inline iterator erase_at(size_t position)
    {
      return erase(begin() + position);
    }
 
    //*************************************************************************
    //*************************************************************************
    iterator erase(const_iterator position)
    {
      iterator p = to_iterator(position);
      etl::move(p + 1, end(), p);
 
      return p;
    }
 
    //*************************************************************************
    //*************************************************************************
    iterator erase_range(size_t first, size_t last)
    {
      return erase(begin() + first, begin() + last);
    }
 
    //*************************************************************************
    //*************************************************************************
    iterator erase(const_iterator first, const_iterator last)
    {
      iterator p = to_iterator(first);
      etl::move(last, cend(), p);
      return p;
    }
 
    //*************************************************************************
    //*************************************************************************
    inline iterator erase_at(size_t position, parameter_t value)
    {
      return erase(begin() + position, value);
    }
 
    //*************************************************************************
    //*************************************************************************
    iterator erase(const_iterator position, parameter_t value)
    {
      iterator p = to_iterator(position);
 
      etl::move(p + 1, end(), p);
      back() = value;
 
      return p;
    }
 
    //*************************************************************************
    //*************************************************************************
    iterator erase_range(size_t first, size_t last, parameter_t value)
    {
      return erase(begin() + first, begin() + last, value);
    }
 
    //*************************************************************************
    //*************************************************************************
    iterator erase(const_iterator first, const_iterator last, parameter_t value)
    {
      iterator p = to_iterator(first);
 
      p = etl::move(last, cend(), p);
      etl::fill(p, end(), value);
 
      return to_iterator(first);
    }
 
    T _buffer[SIZE];
 
  private:
 
    //*************************************************************************
    //*************************************************************************
    iterator to_iterator(const_iterator itr) const
    {
      return const_cast<iterator>(itr);
    }
  };
 
  template <typename T, size_t SIZE_>
  ETL_CONSTANT size_t array<T, SIZE_>::SIZE;
 
  //*************************************************************************
  //*************************************************************************
#if ETL_USING_CPP17
  template <typename... T>
  array(T...) -> array<typename etl::common_type<T...>::type, sizeof...(T)>;
#endif  
 
  //*************************************************************************
  //*************************************************************************
#if ETL_HAS_INITIALIZER_LIST
  template <typename T, typename... TValues>
  constexpr auto make_array(TValues&&... values) -> etl::array<T, sizeof...(TValues)>
  {
    return { { etl::forward<T>(values)... } };
  }
#endif
 
  //*************************************************************************
  //*************************************************************************
  template <typename T, const size_t SIZE>
  void swap(etl::array<T, SIZE> &lhs, etl::array<T, SIZE> &rhs)
  {
    lhs.swap(rhs);
  }
 
  //*************************************************************************
  //*************************************************************************
  template <typename T, size_t SIZE>
  bool operator ==(const etl::array<T, SIZE>& lhs, const etl::array<T, SIZE>& rhs)
  {
    return etl::equal(lhs.cbegin(), lhs.cend(), rhs.cbegin());
  }
 
  //*************************************************************************
  //*************************************************************************
  template <typename T, size_t SIZE>
  bool operator !=(const etl::array<T, SIZE>& lhs, const etl::array<T, SIZE>& rhs)
  {
    return !(lhs == rhs);
  }
 
  //*************************************************************************
  //*************************************************************************
  template <typename T, size_t SIZE>
  bool operator <(const etl::array<T, SIZE>& lhs, const etl::array<T, SIZE>& rhs)
  {
    return etl::lexicographical_compare(lhs.cbegin(),
                                        lhs.cend(),
                                        rhs.cbegin(),
                                        rhs.cend());
  }
 
  //*************************************************************************
  //*************************************************************************
  template <typename T, size_t SIZE>
  bool operator <=(const etl::array<T, SIZE>& lhs, const etl::array<T, SIZE>& rhs)
  {
    return !(lhs > rhs);
  }
 
  //*************************************************************************
  template <typename T, size_t SIZE>
  //*************************************************************************
  bool operator >(const etl::array<T, SIZE>& lhs, const etl::array<T, SIZE>& rhs)
  {
    return (rhs < lhs);
  }
 
  //*************************************************************************
  //*************************************************************************
  template <typename T, size_t SIZE>
  bool operator >=(const etl::array<T, SIZE>& lhs, const etl::array<T, SIZE>& rhs)
  {
    return !(lhs < rhs);
  }
 
  //*************************************************************************
  //*************************************************************************
  template <size_t I, typename T, size_t MAXN>
  inline T& get(array<T, MAXN>& a)
  {
    ETL_STATIC_ASSERT(I < MAXN, "Index out of bounds");
    return a[I];
  }
 
  //*************************************************************************
  //*************************************************************************
  template <size_t I, typename T, size_t MAXN>
  inline const T& get(const array<T, MAXN>& a)
  {
    ETL_STATIC_ASSERT(I < MAXN, "Index out of bounds");
    return a[I];
  }
}
 
#endif