You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: website/docs/api/classes/micro-os-plus-utils-double-list-iterator.mdx
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -306,7 +306,7 @@ The default constructor for <code><Link to="/docs/api/classes/micro-os-plus/util
306
306
The internal node pointer is value-initialised (set to <code>nullptr</code>), ensuring that the iterator is safe to use in comparisons and will not dereference an invalid address.
307
307
:::
308
308
309
-
Declaration at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00528">528</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Linkto="/docs/api/files/include/micro-os-plus/utils/inlines-h/#l00285">285</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/inlines-h">inlines.h</Link>.
309
+
Declaration at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00528">528</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h/#l00285">285</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h">lists-inlines.h</Link>.
@@ -322,7 +322,7 @@ Construct an iterator from a node pointer.
322
322
</ParametersList>
323
323
This constructor creates a <code><Linkto="/docs/api/classes/micro-os-plus/utils/double-list-iterator">double_list_iterator</Link></code> that points to the specified node. The internal node pointer is set to the provided node address, allowing the iterator to traverse the list starting from that node. This constructor is typically used to initialise an iterator to a specific position within the list, such as the beginning or end.
324
324
325
-
Declaration at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00535">535</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Linkto="/docs/api/files/include/micro-os-plus/utils/inlines-h/#l00298">298</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/inlines-h">inlines.h</Link>.
325
+
Declaration at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00535">535</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h/#l00298">298</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h">lists-inlines.h</Link>.
Returns the internal node pointer that the iterator currently references. This is useful for advanced list operations or when direct access to the underlying node structure is required, such as for interoperability with other list utilities or for debugging purposes.
367
367
368
-
Declaration at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00634">634</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Linkto="/docs/api/files/include/micro-os-plus/utils/inlines-h/#l00455">455</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/inlines-h">inlines.h</Link>.
368
+
Declaration at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00634">634</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h/#l00455">455</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h">lists-inlines.h</Link>.
The inequality comparison operator (<code>operator!=</code>) checks whether two iterators point to different nodes in the list by comparing their internal node pointers. This is useful for standard iterator operations, such as determining whether an iterator has reached the end of a range or for loop termination conditions.
408
408
409
-
Declaration at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00614">614</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Linkto="/docs/api/files/include/micro-os-plus/utils/inlines-h/#l00440">440</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/inlines-h">inlines.h</Link>.
409
+
Declaration at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00614">614</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h/#l00440">440</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h">lists-inlines.h</Link>.
@@ -425,7 +425,7 @@ The dereference operator (<code>operator*</code>) provides access to the val
425
425
426
426
This allows the iterator to be used in a manner similar to standard C++ iterators, enabling direct access to the list element for reading or modification.
427
427
428
-
Declaration at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00562">562</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Linkto="/docs/api/files/include/micro-os-plus/utils/inlines-h/#l00343">343</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/inlines-h">inlines.h</Link>.
428
+
Declaration at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00562">562</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h/#l00343">343</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h">lists-inlines.h</Link>.
@@ -442,7 +442,7 @@ Reference to the incremented iterator.
442
442
443
443
The pre-increment operator (<code>operator++</code>) advances the iterator to the next node in the list. It updates the internal node pointer to point to the node returned by the current node's <code>next()</code> method. This allows the iterator to traverse the list in the forward direction, following the linked structure.
444
444
445
-
Declaration at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00570">570</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Linkto="/docs/api/files/include/micro-os-plus/utils/inlines-h/#l00358">358</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/inlines-h">inlines.h</Link>.
445
+
Declaration at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00570">570</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h/#l00358">358</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h">lists-inlines.h</Link>.
The post-increment operator (<code><Linkto="#a60ce68c08d226be1b5ff5bc92e21a4fc">operator++(int)</Link></code>) advances the iterator to the next node in the list, but returns a copy of the iterator as it was before the increment. This allows iteration logic that requires access to the current element before moving to the next one, following the standard C++ iterator semantics for post-increment.
461
461
462
-
Declaration at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00578">578</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Linkto="/docs/api/files/include/micro-os-plus/utils/inlines-h/#l00374">374</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/inlines-h">inlines.h</Link>.
462
+
Declaration at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00578">578</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h/#l00374">374</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h">lists-inlines.h</Link>.
@@ -476,7 +476,7 @@ Reference to the decremented iterator.
476
476
477
477
The pre-decrement operator (<code>operator--</code>) moves the iterator to the previous node in the list. It updates the internal node pointer to point to the node returned by the current node's <code>previous</code> pointer. This enables backward traversal of the list, following the linked structure in reverse.
478
478
479
-
Declaration at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00586">586</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Linkto="/docs/api/files/include/micro-os-plus/utils/inlines-h/#l00391">391</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/inlines-h">inlines.h</Link>.
479
+
Declaration at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00586">586</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h/#l00391">391</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h">lists-inlines.h</Link>.
The post-decrement operator (<code><Linkto="#a1bc00178e8a6da8c816716236fd60be1">operator--(int)</Link></code>) moves the iterator to the previous node in the list, but returns a copy of the iterator as it was before the decrement. This enables iteration logic that requires access to the current element before moving backward, following the standard C++ iterator semantics for post-decrement.
495
495
496
-
Declaration at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00594">594</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Linkto="/docs/api/files/include/micro-os-plus/utils/inlines-h/#l00407">407</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/inlines-h">inlines.h</Link>.
496
+
Declaration at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00594">594</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h/#l00407">407</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h">lists-inlines.h</Link>.
@@ -510,7 +510,7 @@ Pointer to the value pointed to by the iterator.
510
510
511
511
The pointer access operator (<code>operator-></code>) allows the iterator to provide direct access to the value pointed to by the iterator, mimicking the behavior of a raw pointer. Internally, it calls <code><Linkto="#a4dda1a12bf05e974cc3e6394f28302a0">get_pointer()</Link></code>, which computes and returns a pointer to the underlying value or object associated with the current node in the list.
512
512
513
-
Declaration at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00554">554</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Linkto="/docs/api/files/include/micro-os-plus/utils/inlines-h/#l00325">325</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/inlines-h">inlines.h</Link>.
513
+
Declaration at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00554">554</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h/#l00325">325</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h">lists-inlines.h</Link>.
The equality comparison operator (<code>operator==</code>) checks whether two iterators point to the same node in the list by comparing their internal node pointers. This allows for standard iterator comparisons, such as detecting the end of a range or verifying if two iterators refer to the same position.
533
533
534
-
Declaration at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00604">604</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Linkto="/docs/api/files/include/micro-os-plus/utils/inlines-h/#l00424">424</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/inlines-h">inlines.h</Link>.
534
+
Declaration at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00604">604</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h/#l00424">424</Link> of file <Linkto="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h">lists-inlines.h</Link>.
535
535
</MemberDefinition>
536
536
537
537
</SectionDefinition>
@@ -541,7 +541,7 @@ Declaration at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-
541
541
The documentation for this class was generated from the following files:
0 commit comments