mirror of
https://github.com/ETLCPP/etl.git
synced 2026-06-15 16:36:03 +08:00
4a88884b39
* Add ranges * Initial Hugo setup * Work in progress * Added selection for local or remote site * Updated to 'light' theme * Changed to using Hextra Hugo theme * Changed to using Hextra Hugo theme * Changed to Hextra Hugo theme * Change to Hextra Hugo theme * Updated Hugo setup. * Updated Hugo setup. # Conflicts: # docs/releases/_index.md * Work in progress * Added new fonts Added new documentation * Latest documentation updates * Latest documentation updates # Conflicts: # docs/containers/array.md # docs/containers/array_view.md # docs/containers/array_wrapper.md # docs/containers/bip_buffer_spsc_atomic.md # docs/containers/bitset.md # docs/containers/indirect_vector.md # docs/containers/vector.md # docs/getting-started/compilers.md * Added bloom_filter markdown doc * Added more documentation Updated CSS for light and dark modes * Fixed some menus Added mode documentation files * Updated CSS rules Added badges to home page Added uniqur_ptr + pool tutorial * Fixed formatting on the home page markdown Modified light amd dark code formatting * Updated unique_ptr-with-pool * Added container and shared message tutorials * Updates to documentation * Added const_multimap * Updated source-formatting.md * Added initial raw text files form Web site editor * Innore coverage build directory * Exported raw text documentation files from the web site editor * Hugo updates * Added Hugo intalation and markdown descriptions * More addition to the documentation * Added closure.md and updates to delegate.md * Added format.md * Added documentation for etl::delegate_observable, etl::function, Base64 codec * Added io_port documentation * Added basic_format_spec * Added documentation for string_stream and string utilities. * Added more documentation Updated the documentation CSS * Added documentation for clocks, day, duration * Added more documentation for chrono classes Updated callouts * More chrono documentation * Completed chrono documentation * Maths functions documentation * Completed maths documentation * Completed maths documentation * Completed maths documentation * Completed maths documentation * Added multiple documentation files * Added iterator.md * Added debug_count.md and versions.md * Added debug_count.md and versions.md * Added more documentation * More documentation * Added some design pattern documentation Modified some of the layout files Modified the About documentation * Converted more documentation pages Modified the site CSS * Added more documentation Moced some documentation files to new directories * Added more documentation Tweaks to CSS * Added callback_timer_deferred_locked documentation * Added callback_timer_locked documentation * More documentation updates * More documentation updates * More documentation updates * New documentation files. Harmonised file name format * New documentation files. * Multiple document updates * Multiple document updates * Final conversion of web pages * Updates before PR * Updates before PR * Updates before PR # Conflicts: # docs/blog/_index.md * Final pre PR updates * Updates to message framework documentation * Renamed directory * Fix spelling * Added author and date to blog files Moved documentation files merged from development * Fixed 'Description' typo * Fix typos # Conflicts: # docs/IO/io_port.md # docs/containers/sets/const-multiset.md # docs/containers/sets/const-set.md # docs/maths/correlation.md # docs/maths/gamma.md * Renamed two files to lower case * Minor renaming * Added author and date * Updated callout on bresenham_line.md Added support for showing the ETL version on the documentation first page, by copying the version.txt file as a hugo asset. Updated the Python 'update_release.py' to copy 'version.txt' * Replace space in filename with hyphen. Added more information to hugo-commands.md * Replace space in filename with hyphen. Added more information to hugo-commands.md # Conflicts: # docs/getting-started/view-the-docs-locally/hugo-commands.md * Added a link to pseudo_moving_average.md * Updated title pages for groups * Fixed missing 404 for non-existent pages * Fixed coordinate variable names in the 'Calculating the intersection' example --------- Co-authored-by: Roland Reichwein <Roland.Reichwein@bmw.de> Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.com> Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.co.uk>
4.7 KiB
4.7 KiB
| title |
|---|
| circular_iterator |
{{< callout type="info">}}
Header: circular_iterator.h
From: 20.34.0
{{< /callout >}}
An iterator wrapper where increments and decrements will roll around the boundaries of an iterator range.
It is constructed with the begin and end of the range, plus an optional start position.
May be used with forward, bidirectional and random access iterators.
template <typename TIterator>
etl::circular_iterator final;
Types
value_type
difference_type
pointer
reference
iterator_category
Constructors
ETL_CONSTEXPR14 circular_iterator()
Default constructor.
ETL_CONSTEXPR14 circular_iterator(TIterator itr_begin, TIterator itr_end)
Construct from iterators.
ETL_CONSTEXPR14 circular_iterator(TIterator itr_begin, TIterator itr_end, TIterator itr_start)
Construct from iterators and start position
ETL_CONSTEXPR14 circular_iterator(const circular_iterator& other)
Copy constructor
Member functions
ETL_CONSTEXPR14 circular_iterator& operator =(const circular_iterator& other)
Assignment operator
ETL_CONSTEXPR14 size_t size() const
Returns the length of the range.
ETL_CONSTEXPR14 bool empty() const
Returns true if the range is empty.
ETL_CONSTEXPR14 value_type operator *()
Dereference operator
ETL_CONSTEXPR14 const value_type operator *() const
Dereference operator
ETL_CONSTEXPR14 TIterator operator ->()
-> operator
ETL_CONSTEXPR14 const TIterator operator ->() const
-> operator
ETL_CONSTEXPR14 operator TIterator() const
Conversion operator
ETL_CONSTEXPR14 TIterator current() const
Conversion to the base iterator type
ETL_CONSTEXPR14 circular_iterator& operator ++()
Increment
Forward iterator
Bidirectional iterator
Random access iterator
ETL_CONSTEXPR14 circular_iterator operator ++(int)
Increment
Forward iterator
Bidirectional iterator
Random access iterator
ETL_CONSTEXPR14 circular_iterator& operator --()
Decrement
Bidirectional iterator
Random access iterator
ETL_CONSTEXPR14 circular_iterator operator --(int)
Decrement
Bidirectional iterator
Random access iterator
ETL_CONSTEXPR14 circular_iterator& operator +=(difference_type offset)
+= operator
Random access iterator
ETL_CONSTEXPR14 circular_iterator& operator -=(typename
etl::iterator_traits<TIterator>::difference_type
offset)
-= operator Random access iterator
Non-member functions
template <typename TIterator>
ETL_CONSTEXPR14
typename etl::iterator_traits<TIterator>::difference_type
operator - (etl::circular_iterator<TIterator>& lhs, etl::circular_iterator<TIterator>& rhs)
template <typename TIterator>
ETL_CONSTEXPR14
bool operator ==(const etl::circular_iterator<TIterator>& lhs,
const etl::circular_iterator<TIterator>& rhs)
template <typename TIterator>
ETL_CONSTEXPR14 bool operator ==(const etl::circular_iterator<TIterator>& lhs,
TIterator rhs)
template <typename TIterator>
ETL_CONSTEXPR14 bool operator ==(TIterator lhs,
const etl::circular_iterator<TIterator>& rhs)
template <typename TIterator>
ETL_CONSTEXPR14 bool operator !=(const etl::circular_iterator<TIterator>& lhs,
const etl::circular_iterator<TIterator>& rhs)
template <typename TIterator>
ETL_CONSTEXPR14 bool operator !=(const etl::circular_iterator<TIterator>& lhs,
TIterator rhs)
template <typename TIterator>
ETL_CONSTEXPR14 bool operator !=(TIterator& lhs,
const etl::circular_iterator<TIterator>& rhs)
Example
std::list<int> data{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 };
// The start position to loop from.
std::list<int>::const_iterator> start = data.begin();
std::advance(start, 2);
// Create circular iterators.
etl::circular_iterator<std::list<int>::const_iterator>> cli(data.begin(), data.end(), start);
etl::circular_iterator<std::list<int>::const_reverse_iterator>> clri(data.rbegin(), data.rend);
// Loop 10 times, taking every third value, starting from the third element for the forward iterator and from the end for the reverse iterator.
for (int = 0; i < 10; ++i)
{
std::cout << "(" << *cli << "," << *clrl << ")";
std::advance(cli, 3);
std::advance(clri, 3);
}
Prints the following
(2,9)(5,6)(8,3)(1,0)(4,7)(7,4)(0,1)(3,8)(6,5)(9,2)