1 /* The following code declares class array,
2 * an STL container (as wrapper) for arrays of constant size.
5 * http://www.boost.org/libs/array/
8 * The original author site is at: http://www.josuttis.com/
10 * (C) Copyright Nicolai M. Josuttis 2001.
12 * Distributed under the Boost Software License, Version 1.0. (See
13 * accompanying file LICENSE_1_0.txt or copy at
14 * http://www.boost.org/LICENSE_1_0.txt)
16 * 29 Jan 2004 - c_array() added, BOOST_NO_PRIVATE_IN_AGGREGATE removed (Nico Josuttis)
17 * 23 Aug 2002 - fix for Non-MSVC compilers combined with MSVC libraries.
18 * 05 Aug 2001 - minor update (Nico Josuttis)
19 * 20 Jan 2001 - STLport fix (Beman Dawes)
20 * 29 Sep 2000 - Initial Revision (Nico Josuttis)
24 #ifndef BOOST_ARRAY_HPP
25 #define BOOST_ARRAY_HPP
29 #include <boost/assert.hpp>
30 #include <boost/swap.hpp>
32 // Handles broken standard libraries better than <iterator>
33 #include <boost/detail/iterator.hpp>
34 #include <boost/throw_exception.hpp>
37 // FIXES for broken compilers
38 #include <boost/config.hpp>
43 template<class T, std::size_t N>
46 T elems[N]; // fixed-size array of elements of type T
52 typedef const T* const_iterator;
54 typedef const T& const_reference;
55 typedef std::size_t size_type;
56 typedef std::ptrdiff_t difference_type;
59 iterator begin() { return elems; }
60 const_iterator begin() const { return elems; }
61 iterator end() { return elems+N; }
62 const_iterator end() const { return elems+N; }
64 // reverse iterator support
65 #if !defined(BOOST_NO_TEMPLATE_PARTIAL_SPECIALIZATION) && !defined(BOOST_MSVC_STD_ITERATOR) && !defined(BOOST_NO_STD_ITERATOR_TRAITS)
66 typedef std::reverse_iterator<iterator> reverse_iterator;
67 typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
68 #elif defined(_MSC_VER) && (_MSC_VER == 1300) && defined(BOOST_DINKUMWARE_STDLIB) && (BOOST_DINKUMWARE_STDLIB == 310)
69 // workaround for broken reverse_iterator in VC7
70 typedef std::reverse_iterator<std::_Ptrit<value_type, difference_type, iterator,
71 reference, iterator, reference> > reverse_iterator;
72 typedef std::reverse_iterator<std::_Ptrit<value_type, difference_type, const_iterator,
73 const_reference, iterator, reference> > const_reverse_iterator;
75 // workaround for broken reverse_iterator implementations
76 typedef std::reverse_iterator<iterator,T> reverse_iterator;
77 typedef std::reverse_iterator<const_iterator,T> const_reverse_iterator;
80 reverse_iterator rbegin() { return reverse_iterator(end()); }
81 const_reverse_iterator rbegin() const {
82 return const_reverse_iterator(end());
84 reverse_iterator rend() { return reverse_iterator(begin()); }
85 const_reverse_iterator rend() const {
86 return const_reverse_iterator(begin());
90 reference operator[](size_type i)
92 BOOST_ASSERT( i < N && "out of range" );
96 const_reference operator[](size_type i) const
98 BOOST_ASSERT( i < N && "out of range" );
102 // at() with range check
103 reference at(size_type i) { rangecheck(i); return elems[i]; }
104 const_reference at(size_type i) const { rangecheck(i); return elems[i]; }
106 // front() and back()
112 const_reference front() const
122 const_reference back() const
128 static size_type size() { return N; }
129 static bool empty() { return false; }
130 static size_type max_size() { return N; }
131 enum { static_size = N };
133 // swap (note: linear complexity)
134 void swap (array<T,N>& y) {
135 for (size_type i = 0; i < N; ++i)
136 boost::swap(elems[i],y.elems[i]);
139 // direct access to data (read-only)
140 const T* data() const { return elems; }
141 T* data() { return elems; }
143 // use array as C array (direct read/write access to data)
144 T* c_array() { return elems; }
146 // assignment with type conversion
147 template <typename T2>
148 array<T,N>& operator= (const array<T2,N>& rhs) {
149 std::copy(rhs.begin(),rhs.end(), begin());
153 // assign one value to all elements
154 void assign (const T& value)
156 std::fill_n(begin(),size(),value);
159 // check range (may be private because it is static)
160 static void rangecheck (size_type i) {
162 throw std::out_of_range("array<>: index out of range");
168 #if !defined(BOOST_NO_TEMPLATE_PARTIAL_SPECIALIZATION)
170 class array< T, 0 > {
174 typedef T value_type;
176 typedef const T* const_iterator;
177 typedef T& reference;
178 typedef const T& const_reference;
179 typedef std::size_t size_type;
180 typedef std::ptrdiff_t difference_type;
183 iterator begin() { return iterator( reinterpret_cast< T * >( this ) ); }
184 const_iterator begin() const { return const_iterator( reinterpret_cast< const T * >( this ) ); }
185 iterator end() { return begin(); }
186 const_iterator end() const { return begin(); }
188 // reverse iterator support
189 #if !defined(BOOST_NO_TEMPLATE_PARTIAL_SPECIALIZATION) && !defined(BOOST_MSVC_STD_ITERATOR) && !defined(BOOST_NO_STD_ITERATOR_TRAITS)
190 typedef std::reverse_iterator<iterator> reverse_iterator;
191 typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
192 #elif defined(_MSC_VER) && (_MSC_VER == 1300) && defined(BOOST_DINKUMWARE_STDLIB) && (BOOST_DINKUMWARE_STDLIB == 310)
193 // workaround for broken reverse_iterator in VC7
194 typedef std::reverse_iterator<std::_Ptrit<value_type, difference_type, iterator,
195 reference, iterator, reference> > reverse_iterator;
196 typedef std::reverse_iterator<std::_Ptrit<value_type, difference_type, const_iterator,
197 const_reference, iterator, reference> > const_reverse_iterator;
199 // workaround for broken reverse_iterator implementations
200 typedef std::reverse_iterator<iterator,T> reverse_iterator;
201 typedef std::reverse_iterator<const_iterator,T> const_reverse_iterator;
204 reverse_iterator rbegin() { return reverse_iterator(end()); }
205 const_reverse_iterator rbegin() const {
206 return const_reverse_iterator(end());
208 reverse_iterator rend() { return reverse_iterator(begin()); }
209 const_reverse_iterator rend() const {
210 return const_reverse_iterator(begin());
214 reference operator[](size_type /*i*/)
216 return failed_rangecheck();
219 const_reference operator[](size_type /*i*/) const
221 return failed_rangecheck();
224 // at() with range check
225 reference at(size_type /*i*/) { return failed_rangecheck(); }
226 const_reference at(size_type /*i*/) const { return failed_rangecheck(); }
228 // front() and back()
231 return failed_rangecheck();
234 const_reference front() const
236 return failed_rangecheck();
241 return failed_rangecheck();
244 const_reference back() const
246 return failed_rangecheck();
250 static size_type size() { return 0; }
251 static bool empty() { return true; }
252 static size_type max_size() { return 0; }
253 enum { static_size = 0 };
255 void swap (array<T,0>& /*y*/) {
258 // direct access to data (read-only)
259 const T* data() const { return 0; }
260 T* data() { return 0; }
262 // use array as C array (direct read/write access to data)
263 T* c_array() { return 0; }
265 // assignment with type conversion
266 template <typename T2>
267 array<T,0>& operator= (const array<T2,0>& ) {
271 // assign one value to all elements
272 void assign (const T& ) { }
274 // check range (may be private because it is static)
275 static reference failed_rangecheck () {
276 std::out_of_range e("attempt to access element of an empty array");
277 boost::throw_exception(e);
279 // We need to return something here to keep
280 // some compilers happy: however we will never
281 // actually get here....
283 static T placeholder;
290 template<class T, std::size_t N>
291 bool operator== (const array<T,N>& x, const array<T,N>& y) {
292 return std::equal(x.begin(), x.end(), y.begin());
294 template<class T, std::size_t N>
295 bool operator< (const array<T,N>& x, const array<T,N>& y) {
296 return std::lexicographical_compare(x.begin(),x.end(),y.begin(),y.end());
298 template<class T, std::size_t N>
299 bool operator!= (const array<T,N>& x, const array<T,N>& y) {
302 template<class T, std::size_t N>
303 bool operator> (const array<T,N>& x, const array<T,N>& y) {
306 template<class T, std::size_t N>
307 bool operator<= (const array<T,N>& x, const array<T,N>& y) {
310 template<class T, std::size_t N>
311 bool operator>= (const array<T,N>& x, const array<T,N>& y) {
316 template<class T, std::size_t N>
317 inline void swap (array<T,N>& x, array<T,N>& y) {
321 } /* namespace boost */
323 #endif /*BOOST_ARRAY_HPP*/