[#BloombergLP-bslalg-RbTreeAnchor]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslalg.adoc[bslalg]::RbTreeAnchor
:relfileprefix: ../../
:mrdocs:

An `RbTreeAnchor` provides the addresses of the first and root nodes of a binary search tree. An `RbTreeAnchor` is similar to an in‐core simply constrained (value‐semantic) attribute class, except that it does not supply equality‐comparison, copy‐construction, and copy‐assignment operations. Note that a node may not be copied because `sentinel` returns an address unique to each `RbTreeAnchor` object.

== Synopsis

Declared in `<bslalg_rbtreeanchor.h>`

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

== Description

This class: * is _exception‐neutral_ * is _alias‐safe_ * is `const` _thread‐safe_ For terminology see `bsldoc_glossary`.

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslalg/RbTreeAnchor/2constructor-01.adoc[`RbTreeAnchor`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bslalg/RbTreeAnchor/2destructor.adoc[`~RbTreeAnchor`] [.small]#[destructor]#
| Destroy this object.
| xref:BloombergLP/bslalg/RbTreeAnchor/decrementNumNodes.adoc[`decrementNumNodes`] 
| Decrement, by 1, the `numNodes` attribute of this object. The behavior is undefined unless `1 <= numNodes`.
| xref:BloombergLP/bslalg/RbTreeAnchor/firstNode-0c.adoc[`firstNode`] 
| `firstNode` overloads
| xref:BloombergLP/bslalg/RbTreeAnchor/incrementNumNodes.adoc[`incrementNumNodes`] 
| Increment, by 1, the `numNodes` attribute of this object. The behavior is undefined unless `numNodes <= INT_MAX ‐ 1`.
| xref:BloombergLP/bslalg/RbTreeAnchor/numNodes.adoc[`numNodes`] 
| Return the `numNodes` attribute of this object.
| xref:BloombergLP/bslalg/RbTreeAnchor/reset.adoc[`reset`] 
| Set the `rootNode`, `firstNode`, and `numNodes` attributes to the specified `rootNodeValue`, `firstNodeValue`, and `numNodes` respectively.
| xref:BloombergLP/bslalg/RbTreeAnchor/rootNode-0b.adoc[`rootNode`] 
| `rootNode` overloads
| xref:BloombergLP/bslalg/RbTreeAnchor/sentinel-05.adoc[`sentinel`] 
| `sentinel` overloads
| xref:BloombergLP/bslalg/RbTreeAnchor/setFirstNode.adoc[`setFirstNode`] 
| Set the `firstNode` attribute of this object to the specified `value`.
| xref:BloombergLP/bslalg/RbTreeAnchor/setNumNodes.adoc[`setNumNodes`] 
| Set the `numNodes` attribute of this object to the specified `value`. The behavior is undefined unless `0 <= value`.
| xref:BloombergLP/bslalg/RbTreeAnchor/setRootNode.adoc[`setRootNode`] 
| Set the `rootNode` attribute of this object to the specified `value`.
|===



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