[#BloombergLP-bslalg-RbTreeUtil-leftmost-09]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslalg.adoc[bslalg]::xref:BloombergLP/bslalg/RbTreeUtil.adoc[RbTreeUtil]::leftmost
:relfileprefix: ../../../
:mrdocs:

Return the address of the leftmost node in the specified `subtree`.

== Synopsis

Declared in `<bslalg_rbtreeutil.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
xref:BloombergLP/bslalg/RbTreeNode.adoc[RbTreeNode] const*
leftmost(xref:BloombergLP/bslalg/RbTreeNode.adoc[RbTreeNode] const* subtree);
----

== Description

Return the address of the leftmost node in the specified `subtree`, and `subtree` if `subtree` has no left child. The behavior is undefined unless `0 != subtree`, and `subtree` refers to a valid binary tree. Note that the value held by the returned node will not compare greater than that of any other node in `subtree` (as determined by the comparator used to organize the red‐black subtree data).

== Return Value

address of the leftmost node in `subtree`

== Parameters

[cols="1,4"]
|===
| Name| Description
| *subtree*
| root of the subtree to search
|===


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