Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
freebsd
GitHub Repository: freebsd/freebsd-src
Path: blob/main/lib/libc/stdbit/stdc_leading_ones.3
96290 views
.\"
.\" Copyright (c) 2025 Robert Clausecker <[email protected]>
.\"
.\" SPDX-License-Identifier: BSD-2-Clause
.\"
.Dd November 9, 2025
.Dt STDC_LEADING_ONES 3
.Os
.Sh NAME
.Nm stdc_leading_ones
.Nd find the number of leading ones in an integer
.Sh SYNOPSIS
.Lb libc
.In stdbit.h
.Ft unsigned int
.Fn stdc_leading_ones_uc "unsigned char value"
.Ft unsigned int
.Fn stdc_leading_ones_us "unsigned short value"
.Ft unsigned int
.Fn stdc_leading_ones_ui "unsigned int value"
.Ft unsigned int
.Fn stdc_leading_ones_ul "unsigned long value"
.Ft unsigned int
.Fn stdc_leading_ones_ull "unsigned long long value"
.Ft unsigned int
.Fn stdc_leading_ones "value"
.Sh DESCRIPTION
The
.Nm stdc_leading_ones_ Ns Em type Ns ()
family of functions returns the number of leading ones in
.Fa value ,
where 
.Fa value
is of type
.Va unsigned char ,
.Va unsigned short ,
.Va unsigned int ,
.Va unsigned long ,
or
.Va unsigned long long
for
.Em type
being
.Sy uc ,
.Sy us ,
.Sy ui ,
.Sy ul ,
or
.Sy ull
respectively.
The
.Fn stdc_leading_ones "value"
type-generic macro picks the appropriate
.Nm stdc_leading_ones_ Ns Em type Ns ()
function based on the type of
.Fa value .
.Sh RETURN VALUES
Returns the number of leading ones in
.Fa value .
If
.Fa value
is all ones,
the total number of bits in the type of
.Fa value
is returned.
.Sh SEE ALSO
.Xr stdbit 3 ,
.Xr stdc_leading_zeros 3 ,
.Xr stdc_trailing_ones 3 ,
.Xr stdc_first_leading_zero 3
.Sh STANDARDS
The
.Nm stdc_leading_ones_ Ns Em type Ns ()
family of functions and the
.Fn stdc_leading_ones
type-generic macro conform to
.St -isoC-2023 .
.Sh HISTORY
The
.Nm stdc_leading_ones_ Ns Em type Ns ()
family of functions and the
.Fn stdc_leading_ones
type-generic macro were added in
.Fx 15.1.
.Sh AUTHOR
.An Robert Clausecker Aq Mt [email protected]