Aleksandrs Gumenuks / MaximInterface_Extended

Extended MaximInterface

Dependents:   mbed_DS28EC20_GPIO

Utilities/Segment.hpp@7:471901a04573, 2019-03-04 (annotated)

Committer:
IanBenzMaxim
Date:
Mon Mar 04 08:10:00 2019 -0600
Revision:
7:471901a04573
Parent:
6:a8c83a2e6fa4 
Updated to version 1.7.

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_Segment
IanBenzMaxim 0:f77ad7f72d04 34 #define MaximInterface_Segment
IanBenzMaxim 0:f77ad7f72d04 35
IanBenzMaxim 0:f77ad7f72d04 36 #include <iterator>
IanBenzMaxim 0:f77ad7f72d04 37 #include <utility>
IanBenzMaxim 0:f77ad7f72d04 38 #include "type_traits.hpp"
IanBenzMaxim 0:f77ad7f72d04 39
IanBenzMaxim 0:f77ad7f72d04 40 namespace MaximInterface {
IanBenzMaxim 0:f77ad7f72d04 41
IanBenzMaxim 7:471901a04573 42 /// @brief
IanBenzMaxim 0:f77ad7f72d04 43 /// Advances a given iterator by a given number of elements with bounds checking.
IanBenzMaxim 7:471901a04573 44 /// @tparam InputIt Must meet the requirements of InputIterator.
IanBenzMaxim 0:f77ad7f72d04 45 /// @param[in,out] it Iterator to advance.
IanBenzMaxim 0:f77ad7f72d04 46 /// @param bound
IanBenzMaxim 0:f77ad7f72d04 47 /// Past-the-end boundary iterator. If distance is positive, bound must be
IanBenzMaxim 0:f77ad7f72d04 48 /// reachable by incrementing the given iterator. If distance is negative, bound
IanBenzMaxim 0:f77ad7f72d04 49 /// must be reachable by decrementing the given iterator.
IanBenzMaxim 0:f77ad7f72d04 50 /// @param distance
IanBenzMaxim 0:f77ad7f72d04 51 /// Number of elements to advance the given iterator. If distance is positive,
IanBenzMaxim 0:f77ad7f72d04 52 /// the given iterator is incremented. If distance is negative, the given
IanBenzMaxim 0:f77ad7f72d04 53 /// iterator is decremented, and InputIt must meet the requirements of
IanBenzMaxim 0:f77ad7f72d04 54 /// BidirectionalIterator.
IanBenzMaxim 0:f77ad7f72d04 55 /// @returns The number of elements that the given iterator was advanced.
IanBenzMaxim 0:f77ad7f72d04 56 template <typename InputIt>
IanBenzMaxim 0:f77ad7f72d04 57 typename std::iterator_traits<InputIt>::difference_type checkedAdvance(
IanBenzMaxim 0:f77ad7f72d04 58 InputIt & it, const InputIt bound,
IanBenzMaxim 0:f77ad7f72d04 59 typename std::iterator_traits<InputIt>::difference_type distance) {
IanBenzMaxim 0:f77ad7f72d04 60 typedef
IanBenzMaxim 0:f77ad7f72d04 61 typename std::iterator_traits<InputIt>::difference_type difference_type;
IanBenzMaxim 0:f77ad7f72d04 62
IanBenzMaxim 0:f77ad7f72d04 63 // Use constant-time operations if InputIt is a random access iterator.
IanBenzMaxim 0:f77ad7f72d04 64 if (is_same<typename std::iterator_traits<InputIt>::iterator_category,
IanBenzMaxim 0:f77ad7f72d04 65 std::random_access_iterator_tag>::value) {
IanBenzMaxim 0:f77ad7f72d04 66 const difference_type boundDistance = std::distance(it, bound);
IanBenzMaxim 0:f77ad7f72d04 67 if (boundDistance >= 0) {
IanBenzMaxim 0:f77ad7f72d04 68 if (distance > boundDistance) {
IanBenzMaxim 0:f77ad7f72d04 69 distance = boundDistance;
IanBenzMaxim 0:f77ad7f72d04 70 } else if (distance < 0) {
IanBenzMaxim 0:f77ad7f72d04 71 distance = 0;
IanBenzMaxim 0:f77ad7f72d04 72 }
IanBenzMaxim 0:f77ad7f72d04 73 } else {
IanBenzMaxim 0:f77ad7f72d04 74 if (distance < boundDistance) {
IanBenzMaxim 0:f77ad7f72d04 75 distance = boundDistance;
IanBenzMaxim 0:f77ad7f72d04 76 } else if (distance > 0) {
IanBenzMaxim 0:f77ad7f72d04 77 distance = 0;
IanBenzMaxim 0:f77ad7f72d04 78 }
IanBenzMaxim 0:f77ad7f72d04 79 }
IanBenzMaxim 0:f77ad7f72d04 80 std::advance(it, distance);
IanBenzMaxim 0:f77ad7f72d04 81 } else {
IanBenzMaxim 0:f77ad7f72d04 82 const difference_type startingDistance = distance;
IanBenzMaxim 0:f77ad7f72d04 83 while (distance != 0 && it != bound) {
IanBenzMaxim 0:f77ad7f72d04 84 if (distance > 0) {
IanBenzMaxim 0:f77ad7f72d04 85 ++it;
IanBenzMaxim 0:f77ad7f72d04 86 --distance;
IanBenzMaxim 0:f77ad7f72d04 87 } else {
IanBenzMaxim 0:f77ad7f72d04 88 --it;
IanBenzMaxim 0:f77ad7f72d04 89 ++distance;
IanBenzMaxim 0:f77ad7f72d04 90 }
IanBenzMaxim 0:f77ad7f72d04 91 }
IanBenzMaxim 0:f77ad7f72d04 92 if (startingDistance > 0) {
IanBenzMaxim 0:f77ad7f72d04 93 distance = startingDistance - distance;
IanBenzMaxim 0:f77ad7f72d04 94 } else {
IanBenzMaxim 0:f77ad7f72d04 95 distance = startingDistance + distance;
IanBenzMaxim 0:f77ad7f72d04 96 }
IanBenzMaxim 0:f77ad7f72d04 97 }
IanBenzMaxim 0:f77ad7f72d04 98 return distance;
IanBenzMaxim 0:f77ad7f72d04 99 }
IanBenzMaxim 0:f77ad7f72d04 100
IanBenzMaxim 7:471901a04573 101 /// @brief Locates an iterator sub-range using segment number addressing.
IanBenzMaxim 7:471901a04573 102 /// @details
IanBenzMaxim 7:471901a04573 103 /// Useful for devices that divide the memory space into uniform chunks such as
IanBenzMaxim 7:471901a04573 104 /// pages and segments.
IanBenzMaxim 7:471901a04573 105 /// @tparam ForwardIt Must meet the requirements of ForwardIterator.
IanBenzMaxim 0:f77ad7f72d04 106 /// @param begin Beginning of the input data range.
IanBenzMaxim 0:f77ad7f72d04 107 /// @param end End of the input data range.
IanBenzMaxim 0:f77ad7f72d04 108 /// @param segmentSize Number of elements contained in a segment.
IanBenzMaxim 0:f77ad7f72d04 109 /// @param segmentNum Zero-indexed number of the desired segment.
IanBenzMaxim 7:471901a04573 110 /// @returns
IanBenzMaxim 7:471901a04573 111 /// Pair of iterators representing the sub-range of the segment within
IanBenzMaxim 0:f77ad7f72d04 112 /// the input range. If the segment does not exist within the input range, both
IanBenzMaxim 6:a8c83a2e6fa4 113 /// iterators in the pair are set to the end iterator of the input range.
IanBenzMaxim 0:f77ad7f72d04 114 template <typename ForwardIt, typename Index>
IanBenzMaxim 0:f77ad7f72d04 115 std::pair<ForwardIt, ForwardIt> createSegment(
IanBenzMaxim 0:f77ad7f72d04 116 ForwardIt begin, const ForwardIt end,
IanBenzMaxim 0:f77ad7f72d04 117 const typename std::iterator_traits<ForwardIt>::difference_type segmentSize,
IanBenzMaxim 0:f77ad7f72d04 118 Index segmentNum) {
IanBenzMaxim 0:f77ad7f72d04 119 ForwardIt segmentEnd = begin;
IanBenzMaxim 0:f77ad7f72d04 120 typename std::iterator_traits<ForwardIt>::difference_type lastSegmentSize =
IanBenzMaxim 0:f77ad7f72d04 121 checkedAdvance(segmentEnd, end, segmentSize);
IanBenzMaxim 0:f77ad7f72d04 122 while (segmentNum > 0 && segmentEnd != end) {
IanBenzMaxim 0:f77ad7f72d04 123 begin = segmentEnd;
IanBenzMaxim 0:f77ad7f72d04 124 lastSegmentSize = checkedAdvance(segmentEnd, end, segmentSize);
IanBenzMaxim 0:f77ad7f72d04 125 --segmentNum;
IanBenzMaxim 0:f77ad7f72d04 126 }
IanBenzMaxim 0:f77ad7f72d04 127 if (segmentNum > 0 || lastSegmentSize != segmentSize) {
IanBenzMaxim 0:f77ad7f72d04 128 begin = segmentEnd;
IanBenzMaxim 0:f77ad7f72d04 129 }
IanBenzMaxim 0:f77ad7f72d04 130 return std::make_pair(begin, segmentEnd);
IanBenzMaxim 0:f77ad7f72d04 131 }
IanBenzMaxim 0:f77ad7f72d04 132
IanBenzMaxim 0:f77ad7f72d04 133 } // namespace MaximInterface
IanBenzMaxim 0:f77ad7f72d04 134
IanBenzMaxim 0:f77ad7f72d04 135 #endif