Aleksandrs Gumenuks / MaximInterface_Extended

Extended MaximInterface

Dependents:   mbed_DS28EC20_GPIO

Utilities/array.hpp@6:a8c83a2e6fa4, 2019-01-23 (annotated)

Committer:
IanBenzMaxim
Date:
Wed Jan 23 13:11:04 2019 -0600
Revision:
6:a8c83a2e6fa4
Parent:
0:f77ad7f72d04
Child:
7:471901a04573
Updated to version 1.6 and removed platform files that are incompatible with mbed.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
IanBenzMaxim 0:f77ad7f72d04 1 /*******************************************************************************
IanBenzMaxim 0:f77ad7f72d04 2 * Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
IanBenzMaxim 0:f77ad7f72d04 3 *
IanBenzMaxim 0:f77ad7f72d04 4 * Permission is hereby granted, free of charge, to any person obtaining a
IanBenzMaxim 0:f77ad7f72d04 5 * copy of this software and associated documentation files (the "Software"),
IanBenzMaxim 0:f77ad7f72d04 6 * to deal in the Software without restriction, including without limitation
IanBenzMaxim 0:f77ad7f72d04 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
IanBenzMaxim 0:f77ad7f72d04 8 * and/or sell copies of the Software, and to permit persons to whom the
IanBenzMaxim 0:f77ad7f72d04 9 * Software is furnished to do so, subject to the following conditions:
IanBenzMaxim 0:f77ad7f72d04 10 *
IanBenzMaxim 0:f77ad7f72d04 11 * The above copyright notice and this permission notice shall be included
IanBenzMaxim 0:f77ad7f72d04 12 * in all copies or substantial portions of the Software.
IanBenzMaxim 0:f77ad7f72d04 13 *
IanBenzMaxim 0:f77ad7f72d04 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
IanBenzMaxim 0:f77ad7f72d04 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
IanBenzMaxim 0:f77ad7f72d04 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IanBenzMaxim 0:f77ad7f72d04 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
IanBenzMaxim 0:f77ad7f72d04 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
IanBenzMaxim 0:f77ad7f72d04 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
IanBenzMaxim 0:f77ad7f72d04 20 * OTHER DEALINGS IN THE SOFTWARE.
IanBenzMaxim 0:f77ad7f72d04 21 *
IanBenzMaxim 0:f77ad7f72d04 22 * Except as contained in this notice, the name of Maxim Integrated
IanBenzMaxim 0:f77ad7f72d04 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
IanBenzMaxim 0:f77ad7f72d04 24 * Products, Inc. Branding Policy.
IanBenzMaxim 0:f77ad7f72d04 25 *
IanBenzMaxim 0:f77ad7f72d04 26 * The mere transfer of this software does not imply any licenses
IanBenzMaxim 0:f77ad7f72d04 27 * of trade secrets, proprietary technology, copyrights, patents,
IanBenzMaxim 0:f77ad7f72d04 28 * trademarks, maskwork rights, or any other form of intellectual
IanBenzMaxim 0:f77ad7f72d04 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
IanBenzMaxim 0:f77ad7f72d04 30 * ownership rights.
IanBenzMaxim 0:f77ad7f72d04 31 *******************************************************************************/
IanBenzMaxim 0:f77ad7f72d04 32
IanBenzMaxim 0:f77ad7f72d04 33 #ifndef MaximInterface_array
IanBenzMaxim 0:f77ad7f72d04 34 #define MaximInterface_array
IanBenzMaxim 0:f77ad7f72d04 35
IanBenzMaxim 0:f77ad7f72d04 36 #include <stddef.h>
IanBenzMaxim 0:f77ad7f72d04 37 #include <stdint.h>
IanBenzMaxim 0:f77ad7f72d04 38 #include <algorithm>
IanBenzMaxim 0:f77ad7f72d04 39 #include <iterator>
IanBenzMaxim 0:f77ad7f72d04 40
IanBenzMaxim 0:f77ad7f72d04 41 namespace MaximInterface {
IanBenzMaxim 0:f77ad7f72d04 42
IanBenzMaxim 0:f77ad7f72d04 43 /// Generic array class similar to std::array.
IanBenzMaxim 0:f77ad7f72d04 44 template <typename T, size_t N> class array {
IanBenzMaxim 0:f77ad7f72d04 45 public:
IanBenzMaxim 0:f77ad7f72d04 46 typedef T value_type;
IanBenzMaxim 0:f77ad7f72d04 47 typedef size_t size_type;
IanBenzMaxim 0:f77ad7f72d04 48 typedef ptrdiff_t difference_type;
IanBenzMaxim 0:f77ad7f72d04 49 typedef value_type & reference;
IanBenzMaxim 0:f77ad7f72d04 50 typedef const value_type & const_reference;
IanBenzMaxim 0:f77ad7f72d04 51 typedef value_type * pointer;
IanBenzMaxim 0:f77ad7f72d04 52 typedef const value_type * const_pointer;
IanBenzMaxim 0:f77ad7f72d04 53 typedef pointer iterator;
IanBenzMaxim 0:f77ad7f72d04 54 typedef const_pointer const_iterator;
IanBenzMaxim 0:f77ad7f72d04 55 typedef std::reverse_iterator<iterator> reverse_iterator;
IanBenzMaxim 0:f77ad7f72d04 56 typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
IanBenzMaxim 0:f77ad7f72d04 57
IanBenzMaxim 6:a8c83a2e6fa4 58 /// @name Element access
IanBenzMaxim 6:a8c83a2e6fa4 59 /// @{
IanBenzMaxim 0:f77ad7f72d04 60 reference operator[](size_type pos) {
IanBenzMaxim 0:f77ad7f72d04 61 return const_cast<reference>(
IanBenzMaxim 0:f77ad7f72d04 62 static_cast<const array &>(*this).operator[](pos));
IanBenzMaxim 0:f77ad7f72d04 63 }
IanBenzMaxim 6:a8c83a2e6fa4 64
IanBenzMaxim 6:a8c83a2e6fa4 65 const_reference operator[](size_type pos) const { return data()[pos]; }
IanBenzMaxim 6:a8c83a2e6fa4 66
IanBenzMaxim 0:f77ad7f72d04 67 reference front() {
IanBenzMaxim 0:f77ad7f72d04 68 return const_cast<reference>(static_cast<const array &>(*this).front());
IanBenzMaxim 0:f77ad7f72d04 69 }
IanBenzMaxim 6:a8c83a2e6fa4 70
IanBenzMaxim 6:a8c83a2e6fa4 71 const_reference front() const { return operator[](0); }
IanBenzMaxim 6:a8c83a2e6fa4 72
IanBenzMaxim 0:f77ad7f72d04 73 reference back() {
IanBenzMaxim 0:f77ad7f72d04 74 return const_cast<reference>(static_cast<const array &>(*this).back());
IanBenzMaxim 0:f77ad7f72d04 75 }
IanBenzMaxim 6:a8c83a2e6fa4 76
IanBenzMaxim 6:a8c83a2e6fa4 77 const_reference back() const { return operator[](size() - 1); }
IanBenzMaxim 6:a8c83a2e6fa4 78
IanBenzMaxim 0:f77ad7f72d04 79 pointer data() {
IanBenzMaxim 0:f77ad7f72d04 80 return const_cast<pointer>(static_cast<const array &>(*this).data());
IanBenzMaxim 0:f77ad7f72d04 81 }
IanBenzMaxim 6:a8c83a2e6fa4 82
IanBenzMaxim 0:f77ad7f72d04 83 const_pointer data() const { return _buffer; }
IanBenzMaxim 6:a8c83a2e6fa4 84 /// @}
IanBenzMaxim 0:f77ad7f72d04 85
IanBenzMaxim 6:a8c83a2e6fa4 86 /// @name Iterators
IanBenzMaxim 6:a8c83a2e6fa4 87 /// @{
IanBenzMaxim 0:f77ad7f72d04 88 iterator begin() {
IanBenzMaxim 0:f77ad7f72d04 89 return const_cast<iterator>(static_cast<const array &>(*this).cbegin());
IanBenzMaxim 0:f77ad7f72d04 90 }
IanBenzMaxim 6:a8c83a2e6fa4 91
IanBenzMaxim 0:f77ad7f72d04 92 const_iterator begin() const { return cbegin(); }
IanBenzMaxim 6:a8c83a2e6fa4 93
IanBenzMaxim 6:a8c83a2e6fa4 94 const_iterator cbegin() const { return data(); }
IanBenzMaxim 6:a8c83a2e6fa4 95
IanBenzMaxim 0:f77ad7f72d04 96 iterator end() {
IanBenzMaxim 0:f77ad7f72d04 97 return const_cast<iterator>(static_cast<const array &>(*this).cend());
IanBenzMaxim 0:f77ad7f72d04 98 }
IanBenzMaxim 6:a8c83a2e6fa4 99
IanBenzMaxim 0:f77ad7f72d04 100 const_iterator end() const { return cend(); }
IanBenzMaxim 6:a8c83a2e6fa4 101
IanBenzMaxim 6:a8c83a2e6fa4 102 const_iterator cend() const { return cbegin() + size(); }
IanBenzMaxim 6:a8c83a2e6fa4 103
IanBenzMaxim 0:f77ad7f72d04 104 reverse_iterator rbegin() { return reverse_iterator(end()); }
IanBenzMaxim 6:a8c83a2e6fa4 105
IanBenzMaxim 0:f77ad7f72d04 106 const_reverse_iterator rbegin() const {
IanBenzMaxim 0:f77ad7f72d04 107 return const_reverse_iterator(end());
IanBenzMaxim 0:f77ad7f72d04 108 }
IanBenzMaxim 6:a8c83a2e6fa4 109
IanBenzMaxim 0:f77ad7f72d04 110 const_reverse_iterator crbegin() const { return rbegin(); }
IanBenzMaxim 6:a8c83a2e6fa4 111
IanBenzMaxim 0:f77ad7f72d04 112 reverse_iterator rend() { return reverse_iterator(begin()); }
IanBenzMaxim 6:a8c83a2e6fa4 113
IanBenzMaxim 0:f77ad7f72d04 114 const_reverse_iterator rend() const {
IanBenzMaxim 0:f77ad7f72d04 115 return const_reverse_iterator(begin());
IanBenzMaxim 0:f77ad7f72d04 116 }
IanBenzMaxim 6:a8c83a2e6fa4 117
IanBenzMaxim 0:f77ad7f72d04 118 const_reverse_iterator crend() const { return rend(); }
IanBenzMaxim 6:a8c83a2e6fa4 119 /// @}
IanBenzMaxim 0:f77ad7f72d04 120
IanBenzMaxim 6:a8c83a2e6fa4 121 /// @name Capacity
IanBenzMaxim 6:a8c83a2e6fa4 122 /// @{
IanBenzMaxim 0:f77ad7f72d04 123 static bool empty() { return size() == 0; }
IanBenzMaxim 6:a8c83a2e6fa4 124
IanBenzMaxim 0:f77ad7f72d04 125 static size_type size() { return N; }
IanBenzMaxim 6:a8c83a2e6fa4 126
IanBenzMaxim 0:f77ad7f72d04 127 static size_type max_size() { return size(); }
IanBenzMaxim 6:a8c83a2e6fa4 128
IanBenzMaxim 6:a8c83a2e6fa4 129 /// Alternative to size() when a constant expression is required.
IanBenzMaxim 6:a8c83a2e6fa4 130 static const size_type csize = N;
IanBenzMaxim 6:a8c83a2e6fa4 131 /// @}
IanBenzMaxim 0:f77ad7f72d04 132
IanBenzMaxim 6:a8c83a2e6fa4 133 /// @name Operations
IanBenzMaxim 6:a8c83a2e6fa4 134 /// @{
IanBenzMaxim 0:f77ad7f72d04 135 void fill(const_reference value) { std::fill(begin(), end(), value); }
IanBenzMaxim 6:a8c83a2e6fa4 136
IanBenzMaxim 0:f77ad7f72d04 137 void swap(array & other) { std::swap_ranges(begin(), end(), other.begin()); }
IanBenzMaxim 6:a8c83a2e6fa4 138 /// @}
IanBenzMaxim 0:f77ad7f72d04 139
IanBenzMaxim 6:a8c83a2e6fa4 140 /// @private
IanBenzMaxim 6:a8c83a2e6fa4 141 /// Implementation detail set public to allow aggregate initialization.
IanBenzMaxim 0:f77ad7f72d04 142 T _buffer[N];
IanBenzMaxim 0:f77ad7f72d04 143 };
IanBenzMaxim 0:f77ad7f72d04 144
IanBenzMaxim 0:f77ad7f72d04 145 template <typename T, size_t N>
IanBenzMaxim 0:f77ad7f72d04 146 inline bool operator==(const array<T, N> & lhs, const array<T, N> & rhs) {
IanBenzMaxim 0:f77ad7f72d04 147 return std::equal(lhs.begin(), lhs.end(), rhs.begin());
IanBenzMaxim 0:f77ad7f72d04 148 }
IanBenzMaxim 0:f77ad7f72d04 149
IanBenzMaxim 0:f77ad7f72d04 150 template <typename T, size_t N>
IanBenzMaxim 0:f77ad7f72d04 151 inline bool operator!=(const array<T, N> & lhs, const array<T, N> & rhs) {
IanBenzMaxim 0:f77ad7f72d04 152 return !operator==(lhs, rhs);
IanBenzMaxim 0:f77ad7f72d04 153 }
IanBenzMaxim 0:f77ad7f72d04 154
IanBenzMaxim 0:f77ad7f72d04 155 template <typename T, size_t N>
IanBenzMaxim 0:f77ad7f72d04 156 inline bool operator<(const array<T, N> & lhs, const array<T, N> & rhs) {
IanBenzMaxim 0:f77ad7f72d04 157 return std::lexicographical_compare(lhs.begin(), lhs.end(), rhs.begin(),
IanBenzMaxim 0:f77ad7f72d04 158 rhs.end());
IanBenzMaxim 0:f77ad7f72d04 159 }
IanBenzMaxim 0:f77ad7f72d04 160
IanBenzMaxim 0:f77ad7f72d04 161 template <typename T, size_t N>
IanBenzMaxim 0:f77ad7f72d04 162 inline bool operator>(const array<T, N> & lhs, const array<T, N> & rhs) {
IanBenzMaxim 0:f77ad7f72d04 163 return operator<(rhs, lhs);
IanBenzMaxim 0:f77ad7f72d04 164 }
IanBenzMaxim 0:f77ad7f72d04 165
IanBenzMaxim 0:f77ad7f72d04 166 template <typename T, size_t N>
IanBenzMaxim 0:f77ad7f72d04 167 inline bool operator<=(const array<T, N> & lhs, const array<T, N> & rhs) {
IanBenzMaxim 0:f77ad7f72d04 168 return !operator>(lhs, rhs);
IanBenzMaxim 0:f77ad7f72d04 169 }
IanBenzMaxim 0:f77ad7f72d04 170
IanBenzMaxim 0:f77ad7f72d04 171 template <typename T, size_t N>
IanBenzMaxim 0:f77ad7f72d04 172 inline bool operator>=(const array<T, N> & lhs, const array<T, N> & rhs) {
IanBenzMaxim 0:f77ad7f72d04 173 return !operator<(lhs, rhs);
IanBenzMaxim 0:f77ad7f72d04 174 }
IanBenzMaxim 0:f77ad7f72d04 175
IanBenzMaxim 0:f77ad7f72d04 176 template <typename T, size_t N>
IanBenzMaxim 0:f77ad7f72d04 177 inline void swap(array<T, N> & lhs, array<T, N> & rhs) {
IanBenzMaxim 0:f77ad7f72d04 178 lhs.swap(rhs);
IanBenzMaxim 0:f77ad7f72d04 179 }
IanBenzMaxim 0:f77ad7f72d04 180
IanBenzMaxim 0:f77ad7f72d04 181 } // namespace MaximInterface
IanBenzMaxim 0:f77ad7f72d04 182
IanBenzMaxim 0:f77ad7f72d04 183 #endif