.\" Copyright (C) 2022 Alejandro Colomar <alx@kernel.org>
.\"
.\" SPDX-License-Identifier: Linux-man-pages-copyleft
.\"
.TH powerof2 3 2023-10-31 "Linux man-pages 6.06"
.SH NAME
powerof2 \- test if a value is a power of 2
.SH LIBRARY
Standard C library
.RI ( libc )
.SH SYNOPSIS
.nf
.B #include <sys/param.h>
.P
.BI "int powerof2(" x );
.fi
.SH DESCRIPTION
This macro returns true if
.I x
is a power of 2,
and false otherwise.
.P
.B 0
is considered a power of 2.
This can make sense considering wrapping of unsigned integers,
and has interesting properties.
.SH RETURN VALUE
True or false,
if
.I x
is a power of 2 or not,
respectively.
.SH STANDARDS
BSD.
.SH CAVEATS
The arguments may be evaluated more than once.
.P
Because this macro is implemented using bitwise operations,
some negative values can invoke undefined behavior.
For example,
the following invokes undefined behavior:
.IR "powerof2(INT_MIN);".
Call it only with unsigned types to be safe.
.SH SEE ALSO
.BR stdc_bit_ceil (3),
.BR stdc_bit_floor (3)