159191Skris=pod
259191Skris
359191Skris=head1 NAME
459191Skris
559191SkrisBN_cmp, BN_ucmp, BN_is_zero, BN_is_one, BN_is_word, BN_is_odd - BIGNUM comparison and test functions
659191Skris
759191Skris=head1 SYNOPSIS
859191Skris
959191Skris #include <openssl/bn.h>
1059191Skris
1159191Skris int BN_cmp(BIGNUM *a, BIGNUM *b);
1259191Skris int BN_ucmp(BIGNUM *a, BIGNUM *b);
1359191Skris
1459191Skris int BN_is_zero(BIGNUM *a);
1559191Skris int BN_is_one(BIGNUM *a);
1659191Skris int BN_is_word(BIGNUM *a, BN_ULONG w);
1759191Skris int BN_is_odd(BIGNUM *a);
1859191Skris
1959191Skris=head1 DESCRIPTION
2059191Skris
2159191SkrisBN_cmp() compares the numbers B<a> and B<b>. BN_ucmp() compares their
2259191Skrisabsolute values.
2359191Skris
2459191SkrisBN_is_zero(), BN_is_one() and BN_is_word() test if B<a> equals 0, 1,
2559191Skrisor B<w> respectively. BN_is_odd() tests if a is odd.
2659191Skris
2759191SkrisBN_is_zero(), BN_is_one(), BN_is_word() and BN_is_odd() are macros.
2859191Skris
2959191Skris=head1 RETURN VALUES
3059191Skris
3159191SkrisBN_cmp() returns -1 if B<a> E<lt> B<b>, 0 if B<a> == B<b> and 1 if
3259191SkrisB<a> E<gt> B<b>. BN_ucmp() is the same using the absolute values
3359191Skrisof B<a> and B<b>.
3459191Skris
3559191SkrisBN_is_zero(), BN_is_one() BN_is_word() and BN_is_odd() return 1 if
3659191Skristhe condition is true, 0 otherwise.
3759191Skris
3859191Skris=head1 SEE ALSO
3959191Skris
4059191SkrisL<bn(3)|bn(3)>
4159191Skris
4259191Skris=head1 HISTORY
4359191Skris
4459191SkrisBN_cmp(), BN_ucmp(), BN_is_zero(), BN_is_one() and BN_is_word() are
4559191Skrisavailable in all versions of SSLeay and OpenSSL.
4659191SkrisBN_is_odd() was added in SSLeay 0.8.
4759191Skris
4859191Skris=cut
49