1 // class template array -*- C++ -*-
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 tr1_impl/array
26 * This is an internal header file, included by other library headers.
27 * You should not attempt to use it directly.
32 _GLIBCXX_BEGIN_NAMESPACE_TR1
35 * @brief A standard container for storing a fixed size sequence of elements.
39 * Meets the requirements of a <a href="tables.html#65">container</a>, a
40 * <a href="tables.html#66">reversible container</a>, and a
41 * <a href="tables.html#67">sequence</a>.
43 * Sets support random access iterators.
45 * @param Tp Type of element. Required to be a complete type.
46 * @param N Number of elements.
48 template<typename _Tp, std::size_t _Nm>
51 typedef _Tp value_type;
52 #ifdef _GLIBCXX_INCLUDE_AS_CXX0X
54 typedef const _Tp* const_pointer;
56 typedef value_type& reference;
57 typedef const value_type& const_reference;
58 typedef value_type* iterator;
59 typedef const value_type* const_iterator;
60 typedef std::size_t size_type;
61 typedef std::ptrdiff_t difference_type;
62 typedef std::reverse_iterator<iterator> reverse_iterator;
63 typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
65 // Support for zero-sized arrays mandatory.
66 value_type _M_instance[_Nm ? _Nm : 1];
68 // No explicit construct/copy/destroy for aggregate type.
71 #ifdef _GLIBCXX_INCLUDE_AS_CXX0X
73 fill(const value_type& __u)
75 assign(const value_type& __u)
77 { std::fill_n(begin(), size(), __u); }
81 { std::swap_ranges(begin(), end(), __other.begin()); }
86 { return iterator(std::__addressof(_M_instance[0])); }
90 { return const_iterator(std::__addressof(_M_instance[0])); }
94 { return iterator(std::__addressof(_M_instance[_Nm])); }
98 { return const_iterator(std::__addressof(_M_instance[_Nm])); }
102 { return reverse_iterator(end()); }
104 const_reverse_iterator
106 { return const_reverse_iterator(end()); }
110 { return reverse_iterator(begin()); }
112 const_reverse_iterator
114 { return const_reverse_iterator(begin()); }
116 #ifdef _GLIBCXX_INCLUDE_AS_CXX0X
119 { return const_iterator(std::__addressof(_M_instance[0])); }
123 { return const_iterator(std::__addressof(_M_instance[_Nm])); }
125 const_reverse_iterator
127 { return const_reverse_iterator(end()); }
129 const_reverse_iterator
131 { return const_reverse_iterator(begin()); }
135 _GLIBCXX_CONSTEXPR size_type
136 size() const { return _Nm; }
138 _GLIBCXX_CONSTEXPR size_type
139 max_size() const { return _Nm; }
141 _GLIBCXX_CONSTEXPR bool
142 empty() const { return size() == 0; }
146 operator[](size_type __n)
147 { return _M_instance[__n]; }
150 operator[](size_type __n) const
151 { return _M_instance[__n]; }
157 std::__throw_out_of_range(__N("array::at"));
158 return _M_instance[__n];
162 at(size_type __n) const
165 std::__throw_out_of_range(__N("array::at"));
166 return _M_instance[__n];
179 { return _Nm ? *(end() - 1) : *end(); }
183 { return _Nm ? *(end() - 1) : *end(); }
187 { return std::__addressof(_M_instance[0]); }
191 { return std::__addressof(_M_instance[0]); }
194 // Array comparisons.
195 template<typename _Tp, std::size_t _Nm>
197 operator==(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
198 { return std::equal(__one.begin(), __one.end(), __two.begin()); }
200 template<typename _Tp, std::size_t _Nm>
202 operator!=(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
203 { return !(__one == __two); }
205 template<typename _Tp, std::size_t _Nm>
207 operator<(const array<_Tp, _Nm>& __a, const array<_Tp, _Nm>& __b)
209 return std::lexicographical_compare(__a.begin(), __a.end(),
210 __b.begin(), __b.end());
213 template<typename _Tp, std::size_t _Nm>
215 operator>(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
216 { return __two < __one; }
218 template<typename _Tp, std::size_t _Nm>
220 operator<=(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
221 { return !(__one > __two); }
223 template<typename _Tp, std::size_t _Nm>
225 operator>=(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
226 { return !(__one < __two); }
228 // Specialized algorithms [6.2.2.2].
229 template<typename _Tp, std::size_t _Nm>
231 swap(array<_Tp, _Nm>& __one, array<_Tp, _Nm>& __two)
232 { __one.swap(__two); }
234 // Tuple interface to class template array [6.2.2.5].
237 template<typename _Tp>
241 #ifdef _GLIBCXX_INCLUDE_AS_CXX0X
242 template<std::size_t _Int, typename _Tp>
244 template<int _Int, typename _Tp>
248 template<typename _Tp, std::size_t _Nm>
249 struct tuple_size<array<_Tp, _Nm> >
250 #ifdef _GLIBCXX_INCLUDE_AS_CXX0X
251 { static const std::size_t value = _Nm; };
253 { static const int value = _Nm; };
256 template<typename _Tp, std::size_t _Nm>
257 #ifdef _GLIBCXX_INCLUDE_AS_CXX0X
262 tuple_size<array<_Tp, _Nm> >::value;
264 #ifdef _GLIBCXX_INCLUDE_AS_CXX0X
265 template<std::size_t _Int, typename _Tp, std::size_t _Nm>
267 template<int _Int, typename _Tp, std::size_t _Nm>
269 struct tuple_element<_Int, array<_Tp, _Nm> >
270 { typedef _Tp type; };
272 #ifdef _GLIBCXX_INCLUDE_AS_CXX0X
273 template<std::size_t _Int, typename _Tp, std::size_t _Nm>
275 template<int _Int, typename _Tp, std::size_t _Nm>
278 get(array<_Tp, _Nm>& __arr)
279 { return __arr[_Int]; }
281 #ifdef _GLIBCXX_INCLUDE_AS_CXX0X
282 template<std::size_t _Int, typename _Tp, std::size_t _Nm>
284 template<int _Int, typename _Tp, std::size_t _Nm>
287 get(const array<_Tp, _Nm>& __arr)
288 { return __arr[_Int]; }
290 _GLIBCXX_END_NAMESPACE_TR1