stdarray_bits.h

Go to the documentation of this file.

#ifndef MADNESS_STDARRAY_BITS_H
#define MADNESS_STDARRAY_BITS_H

#include <stdexcept>

namespace madness {
    namespace tr1 {
        namespace array {
            template <typename T, std::size_t N>
            class array {
              public:
                T elems[N];    // fixed-size array of elements of type T

              public:
                // type definitions
                typedef T              value_type;
                typedef T*             iterator;
                typedef const T*       const_iterator;
                typedef T&             reference;
                typedef const T&       const_reference;
                typedef std::size_t    size_type;
                typedef std::ptrdiff_t difference_type;

                // iterator support
                iterator begin() { return elems; }
                const_iterator begin() const { return elems; }
                iterator end() { return elems+N; }
                const_iterator end() const { return elems+N; }

                // reverse iterator support
                typedef std::reverse_iterator<iterator> reverse_iterator;
                typedef std::reverse_iterator<const_iterator> const_reverse_iterator;

                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());
                }

                // operator[]
                reference operator[](size_type i) { return elems[i]; }
                const_reference operator[](size_type i) const { return elems[i]; }

                // at() with range check
                reference at(size_type i) { rangecheck(i); return elems[i]; }
                const_reference at(size_type i) const { rangecheck(i); return elems[i]; }

                // front() and back()
                reference front() { return elems[0]; }
                const_reference front() const { return elems[0]; }
                reference back() { return elems[N-1]; }
                const_reference back() const { return elems[N-1]; }

                // size is constant
                static size_type size() { return N; }
                static bool empty() { return false; }
                static size_type max_size() { return N; }
                enum { static_size = N };

                // swap (note: linear complexity in N, constant for given instantiation)
                void swap (array<T,N>& y) {
                    std::swap_ranges(begin(),end(),y.begin());
                }

                // direct access to data (read-only)
                const T* data() const { return elems; }

                // use array as C array (direct read/write access to data)
                T* data() { return elems; }

                // assignment with type conversion
                template <typename T2>
                array<T,N>& operator= (const array<T2,N>& rhs) {
                    std::copy(rhs.begin(),rhs.end(), begin());
                    return *this;
                }

                // assign one value to all elements
                void assign (const T& value)
                {
                    std::fill_n(begin(),size(),value);
                }

              private:
                // check range (may be private because it is static)
                static void rangecheck (size_type i) {
                    if (i >= size()) {
                        throw std::out_of_range("array<>: index out of range");
                    }
                }
            };

            template <typename T>
            class array<T,0> {
              public:
                char c;  // to ensure different array intances return unique values for begin/end

              public:
                // type definitions
                typedef T              value_type;
                typedef T*             iterator;
                typedef const T*       const_iterator;
                typedef T&             reference;
                typedef const T&       const_reference;
                typedef std::size_t    size_type;
                typedef std::ptrdiff_t difference_type;

                // iterator support
                iterator begin() { return reinterpret_cast< iterator >( &c ); }
                const_iterator begin() const { return reinterpret_cast< const_iterator >( &c ); }
                iterator end() { return reinterpret_cast< iterator >( &c ); }
                const_iterator end() const { return reinterpret_cast< const_iterator >( &c ); }

                // reverse iterator support
                typedef std::reverse_iterator<iterator> reverse_iterator;
                typedef std::reverse_iterator<const_iterator> const_reverse_iterator;

                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());
                }

                // at() with range check
                reference at(size_type i) {
                    makes_no_sense();
                }
                const_reference at(size_type i) const {
                    makes_no_sense();
                }

                // size is constant
                static size_type size() { return 0; }
                static bool empty() { return true; }
                static size_type max_size() { return 0; }
                enum { static_size = 0 };

                // swap
                void swap (array<T,0>& y) {
                    //  could swap value of c, but value is not part of documented array state
                }

                // direct access to data
                const T* data() const { return NULL; }
                T* data() { return NULL; }

                // assignment with type conversion
                template < typename T2 >
                array< T,0 >& operator= (const array< T2, 0>& rhs) {
                    return *this;
                }

                //  Calling these operations are undefined behaviour for 0-size arrays,
                //  but Library TR1 requires their presence.
                // operator[]
                reference operator[](size_type i) { makes_no_sense(); }
                const_reference operator[](size_type i) const { makes_no_sense(); }

                // front() and back()
                reference front() { makes_no_sense(); }
                const_reference front() const { makes_no_sense(); }
                reference back() { makes_no_sense(); }
                const_reference back() const { makes_no_sense(); }

              private:
                // helper for operations that have undefined behaviour for 0-size arrays,
                //  assert( false ); added to make lack of support clear
                static void makes_no_sense () {
                    //assert(true);
                    throw std::out_of_range("array<0>: index out of range");
                }
            };

            // comparisons
            template<class T, std::size_t N>
            bool operator== (const array<T,N>& x, const array<T,N>& y) {
                return std::equal(x.begin(), x.end(), y.begin());
            }
            template<class T, std::size_t N>
            bool operator< (const array<T,N>& x, const array<T,N>& y) {
                return std::lexicographical_compare(x.begin(),x.end(),y.begin(),y.end());
            }
            template<class T, std::size_t N>
            bool operator!= (const array<T,N>& x, const array<T,N>& y) {
                return !(x==y);
            }
            template<class T, std::size_t N>
            bool operator> (const array<T,N>& x, const array<T,N>& y) {
                return y<x;
            }
            template<class T, std::size_t N>
            bool operator<= (const array<T,N>& x, const array<T,N>& y) {
                return !(y<x);
            }
            template<class T, std::size_t N>
            bool operator>= (const array<T,N>& x, const array<T,N>& y) {
                return !(x<y);
            }

            // global swap()
            template<class T, std::size_t N>
            inline void swap (array<T,N>& x, array<T,N>& y) {
                x.swap(y);
            }
        }
    }
}

#endif