3 // Copyright (C) 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
5 // This file is part of the GNU ISO C++ Library. This library is free
6 // software; you can redistribute it and/or modify it under the
7 // terms of the GNU General Public License as published by the
8 // Free Software Foundation; either version 3, or (at your option)
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 // GNU General Public License for more details.
16 // Under Section 7 of GPL version 3, you are granted additional
17 // permissions described in the GCC Runtime Library Exception, version
18 // 3.1, as published by the Free Software Foundation.
20 // You should have received a copy of the GNU General Public License and
21 // a copy of the GCC Runtime Library Exception along with this program;
22 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
23 // <http://www.gnu.org/licenses/>.
25 /** @file include/array
26 * This is a Standard C++ Library header.
29 #ifndef _GLIBCXX_ARRAY
30 #define _GLIBCXX_ARRAY 1
32 #pragma GCC system_header
34 #ifndef __GXX_EXPERIMENTAL_CXX0X__
35 # include <bits/c++0x_warning.h>
38 #include <bits/stl_algobase.h>
39 #include <bits/range_access.h>
41 namespace std _GLIBCXX_VISIBILITY(default)
43 _GLIBCXX_BEGIN_NAMESPACE_VERSION
46 * @brief A standard container for storing a fixed size sequence of elements.
50 * Meets the requirements of a <a href="tables.html#65">container</a>, a
51 * <a href="tables.html#66">reversible container</a>, and a
52 * <a href="tables.html#67">sequence</a>.
54 * Sets support random access iterators.
56 * @param Tp Type of element. Required to be a complete type.
57 * @param N Number of elements.
59 template<typename _Tp, std::size_t _Nm>
62 typedef _Tp value_type;
64 typedef const _Tp* const_pointer;
65 typedef value_type& reference;
66 typedef const value_type& const_reference;
67 typedef value_type* iterator;
68 typedef const value_type* const_iterator;
69 typedef std::size_t size_type;
70 typedef std::ptrdiff_t difference_type;
71 typedef std::reverse_iterator<iterator> reverse_iterator;
72 typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
74 // Support for zero-sized arrays mandatory.
75 value_type _M_instance[_Nm ? _Nm : 1];
77 // No explicit construct/copy/destroy for aggregate type.
81 fill(const value_type& __u)
82 { std::fill_n(begin(), size(), __u); }
86 { std::swap_ranges(begin(), end(), __other.begin()); }
91 { return iterator(std::__addressof(_M_instance[0])); }
95 { return const_iterator(std::__addressof(_M_instance[0])); }
99 { return iterator(std::__addressof(_M_instance[_Nm])); }
103 { return const_iterator(std::__addressof(_M_instance[_Nm])); }
107 { return reverse_iterator(end()); }
109 const_reverse_iterator
111 { return const_reverse_iterator(end()); }
115 { return reverse_iterator(begin()); }
117 const_reverse_iterator
119 { return const_reverse_iterator(begin()); }
123 { return const_iterator(std::__addressof(_M_instance[0])); }
127 { return const_iterator(std::__addressof(_M_instance[_Nm])); }
129 const_reverse_iterator
131 { return const_reverse_iterator(end()); }
133 const_reverse_iterator
135 { return const_reverse_iterator(begin()); }
139 size() const { return _Nm; }
142 max_size() const { return _Nm; }
145 empty() const { return size() == 0; }
149 operator[](size_type __n)
150 { return _M_instance[__n]; }
153 operator[](size_type __n) const
154 { return _M_instance[__n]; }
160 std::__throw_out_of_range(__N("array::at"));
161 return _M_instance[__n];
165 at(size_type __n) const
168 std::__throw_out_of_range(__N("array::at"));
169 return _M_instance[__n];
182 { return _Nm ? *(end() - 1) : *end(); }
186 { return _Nm ? *(end() - 1) : *end(); }
190 { return std::__addressof(_M_instance[0]); }
194 { return std::__addressof(_M_instance[0]); }
197 // Array comparisons.
198 template<typename _Tp, std::size_t _Nm>
200 operator==(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
201 { return std::equal(__one.begin(), __one.end(), __two.begin()); }
203 template<typename _Tp, std::size_t _Nm>
205 operator!=(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
206 { return !(__one == __two); }
208 template<typename _Tp, std::size_t _Nm>
210 operator<(const array<_Tp, _Nm>& __a, const array<_Tp, _Nm>& __b)
212 return std::lexicographical_compare(__a.begin(), __a.end(),
213 __b.begin(), __b.end());
216 template<typename _Tp, std::size_t _Nm>
218 operator>(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
219 { return __two < __one; }
221 template<typename _Tp, std::size_t _Nm>
223 operator<=(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
224 { return !(__one > __two); }
226 template<typename _Tp, std::size_t _Nm>
228 operator>=(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
229 { return !(__one < __two); }
231 // Specialized algorithms [6.2.2.2].
232 template<typename _Tp, std::size_t _Nm>
234 swap(array<_Tp, _Nm>& __one, array<_Tp, _Nm>& __two)
235 { __one.swap(__two); }
237 // Tuple interface to class template array [6.2.2.5].
240 template<typename _Tp>
244 template<std::size_t _Int, typename _Tp>
247 template<typename _Tp, std::size_t _Nm>
248 struct tuple_size<array<_Tp, _Nm> >
249 { static const std::size_t value = _Nm; };
251 template<typename _Tp, std::size_t _Nm>
253 tuple_size<array<_Tp, _Nm> >::value;
255 template<std::size_t _Int, typename _Tp, std::size_t _Nm>
256 struct tuple_element<_Int, array<_Tp, _Nm> >
257 { typedef _Tp type; };
259 template<std::size_t _Int, typename _Tp, std::size_t _Nm>
261 get(array<_Tp, _Nm>& __arr)
262 { return __arr[_Int]; }
264 template<std::size_t _Int, typename _Tp, std::size_t _Nm>
266 get(const array<_Tp, _Nm>& __arr)
267 { return __arr[_Int]; }
269 _GLIBCXX_END_NAMESPACE_VERSION
272 #endif // __GXX_EXPERIMENTAL_CXX0X__
274 #endif // _GLIBCXX_ARRAY