xref: /titanic_50/usr/src/man/man3avl/avl_is_empty.3avl (revision 356f72340a69936724c69f2f87fffa6f5887f885)
1.\"
2.\" This file and its contents are supplied under the terms of the
3.\" Common Development and Distribution License ("CDDL"), version 1.0.
4.\" You may only use this file in accordance with the terms of version
5.\" 1.0 of the CDDL.
6.\"
7.\" A full copy of the text of the CDDL should have accompanied this
8.\" source.  A copy of the CDDL is also available via the Internet at
9.\" http://www.illumos.org/license/CDDL.
10.\"
11.\"
12.\" Copyright 2015 Joyent, Inc.
13.\"
14.Dd May 07, 2015
15.Dt AVL_IS_EMPTY 3AVL
16.Os
17.Sh NAME
18.Nm avl_is_empty
19.Nd determine if an AVL tree is empty
20.Sh SYNOPSIS
21.Lb libavl
22.In sys/avl.h
23.Ft boolean_t
24.Fo avl_is_empty
25.Fa "avl_tree_t *tree"
26.Fc
27.Sh DESCRIPTION
28The
29.Fn avl_is_empty
30function is used to determine whether or not the AVL tree,
31.Fa tree ,
32is empty. If
33.Fa tree
34has zero nodes in it, then
35.Sy B_TRUE
36is returned, otherwise
37.Sy B_FALSE
38is returned.
39.Sh RETURN VALUES
40The
41.Fn avl_is_empty
42function returns
43.Sy B_TRUE
44when there are no nodes in the tree and
45.Sy B_FALSE
46otherwise.
47.Sh EXAMPLES
48See the
49.Sy EXAMPLES
50section in
51.Xr libavl 3LIB .
52.Sh INTERFACE STABILITY
53.Sy Committed
54.Sh MT-Level
55See
56.Sx Locking
57in
58.Xr libavl 3LIB .
59.Sh SEE ALSO
60.Xr libavl 3LIB
61