array.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_ARRAY__
#define __ETL_ARRAY__

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

#include "exception.h"
#include "type_traits.h"
#include "parameter_type.h"
#include "static_assert.h"

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


namespace etl
{
  //***************************************************************************
  //***************************************************************************
  class array_exception : public exception
  {
  public:

    array_exception(const char* what)
      : exception(what)
    {
    }
  };

  //***************************************************************************
  //***************************************************************************
  class array_out_of_range : public array_exception
  {
  public:

    array_out_of_range()
      : array_exception("array: out of range")
    {
    }
  };

    //***************************************************************************
    //***************************************************************************
  template <typename T, const size_t SIZE>
  class array
    {
  private:

    typedef typename parameter_type<T>::type parameter_t;

    public:

    typedef T                                     value_type;
    typedef std::size_t                           size_type;
    typedef std::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 std::reverse_iterator<iterator>       reverse_iterator;
        typedef std::reverse_iterator<const_iterator> const_reverse_iterator;

    //*************************************************************************
    // Element access
    //*************************************************************************

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

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

      return _buffer[i];
    }

    //*************************************************************************
    //*************************************************************************
    const_reference at(size_t i) const
    {
      if (i >= SIZE)
      {
#ifdef ETL_THROW_EXCEPTIONS
        throw array_out_of_range();
#else
        error_handler::error(array_out_of_range());
#endif
      }

      return _buffer[i];
    }

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

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

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

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

    //*************************************************************************
    //*************************************************************************
    reference back()
    {
      return _buffer[SIZE - 1];
    }

    //*************************************************************************
    //*************************************************************************
    const_reference back() const
    {
      return _buffer[SIZE - 1];
    }

    //*************************************************************************
    //*************************************************************************
    pointer data()
    {
      return &_buffer[0];
    }

    //*************************************************************************
    //*************************************************************************
    const_pointer data() const
    {
      return &_buffer[0];
    }

    //*************************************************************************
    // Iterators
    //*************************************************************************

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

        //*************************************************************************
        //*************************************************************************
        const_iterator cbegin() const
        {
            return begin();
        } 

    //*************************************************************************
    //*************************************************************************
    iterator end()
    {
      return &_buffer[SIZE];
    }

    //*************************************************************************
    //*************************************************************************
    const_iterator end() const
    {
      return &_buffer[SIZE];
    }

    //*************************************************************************
    // Returns a const iterator to the end of the array.
    //*************************************************************************
    const_iterator cend() const
    {
      return &_buffer[SIZE];
    }

        //*************************************************************************
        // Returns an reverse iterator to the reverse beginning of the array.
        //*************************************************************************
        reverse_iterator rbegin()
        {
            return reverse_iterator(end());
        }
    
        //*************************************************************************
        //*************************************************************************
        const_reverse_iterator rbegin() const
        {
            return const_reverse_iterator(end());
        }        

        //*************************************************************************
        //*************************************************************************
        const_reverse_iterator crbegin() 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 crend() const
        {
            return const_reverse_iterator(begin());
        } 

    //*************************************************************************
    // Capacity
    //*************************************************************************

    //*************************************************************************
    //*************************************************************************
    bool empty() const
    {
      return (SIZE == 0);
    }

        //*************************************************************************
        //*************************************************************************
        size_t size() const
        {
            return SIZE;
        }

        //*************************************************************************
        //*************************************************************************
        size_t max_size() const
        {
            return SIZE;
        } 

    //*************************************************************************
    // Operations
    //*************************************************************************

    //*************************************************************************
    //*************************************************************************
    void fill(parameter_t value)
    {
      std::fill(begin(), end(), value);
    }

    //*************************************************************************
    //*************************************************************************
    void swap(array& other)
    {
      for (size_t i = 0; i < SIZE; ++i)
      {
        std::swap(_buffer[i], other._buffer[i]);
      }
    }

    T _buffer[SIZE];
  };

  //*************************************************************************
    //*************************************************************************
  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, std::size_t SIZE>
  bool operator ==(const etl::array<T, SIZE>& lhs, const etl::array<T, SIZE>& rhs)
  {
    return std::equal(lhs.cbegin(), lhs.cend(), rhs.cbegin());
  }

  //*************************************************************************
  //*************************************************************************
  template <typename T, std::size_t SIZE>
  bool operator !=(const etl::array<T, SIZE>& lhs, const etl::array<T, SIZE>& rhs)
  {
    return !(lhs == rhs);
  }
  
  //*************************************************************************
  //*************************************************************************
  template <typename T, std::size_t SIZE>
  bool operator <(const etl::array<T, SIZE>& lhs, const etl::array<T, SIZE>& rhs)
  {
    return std::lexicographical_compare(lhs.cbegin(),
                                        lhs.cend(), 
                                        rhs.cbegin(), 
                                        rhs.cend());
  }

  //*************************************************************************
  //*************************************************************************
  template <typename T, std::size_t SIZE>
  bool operator <=(const etl::array<T, SIZE>& lhs, const etl::array<T, SIZE>& rhs)
  {
    return !std::lexicographical_compare(lhs.cbegin(),
                                         lhs.cend(), 
                                         rhs.cbegin(),
                                         rhs.cend(),
                                         std::greater<T>());
  }

  //*************************************************************************
  template <typename T, std::size_t SIZE>
  //*************************************************************************
  bool operator >(const etl::array<T, SIZE>& lhs, const etl::array<T, SIZE>& rhs)
  {
    return std::lexicographical_compare(lhs.cbegin(),
                                        lhs.cend(), 
                                        rhs.cbegin(), 
                                        rhs.cend(),
                                        std::greater<T>());
  }

  //*************************************************************************
  //*************************************************************************
  template <typename T, std::size_t SIZE>
  bool operator >=(const etl::array<T, SIZE>& lhs, const etl::array<T, SIZE>& rhs)
  {
    return !std::lexicographical_compare(lhs.cbegin(), 
                                         lhs.cend(), 
                                         rhs.cbegin(),
                                         rhs.cend());
  }

  //*************************************************************************
  //*************************************************************************
  template <std::size_t I, typename T, std::size_t N>
  inline T& get(array<T, N>& a)
  {
    STATIC_ASSERT(I < N, "Index out of bounds");
    return a[I];
  }

  //*************************************************************************
  //*************************************************************************
  template <std::size_t I, typename T, std::size_t N>
  inline const T& get(const array<T, N>& a)
  {
    STATIC_ASSERT(I < N, "Index out of bounds");
    return a[I];
  }
}

#endif