1 // class template array -*- C++ -*-
3 // Copyright (C) 2007, 2008, 2009 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 typedef value_type& reference;
53 typedef const value_type& const_reference;
54 typedef value_type* iterator;
55 typedef const value_type* const_iterator;
56 typedef std::size_t size_type;
57 typedef std::ptrdiff_t difference_type;
58 typedef std::reverse_iterator<iterator> reverse_iterator;
59 typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
61 // Support for zero-sized arrays mandatory.
62 value_type _M_instance[_Nm ? _Nm : 1];
64 // No explicit construct/copy/destroy for aggregate type.
67 #ifdef _GLIBCXX_INCLUDE_AS_CXX0X
69 fill(const value_type& __u)
71 assign(const value_type& __u)
73 { std::fill_n(begin(), size(), __u); }
77 { std::swap_ranges(begin(), end(), __other.begin()); }
82 { return iterator(&_M_instance[0]); }
86 { return const_iterator(&_M_instance[0]); }
90 { return iterator(&_M_instance[_Nm]); }
94 { return const_iterator(&_M_instance[_Nm]); }
98 { return reverse_iterator(end()); }
100 const_reverse_iterator
102 { return const_reverse_iterator(end()); }
106 { return reverse_iterator(begin()); }
108 const_reverse_iterator
110 { return const_reverse_iterator(begin()); }
112 #ifdef _GLIBCXX_INCLUDE_AS_CXX0X
115 { return const_iterator(&_M_instance[0]); }
119 { return const_iterator(&_M_instance[_Nm]); }
121 const_reverse_iterator
123 { return const_reverse_iterator(end()); }
125 const_reverse_iterator
127 { return const_reverse_iterator(begin()); }
132 size() const { return _Nm; }
135 max_size() const { return _Nm; }
138 empty() const { return size() == 0; }
142 operator[](size_type __n)
143 { return _M_instance[__n]; }
146 operator[](size_type __n) const
147 { return _M_instance[__n]; }
153 std::__throw_out_of_range(__N("array::at"));
154 return _M_instance[__n];
158 at(size_type __n) const
161 std::__throw_out_of_range(__N("array::at"));
162 return _M_instance[__n];
175 { return _Nm ? *(end() - 1) : *end(); }
179 { return _Nm ? *(end() - 1) : *end(); }
183 { return &_M_instance[0]; }
187 { return &_M_instance[0]; }
190 // Array comparisons.
191 template<typename _Tp, std::size_t _Nm>
193 operator==(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
194 { return std::equal(__one.begin(), __one.end(), __two.begin()); }
196 template<typename _Tp, std::size_t _Nm>
198 operator!=(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
199 { return !(__one == __two); }
201 template<typename _Tp, std::size_t _Nm>
203 operator<(const array<_Tp, _Nm>& __a, const array<_Tp, _Nm>& __b)
205 return std::lexicographical_compare(__a.begin(), __a.end(),
206 __b.begin(), __b.end());
209 template<typename _Tp, std::size_t _Nm>
211 operator>(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
212 { return __two < __one; }
214 template<typename _Tp, std::size_t _Nm>
216 operator<=(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
217 { return !(__one > __two); }
219 template<typename _Tp, std::size_t _Nm>
221 operator>=(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
222 { return !(__one < __two); }
224 // Specialized algorithms [6.2.2.2].
225 template<typename _Tp, std::size_t _Nm>
227 swap(array<_Tp, _Nm>& __one, array<_Tp, _Nm>& __two)
228 { std::swap_ranges(__one.begin(), __one.end(), __two.begin()); }
230 // Tuple interface to class template array [6.2.2.5].
233 template<typename _Tp>
237 #ifdef _GLIBCXX_INCLUDE_AS_CXX0X
238 template<std::size_t _Int, typename _Tp>
240 template<int _Int, typename _Tp>
244 template<typename _Tp, std::size_t _Nm>
245 struct tuple_size<array<_Tp, _Nm> >
246 #ifdef _GLIBCXX_INCLUDE_AS_CXX0X
247 { static const std::size_t value = _Nm; };
249 { static const int value = _Nm; };
252 template<typename _Tp, std::size_t _Nm>
253 #ifdef _GLIBCXX_INCLUDE_AS_CXX0X
258 tuple_size<array<_Tp, _Nm> >::value;
260 #ifdef _GLIBCXX_INCLUDE_AS_CXX0X
261 template<std::size_t _Int, typename _Tp, std::size_t _Nm>
263 template<int _Int, typename _Tp, std::size_t _Nm>
265 struct tuple_element<_Int, array<_Tp, _Nm> >
266 { typedef _Tp type; };
268 #ifdef _GLIBCXX_INCLUDE_AS_CXX0X
269 template<std::size_t _Int, typename _Tp, std::size_t _Nm>
271 template<int _Int, typename _Tp, std::size_t _Nm>
274 get(array<_Tp, _Nm>& __arr)
275 { return __arr[_Int]; }
277 #ifdef _GLIBCXX_INCLUDE_AS_CXX0X
278 template<std::size_t _Int, typename _Tp, std::size_t _Nm>
280 template<int _Int, typename _Tp, std::size_t _Nm>
283 get(const array<_Tp, _Nm>& __arr)
284 { return __arr[_Int]; }
286 _GLIBCXX_END_NAMESPACE_TR1