1=pod 2 3=head1 NAME 4 5BN_cmp, BN_ucmp, BN_is_zero, BN_is_one, BN_is_word, BN_abs_is_word, BN_is_odd - BIGNUM comparison and test functions 6 7=head1 SYNOPSIS 8 9 #include <openssl/bn.h> 10 11 int BN_cmp(const BIGNUM *a, const BIGNUM *b); 12 int BN_ucmp(const BIGNUM *a, const BIGNUM *b); 13 14 int BN_is_zero(const BIGNUM *a); 15 int BN_is_one(const BIGNUM *a); 16 int BN_is_word(const BIGNUM *a, const BN_ULONG w); 17 int BN_abs_is_word(const BIGNUM *a, const BN_ULONG w); 18 int BN_is_odd(const BIGNUM *a); 19 20=head1 DESCRIPTION 21 22BN_cmp() compares the numbers I<a> and I<b>. BN_ucmp() compares their 23absolute values. 24 25BN_is_zero(), BN_is_one(), BN_is_word() and BN_abs_is_word() test if 26I<a> equals 0, 1, I<w>, or E<verbar>I<w>E<verbar> respectively. 27BN_is_odd() tests if I<a> is odd. 28 29=head1 RETURN VALUES 30 31BN_cmp() returns -1 if I<a> E<lt> I<b>, 0 if I<a> == I<b> and 1 if 32I<a> E<gt> I<b>. BN_ucmp() is the same using the absolute values 33of I<a> and I<b>. 34 35BN_is_zero(), BN_is_one() BN_is_word(), BN_abs_is_word() and 36BN_is_odd() return 1 if the condition is true, 0 otherwise. 37 38=head1 HISTORY 39 40Prior to OpenSSL 1.1.0, BN_is_zero(), BN_is_one(), BN_is_word(), 41BN_abs_is_word() and BN_is_odd() were macros. 42 43=head1 COPYRIGHT 44 45Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved. 46 47Licensed under the Apache License 2.0 (the "License"). You may not use 48this file except in compliance with the License. You can obtain a copy 49in the file LICENSE in the source distribution or at 50L<https://www.openssl.org/source/license.html>. 51 52=cut 53
