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