Skip to content

Commit 9c55af8

Browse files
jensmaurerzygoloid
authored andcommitted
[std] Move implementation recommendations to outside notes
and prefix them with "Recommended practice" Partially addresses ISO/CS 017 (C++20 DIS)
1 parent 3cef439 commit 9c55af8

File tree

12 files changed

+78
-65
lines changed

12 files changed

+78
-65
lines changed

source/atomics.tex

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -636,12 +636,15 @@
636636
block\iref{intro.progress}.
637637

638638
\pnum
639-
Operations that are lock-free should also be address-free.
640-
\begin{note}
639+
\recommended
640+
Operations that are lock-free should also be address-free%
641+
\footnote{
641642
That is,
642643
atomic operations on the same memory location via two different addresses will
643-
communicate atomically. The implementation should not depend on any
644-
per-process state. This restriction enables communication by memory that is
644+
communicate atomically.}.
645+
The implementation of these operations should not depend on any per-process state.
646+
\begin{note}
647+
This restriction enables communication by memory that is
645648
mapped into a process more than once and by memory that is shared between two
646649
processes.
647650
\end{note}

source/basic.tex

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6243,10 +6243,10 @@
62436243
by repeatedly stealing a cache line
62446244
for unrelated purposes
62456245
between load-locked and store-conditional instructions.
6246-
Implementations should ensure
6247-
that such effects cannot indefinitely delay progress
6246+
For implementations that follow this recommendation and
6247+
ensure that such effects cannot indefinitely delay progress
62486248
under expected operating conditions,
6249-
and that such anomalies
6249+
such anomalies
62506250
can therefore safely be ignored by programmers.
62516251
Outside this document,
62526252
this property is sometimes termed lock-free.
@@ -6663,9 +6663,10 @@
66636663
even if it is not itself odr-used~(\ref{basic.def.odr}, \ref{basic.stc.static}).}
66646664
It is \impldef{threads and program points at which deferred dynamic initialization is performed}
66656665
in which threads and at which points in the program such deferred dynamic initialization occurs.
6666-
\begin{note}
6667-
Such points should be chosen in a way that allows the programmer to avoid deadlocks.
6668-
\end{note}
6666+
6667+
\recommended
6668+
An implementation should choose such points in a way
6669+
that allows the programmer to avoid deadlocks.
66696670
\begin{example}
66706671
\begin{codeblock}
66716672
// - File 1 -

source/expressions.tex

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7264,14 +7264,16 @@
72647264
\end{example}
72657265

72667266
\pnum
7267+
\recommended
7268+
Implementations should provide consistent results of floating-point evaluations,
7269+
irrespective of whether the evaluation is performed
7270+
during translation or during program execution.
72677271
\begin{note}
72687272
Since this document
72697273
imposes no restrictions on the accuracy of floating-point operations, it is unspecified whether the
72707274
evaluation of a floating-point expression during translation yields the same result as the
72717275
evaluation of the same expression (or the same operations on the same values) during program
7272-
execution.\footnote{Nonetheless, implementations should provide consistent results,
7273-
irrespective of whether the evaluation was performed during translation and/or during program
7274-
execution.}
7276+
execution.
72757277
\begin{example}
72767278
\begin{codeblock}
72777279
bool f() {

source/future.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -570,7 +570,7 @@
570570
\begin{itemize}
571571
\item
572572
\tcode{allocated}, set when a dynamic array object has been
573-
allocated, and hence should be freed by the destructor for the
573+
allocated, and hence will be freed by the destructor for the
574574
\tcode{strstreambuf} object;
575575
\item
576576
\tcode{constant}, set when the array object has

source/iostreams.tex

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -430,8 +430,7 @@
430430
The objects are constructed and the associations are established at some
431431
time prior to or during the first time an object of class
432432
\tcode{ios_base::Init} is constructed, and in any case before the body
433-
of \tcode{main}\iref{basic.start.main} begins execution.\footnote{If it is possible for them to do so, implementations should
434-
initialize the objects earlier than required.}
433+
of \tcode{main}\iref{basic.start.main} begins execution.
435434
The objects are not destroyed during program execution.\footnote{Constructors and destructors for objects with
436435
static storage duration can
437436
access these objects to read input from
@@ -441,6 +440,13 @@
441440
or
442441
\tcode{stderr}.
443442
}
443+
444+
\pnum
445+
\recommended
446+
If it is possible for them to do so, implementations should
447+
initialize the objects earlier than required.
448+
449+
\pnum
444450
The results of including \libheader{iostream} in a translation unit shall be as if
445451
\libheader{iostream} defined an instance of \tcode{ios_base::Init} with static
446452
storage duration.
@@ -13707,10 +13713,10 @@
1370713713
\impldef{interpretation of the path character sequence with format \tcode{path::auto_format}}.
1370813714
The implementation may inspect the content of the character sequence to
1370913715
determine the format.
13710-
\begin{note}
13716+
13717+
\recommended
1371113718
For POSIX-based systems, native and generic formats are equivalent
1371213719
and the character sequence should always be interpreted in the same way.
13713-
\end{note}
1371413720
\\\rowsep
1371513721
\end{floattable}
1371613722

source/iterators.tex

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1435,11 +1435,15 @@
14351435
\end{itemize}
14361436

14371437
\pnum
1438+
\recommended
1439+
The implementaton of an algorithm on a weakly incrementable type
1440+
should never attempt to pass through the same incrementable value twice;
1441+
such an algorithm should be a single-pass algorithm.
14381442
\begin{note}
14391443
For \libconcept{weakly_incrementable} types, \tcode{a} equals \tcode{b} does not imply that \tcode{++a}
14401444
equals \tcode{++b}. (Equality does not guarantee the substitution property or referential
1441-
transparency.) Algorithms on weakly incrementable types should never attempt to pass
1442-
through the same incrementable value twice. They should be single-pass algorithms. These algorithms
1445+
transparency.)
1446+
Such algorithms
14431447
can be used with istreams as the source of the input data through the \tcode{istream_iterator} class
14441448
template.
14451449
\end{note}
@@ -1667,10 +1671,10 @@
16671671
\end{codeblock}
16681672

