BloombergLP::bdlc::Queue

Name

Description

InitialCapacity

Enable uniform use of an optional integral constructor argument to specify the initial internal capacity (in elements). For example, ` Queue<unsigned int> x(Queue::InitialCapacity(8)); ` instantiates an object x with an initial capacity of 8 elements, but with a logical length of 0 elements.

Name

Description

Queue [constructor]

Constructors

~Queue [destructor]

Destroy this object.

operator=

Assign to this queue the value of the specified rhs queue and return a reference to this modifiable queue.

append

append overloads

back

back overloads

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.

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.

front

front overloads

insert

insert overloads

length

Return the number of elements in this queue.

operator[]

Subscript operators

popBack

Remove the value from the back of this queue efficiently (in O[1] time). The behavior is undefined if this queue is empty. Note that this function is logically equivalent to (but more efficient than): ` remove(length() ‐ 1) `

popFront

Remove the value from the front of this queue efficiently (in O[1] time). The behavior is undefined if this queue is empty. Note that this function is logically equivalent to (but more efficient than): ` remove(0) `

print

Format this object to the specified output stream at the optionally specified indentation level and return a reference to the modifiable stream. If level is specified, optionally specify spacesPerLevel, the number of spaces per indentation level for this and all of its nested objects. Each line is indented by the absolute value of level * spacesPerLevel. If level is negative, suppress indentation of the first line. If spacesPerLevel is negative, suppress line breaks and format the entire output on one line. If stream is initially invalid, this operation has no effect. Note that a trailing newline is provided in multi‐line mode only.

pushBack

Append the specified item to the back of this queue efficiently (in O[1]time when memory reallocation is not required). Note that this function is logically equivalent to (but generally more efficient than): ` insert(length(), item); `

pushFront

Insert the specified item into the front of this queue efficiently (in O[1]time when memory reallocation is not required). Note that this function is logically equivalent to (but generally more efficient than): ` insert(0, item); `

remove

remove overloads

removeAll

Remove all elements from this queue. If the optionally specified buffer is not 0, append to buffer a copy of each element removed (in front‐to‐back order of the elements in the queue prior to the invocation of this method).

replace

replace overloads

reserveCapacity

Reserve sufficient internal capacity to accommodate up to the specified numElements values without subsequent reallocation. Note that if numElements <= length(), this operation has no effect.

reserveCapacityRaw

Reserve sufficient and minimal internal capacity to accommodate up to the specified numElements values without subsequent reallocation. Beware, however, that repeated calls to this function may invalidate bounds on runtime complexity otherwise guaranteed by this container. Note that if numElements <= length(), this operation has no effect.

setLength

setLength overloads

setLengthRaw

Set the length of this queue to the specified newLength. If newLength is less than the current length, elements at index positions at or above newLength are removed. If newLength is equal to the current length, this function has no effect. Otherwise new elements at or above the current length are not initialized to any value.

streamOut

Write the elements of this queue out to the specified stream. Note that for this method to compile, operator<< has to be defined for arguments stream and type T.

swap

Swap efficiently the values at the specified indices index1 and index2. The behavior is undefined unless 0 <= index1 < length() and 0 <= index2 < length().

operator BloombergLP::bslmf::NestedTraitDeclaration<Queue, HasPrintMethod>

Declare that this type has a print method.

operator BloombergLP::bslmf::NestedTraitDeclaration<Queue, UsesBslmaAllocator>

Declare that this type uses a bslma allocator.

Name

Description

maxSupportedBdexVersion

maxSupportedBdexVersion overloads

maxSupportedVersion

Return the most current bdex streaming version number supported by this class. (See the package‐group‐level documentation for more information on bdex streaming of container types.)

Name

Description

operator!=

Return true if the specified lhs and rhs queues do not have the same value, and false otherwise. Two queues do not have the same value if they have different lengths or differ in at least one index position.

operator==

Return true if the specified lhs and rhs queues have the same value, and false otherwise. Two queues have the same value if they have the same length and the same element value at each respective index position.