xref: /illumos-gate/usr/src/man/man3avl/avl_is_empty.3avl (revision 14b24e2b79293068c8e016a69ef1d872fb5e2fd5)
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.
33If
34.Fa tree
35has zero nodes in it, then
36.Sy B_TRUE
37is returned, otherwise
38.Sy B_FALSE
39is returned.
40.Sh RETURN VALUES
41The
42.Fn avl_is_empty
43function returns
44.Sy B_TRUE
45when there are no nodes in the tree and
46.Sy B_FALSE
47otherwise.
48.Sh EXAMPLES
49See the
50.Sy EXAMPLES
51section in
52.Xr libavl 3LIB .
53.Sh INTERFACE STABILITY
54.Sy Committed
55.Sh MT-Level
56See
57.Sx Locking
58in
59.Xr libavl 3LIB .
60.Sh SEE ALSO
61.Xr libavl 3LIB
62