16691673
\pnum
1670-
\begin{note}
1671-
Algorithms on output iterators should never attempt to pass through the same iterator twice.
1672-
They should be single-pass algorithms.
1673-
\end{note}
1674+
\recommended
1675+
The implementation of an algorithm on output iterators
1676+
should never attempt to pass through the same iterator twice;
1677+
such an algorithm should be a single-pass algorithm.
16741678

16751679
\rSec3[iterator.concept.forward]{Concept \cname{forward_iterator}}
16761680

@@ -2013,18 +2017,15 @@
20132017
\end{libreqtab4b}
20142018

20152019
\pnum
2020+
\recommended
2021+
The implementation of an algorithm on input iterators
2022+
should never attempt to pass through the same iterator twice;
2023+
such an algorithm should be a single pass algorithm.
20162024
\begin{note}
2017-
For input iterators,
2018-
\tcode{a == b}
2019-
does not imply
2020-
\tcode{++a == ++b}.
2025+
For input iterators, \tcode{a == b} does not imply \tcode{++a == ++b}.
20212026
(Equality does not guarantee the substitution property or referential transparency.)
2022-
Algorithms on input iterators should never attempt to pass through the same iterator twice.
2023-
They should be
2024-
\term{single pass}
2025-
algorithms.
20262027
Value type \tcode{T} is not required to be a \oldconcept{CopyAssignable} type (\tref{cpp17.copyassignable}).
2027-
These algorithms can be used with istreams as the source of the input data through the
2028+
Such an algorithm can be used with istreams as the source of the input data through the
20282029
\tcode{istream_iterator}
20292030
class template.
20302031
\end{note}
@@ -2074,13 +2075,14 @@
20742075
\end{libreqtab4b}
20752076

20762077
\pnum
2078+
\recommended
2079+
The implementation of an algorithm on output iterators
2080+
should never attempt to pass through the same iterator twice;
2081+
such an algorithm should be a single-pass algorithm.
20772082
\begin{note}
2078-
The only valid use of an
2079-
\tcode{operator*}
2083+
The only valid use of an \tcode{operator*}
20802084
is on the left side of the assignment statement.
20812085
Assignment through the same value of the iterator happens only once.
2082-
Algorithms on output iterators should never attempt to pass through the same iterator twice.
2083-
They should be single-pass algorithms.
20842086
Equality and inequality might not be defined.
20852087
\end{note}
20862088

source/lib-intro.tex

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1668,11 +1668,9 @@
16681668
Thus all evaluations of the expression \tcode{h(k)} with the
16691669
same value for \tcode{k} yield the same result for a given execution of the program.
16701670
\end{note}
1671-
\begin{note}
1672-
For two different
1671+
For two different
16731672
values \tcode{t1} and \tcode{t2}, the probability that \tcode{h(t1)} and \tcode{h(t2)}
16741673
compare equal should be very small, approaching \tcode{1.0 / numeric_limits<size_t>::max()}.
1675-
\end{note}
16761674
\\ \rowsep
16771675
\tcode{h(u)} &
16781676
\tcode{size_t} &

source/locales.tex

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3448,11 +3448,12 @@
34483448
on any other string for which
34493449
\tcode{do_compare()}
34503450
returns 0 (equal) when passed the two strings.
3451-
\begin{note}
3451+
3452+
\pnum
3453+
\recommended
34523454
The probability that the result equals that for another string which does
34533455
not compare equal should be very small, approaching
34543456
\tcode{(1.0/numeric_limits<unsigned long>::max())}.
3455-
\end{note}
34563457
\end{itemdescr}
34573458

34583459
\rSec3[locale.collate.byname]{Class template \tcode{collate_byname}}

source/ranges.tex

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1016,8 +1016,7 @@
10161016
\tcode{ranges::begin} and \tcode{ranges::end}.
10171017
Since \tcode{ranges::begin} is not required to be equality-preserving
10181018
when the return type does not model \libconcept{forward_iterator}, repeated calls
1019-
might not return equal values or might not be well-defined;
1020-
\tcode{ranges::begin} should be called at most once for such a range.
1019+
might not return equal values or might not be well-defined.
10211020
\end{note}
10221021
\end{itemdescr}
10231022

source/support.tex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5403,8 +5403,8 @@
54035403
\pnum
54045404
\begin{note}
54055405
The types \tcode{suspend_never} and \tcode{suspend_always} can be used
5406-
to indicate that an \grammarterm{await-expression} should either never
5407-
suspend or always suspend, and in either case not produce a value.
5406+
to indicate that an \grammarterm{await-expression} either never
5407+
suspends or always suspends, and in either case does not produce a value.
54085408
\end{note}
54095409

54105410
\rSec1[support.runtime]{Other runtime support}

0 commit comments

Comments
 (0)