[#BloombergLP-bdlt-DayOfWeekSet_Iter]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlt.adoc[bdlt]::DayOfWeekSet_Iter
:relfileprefix: ../../
:mrdocs:

Implementation of standard bidirectional iterator for `DayOfWeekSet`. Any modification of a `DayOfWeekSet` will invalidate any iterators referring to that `DayOfWeekSet`.

== Synopsis

Declared in `<bdlt_dayofweekset.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class DayOfWeekSet_Iter;
----

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/DayOfWeekSet_Iter/difference_type.adoc[`difference_type`] 
| Iterator difference type.
| xref:BloombergLP/bdlt/DayOfWeekSet_Iter/iterator_category.adoc[`iterator_category`] 
| Iterator category for this day‐of‐week iterator.
| xref:BloombergLP/bdlt/DayOfWeekSet_Iter/pointer.adoc[`pointer`] 
| Iterator pointer type.
| xref:BloombergLP/bdlt/DayOfWeekSet_Iter/reference.adoc[`reference`] 
| Iterator reference type.
| xref:BloombergLP/bdlt/DayOfWeekSet_Iter/value_type.adoc[`value_type`] 
| Iterator value type.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/DayOfWeekSet_Iter/2constructor-02.adoc[`DayOfWeekSet_Iter`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdlt/DayOfWeekSet_Iter/2destructor.adoc[`~DayOfWeekSet_Iter`] [.small]#[destructor]#
| Destroy this iterator.
| xref:BloombergLP/bdlt/DayOfWeekSet_Iter/operator_assign.adoc[`operator=`] 
| Assign to this iterator the value of the specified `rhs` iterator, and return a reference providing modifiable access to this iterator.
| xref:BloombergLP/bdlt/DayOfWeekSet_Iter/operator_star.adoc[`operator*`] 
| Return a reference providing non‐modifiable access to the day of week value referenced by this iterator. The behavior is undefined unless the iterator refers to a valid day of the week, specifically, the behavior is undefined if `*this == end()`.
| xref:BloombergLP/bdlt/DayOfWeekSet_Iter/operator_inc-0f.adoc[`operator++`] 
| Increment operators
| xref:BloombergLP/bdlt/DayOfWeekSet_Iter/operator_dec-0db.adoc[`operator‐‐`] 
| Decrement operators
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/DayOfWeekSet_Iter/d_data.adoc[`d_data`] 
| Copy of the days‐of‐week bitmask from the original container.
| xref:BloombergLP/bdlt/DayOfWeekSet_Iter/d_index.adoc[`d_index`] 
| Current position in the iteration; value in `[0 .. 8]`.
|===


== Static Data Members

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/DayOfWeekSet_Iter/s_dayOfWeekArray.adoc[`s_dayOfWeekArray`] 
| Lookup table mapping iterator indices to day‐of‐week values.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bdlt/operator_eq-0e.adoc[BloombergLP::bdlt::operator==]`
| Return `true` if the specified `lhs` and `rhs` iterators have the same value, and `false` otherwise. Two iterators have the same value if they refer to data at the same index position. The behavior is undefined unless `lhs` and `rhs` both reference into the same set of data.
|===

== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/operator_not_eq-0b.adoc[`operator!=`]
| Return `true` if the specified `lhs` and `rhs` iterators do not have the same value, and `false` otherwise. Two iterators do not have the same value if they do not refer to data at the same index position. The behavior is undefined unless `lhs` and `rhs` both reference into the same set of data.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#