feat: modifying functions having iterators as input should be overloaded with functions taking const_iterator

Open
#47 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
cpp

Research direction

Start by inspecting the circular_buffer API for functions that accept iterator inputs and compare their overloads with standard-container conventions. Reproduce the compilation errors described when replacing std::deque with boost::circular, then define done as providing the needed const_iterator-compatible overloads without breaking existing iterator calls.

Written by the indexing model from the issue text.

Description

This is what most standard containers are doing today.

By replacing std::deque with boost::circular, I got a few compilation errors...

Prior to C++11, the guideline was to prefer iterator because of some STL API defect in regard to const_iterator but this got fixed in C++11

References:
Effective STL book
item 26: Prefer iterator to const_iterator, reverse_iterator, and const_reverse_iterator

Effective Modern C++ book
Item 13: Prefer const_iterators to iterators

Dominant language
C++
Stars
65
Forks
64
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from boostorg/circular_buffer

All issues in boostorg/circular_buffer

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.