summaryrefslogtreecommitdiffstats
path: root/ue5/array.hpp
blob: a78ff56b2cef8f293619851f998fccaeddd4c6cc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
/**
 * @module array
 * @author Guenther Neuwirth (0626638), Manuel Mausz (0728348)
 * @brief  Class template array
 * @date   13.06.2009
 */

#ifndef ARRAY_H
#define ARRAY_H

#include <utility>
#include <algorithm>
#include <stdexcept>

#undef SOLVED_2
#define SOLVED_2

namespace Ti
{
  /**
   * @class array
   *
   * Array defines a class template for storing fixed-size sequences of objects.
   */
  template<typename T, std::size_t N>
    struct array
    {
      /** lvalue of T */
      typedef T& reference;
      /** constant lvalue of T */
      typedef const T& const_reference;
      /** iterator type whose value type is T */
      typedef T* iterator;
      /** constant iterator type whose value type is T */
      typedef const T* const_iterator;
      /** unsigned integral type */
      typedef std::size_t size_type;

      /* we don't suppport zero-sized arrays */
      static_assert(N != 0, "array<T, 0> not allowed");

      /**
       * @method fill
       * @brief  Fills container with elements of u
       * @param  u  object to fill array with
       * @return return N
       * @globalvars none
       * @exception  none
       * @pre  requires CopyAssignable<T> void fill(const T& u)
       * @post none
       */
      void fill(const T& u)
      {
        std::fill_n(begin(), N, u);
      }

      /**
       * @method swap
       * @brief  Exchanges the contents of *this and other.
       * @param  other  object to swap with
       * @return -
       * @globalvars none
       * @exception  none
       * @pre  none
       * @post none
       */
      void swap(array<T,N>& other)
      {
        std::swap_ranges(begin(), end(), other.begin());
      }

      /**
       * @method begin
       * @brief  Get an iterator referring to the first element in the container
       * @param  -
       * @return iterator referring to the first element in the container.
       * @globalvars none
       * @exception  none
       * @pre  none
       * @post none
       */
      iterator begin()
      {
        return m_data;
      }

      /**
       * @method begin
       * @brief  Get a constant iterator referring to the first element in the
       *         container
       * @param  -
       * @return constant iterator referring to the first element in the container.
       * @globalvars none
       * @exception  none
       * @pre  none
       * @post none
       */
      const_iterator begin() const
      {
        return m_data;
      }

      /**
       * @method end
       * @brief  Get an iterator which is the past-the-end value for the container.
       * @param  -
       * @return iterator which is the past-the-end value for the container
       * @globalvars none
       * @exception  none
       * @pre  none
       * @post none
       */
      iterator end()
      {
        return m_data + N;
      }

      /**
       * @method end
       * @brief  Get a constant iterator which is the past-the-end value for the
       *         container.
       * @param  -
       * @return constant iterator which is the past-the-end value for the container
       * @globalvars none
       * @exception  none
       * @pre  none
       * @post none
       */
      const_iterator end() const
      {
        return m_data + N;
      }

      /**
       * @method size
       * @brief  Get number of elements in the container
       * @param  -
       * @return return N
       * @globalvars none
       * @exception  none
       * @pre  none
       * @post none
       */
      size_type size() const
      {
        return N;
      }

      /**
       * @method max_size
       * @brief  Get maximal number of elements which fit into the container
       * @param  -
       * @return return N
       * @globalvars none
       * @exception  none
       * @pre  none
       * @post none
       */
      size_type max_size() const
      {
        return N;
      }

      /**
       * @method empty
       * @brief  Check if container is empty
       * @param  -
       * @return always false
       * @globalvars none
       * @exception  none
       * @pre  none
       * @post none
       */
      bool empty() const
      {
        return false; /* size() == 0 */
      }

      /**
       * @method operator[]
       * @brief  operator []
       * @param  n  position of an element in the array
       * @return reference to the element at position n in the container
       * @globalvars none
       * @exception  none
       * @pre  none
       * @post none
       */
      reference operator[](size_type n)
      {
        return m_data[n];
      }

      /**
       * @method operator[]
       * @brief  operator []
       * @param  n  position of an element in the array
       * @return constant reference to the element at position n in the container
       * @globalvars none
       * @exception  none
       * @pre  none
       * @post none
       */
      const_reference operator[](size_type n) const
      {
        return m_data[n];
      }

      /**
       * @method at
       * @brief  Get reference to the element at position n
       * @param  n  position of an element in the array
       * @return reference to the element at position n in the container.
       *         The difference between this member function and member operator
       *         function operator[] is that at signals if the requested
       *         position is out of range by throwing an out_of_range exception.
       * @globalvars none
       * @exception  out_of_range
       * @pre  none
       * @post none
       */
      reference at(size_type n)
      {
        if (n >= N)
          throw std::out_of_range("array::at");
        return m_data[n];
      }

      /**
       * @method at
       * @brief  Get constant reference to the element at position n
       * @param  n  position of an element in the array
       * @return constant reference to the element at position n in the container.
       *         The difference between this member function and member operator
       *         function operator[] is that at signals if the requested
       *         position is out of range by throwing an out_of_range exception.
       * @globalvars none
       * @exception  out_of_range
       * @pre  none
       * @post none
       */
      const_reference at(size_type n) const
      {
        if (n >= N)
          throw std::out_of_range("array::at");
        return m_data[n];
      }

      /**
       * @method data
       * @brief  Check if container is empty
       * @param  -
       * @return returns enclosed array
       * @globalvars none
       * @exception  none
       * @pre  none
       * @post none
       */
      T* data()
      {
        return m_data;
      }

      private:
        /** enclosed array */
        T m_data[N];
    };

  /**
   * @method make_array
   * @brief  Get an rvalue of an empty array
   * @param  none
   * @return rvalue of an empty array
   * @globalvars none
   * @exception  none
   * @pre  none
   * @post none
   */
  template<typename T, std::size_t N>
    array<T, N>&& make_array()
  {
    return std::move(array<T, N>());
  }
} // namespace

#endif

/* vim: set et sw=2 ts=2: */