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

This class implements an efficient value‐semantic, ordered set of `DayOfWeek` values. This set requires a fixed capacity, and all operations operate in constant time, and provide the no‐throw guarantee.

== Synopsis

Declared in `<bdlt_dayofweekset.h>`

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

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/DayOfWeekSet/const_iterator.adoc[`const_iterator`] 
| Standard nested alias for set container's constant iterator.
| xref:BloombergLP/bdlt/DayOfWeekSet/const_reverse_iterator.adoc[`const_reverse_iterator`] 
| Standard nested alias for set container's constant reverse iterator.
| xref:BloombergLP/bdlt/DayOfWeekSet/iterator.adoc[`iterator`] 
| Standard nested alias for set container's iterator.
| xref:BloombergLP/bdlt/DayOfWeekSet/reverse_iterator.adoc[`reverse_iterator`] 
| Standard nested alias for set container's reverse iterator.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/DayOfWeekSet/2constructor-0b45.adoc[`DayOfWeekSet`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdlt/DayOfWeekSet/2destructor.adoc[`~DayOfWeekSet`] [.small]#[destructor]#
| Destroy this object.
| xref:BloombergLP/bdlt/DayOfWeekSet/operator_assign.adoc[`operator=`] 
| Assign to this set the value of the specified `rhs` set, and return a reference providing modifiable access to this set.
| xref:BloombergLP/bdlt/DayOfWeekSet/add.adoc[`add`] 
| Add the specified `value` to this set.
| xref:BloombergLP/bdlt/DayOfWeekSet/areMembers.adoc[`areMembers`] 
| Return `true` if this set contains all elements of the specified `set`, and `false` otherwise.
| xref:BloombergLP/bdlt/DayOfWeekSet/bdexStreamIn.adoc[`bdexStreamIn`] 
| Assign to this object the value read from the specified input `stream` using the specified `version` format, and return a reference to `stream`. If `stream` is initially invalid, this operation has no effect. If `version` is not supported, this object is unaltered and `stream` is invalidated, but otherwise unmodified. If `version` is supported but `stream` becomes invalid during this operation, this object has an undefined, but valid, state. Note that no version is read from `stream`. See the `bslx` package‐level documentation for more information on BDEX streaming of value‐semantic types and containers.
| xref:BloombergLP/bdlt/DayOfWeekSet/bdexStreamOut.adoc[`bdexStreamOut`] 
| Write the value of this object, using the specified `version` format, to the specified output `stream`, and return a reference to `stream`. If `stream` is initially invalid, this operation has no effect. If `version` is not supported, `stream` is invalidated, but otherwise unmodified. Note that `version` is not written to `stream`. See the `bslx` package‐level documentation for more information on BDEX streaming of value‐semantic types and containers.
| xref:BloombergLP/bdlt/DayOfWeekSet/begin.adoc[`begin`] 
| Return an iterator referencing the first valid element in this set.
| xref:BloombergLP/bdlt/DayOfWeekSet/end.adoc[`end`] 
| Return an iterator indicating one position past the last possible element in this set.
| xref:BloombergLP/bdlt/DayOfWeekSet/isEmpty.adoc[`isEmpty`] 
| Return `true` if there are no elements in this set, and `false` otherwise.
| xref:BloombergLP/bdlt/DayOfWeekSet/isMember.adoc[`isMember`] 
| Return `true` if the specified `value` is an element of this set, and `false` otherwise.
| xref:BloombergLP/bdlt/DayOfWeekSet/length.adoc[`length`] 
| Return the number of elements in this set.
| xref:BloombergLP/bdlt/DayOfWeekSet/operator_and_eq.adoc[`operator&=`] 
| Assign to this set the intersection of this set with the specified `rhs` set (i.e., a set containing elements that are in both this set and the `rhs` set), and return a reference providing modifiable access to this set.
| xref:BloombergLP/bdlt/DayOfWeekSet/operator_minus_eq.adoc[`operator‐=`] 
| Assign to this set the subtraction of the specified `rhs` set from this set (i.e., a set containing elements that are in this set, but not in the `rhs` set), and return a reference providing modifiable access to this set.
| xref:BloombergLP/bdlt/DayOfWeekSet/operator_xor_eq.adoc[`operatorˆ=`] 
| Assign to this set the exclusive‐or of this set with the specified `rhs` set (i.e., a set containing elements that are either in this set, but not `rhs`, or in `rhs`, but not in this set), and return a reference providing modifiable access to this set.
| xref:BloombergLP/bdlt/DayOfWeekSet/operator_or_eq.adoc[`operator|=`] 
| Assign to this set the union of this set with the specified `rhs` set (i.e., a set containing elements that are in either this set or the `rhs` set, or in both sets), and return a reference providing modifiable access to this set.
| xref:BloombergLP/bdlt/DayOfWeekSet/print.adoc[`print`] 
| Format this object to the specified output `stream` at the (absolute value of) the optionally specified indentation `level`, and return a reference to `stream`. If `level` is specified, optionally specify `spacesPerLevel`, the number of spaces per indentation level for this and all of its nested objects. If `level` is negative, suppress indentation of the first line. If `spacesPerLevel` is negative, format the entire output on one line, suppressing all but the initial indentation (as governed by `level`). If `stream` is not valid on entry, this operation has no effect.
| xref:BloombergLP/bdlt/DayOfWeekSet/rbegin.adoc[`rbegin`] 
| Return a reverse iterator referencing the last valid element in this set.
| xref:BloombergLP/bdlt/DayOfWeekSet/remove.adoc[`remove`] 
| Remove the specified `value` from this set. Return `true` if `value` was a member of this set, and `false` otherwise.
| xref:BloombergLP/bdlt/DayOfWeekSet/removeAll.adoc[`removeAll`] 
| Remove all members of this set.
| xref:BloombergLP/bdlt/DayOfWeekSet/rend.adoc[`rend`] 
| Return a reverse iterator indicating one position before the first possible element in this set.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/DayOfWeekSet/maxSupportedBdexVersion-06d.adoc[`maxSupportedBdexVersion`] 
| `maxSupportedBdexVersion` overloads
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bdlt/hashAppend-07f.adoc[BloombergLP::bdlt::hashAppend]`
| Pass the specified `object` to the specified `hashAlg`. This function integrates with the `bslh` modular hashing system and effectively provides a `bsl::hash` specialization for `DayOfWeekSet`.
| `xref:BloombergLP/bdlt/operator_bitnot.adoc[BloombergLP::bdlt::operator~]`
| Return a set containing the complement of the specified `set` (i.e., those members _not_ contained in `set`).
| `xref:BloombergLP/bdlt/operator_not_eq-090.adoc[BloombergLP::bdlt::operator!=]`
| Return `true` if the specified `lhs` and `rhs` sets do not have the same value, and `false` otherwise. Two sets do not have the same value if they differ in length or there exists an element of one set that is not a member of the other set.
| `xref:BloombergLP/bdlt/operator_eq-021.adoc[BloombergLP::bdlt::operator==]`
| Return `true` if the specified `lhs` and `rhs` sets have the same value, and `false` otherwise. Two sets have the same value if they have the same length and all the elements of one set are members of the other set.
|===

== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/operator_bitand.adoc[`operator&`]
| Return a set containing the intersection of the specified `lhs` and `rhs` sets (i.e., a set containing elements that are in both `lhs` and `rhs`).
| xref:BloombergLP/bdlt/operator_minus-0b.adoc[`operator‐`]
| Return a set containing the subtraction of the specified `rhs` set from the specified `lhs` set (i.e., a set containing elements that are in `lhs`, but not in `rhs`).
| xref:BloombergLP/bdlt/operator_xor.adoc[`operatorˆ`]
| Return a set containing the exclusive‐or of the specified `lhs` and `rhs` sets (i.e., a set containing elements that are either in `lhs`, but not `rhs`, or in `rhs`, but not `lhs`).
| xref:BloombergLP/bdlt/operator_bitor.adoc[`operator|`]
| Return a set containing the union of the specified `lhs` and `rhs` sets (i.e., a set containing elements that are in either `lhs` or `rhs` or both).
|===


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