Blame doc/man3/BN_cmp.pod

Packit c4476c
=pod
Packit c4476c
Packit c4476c
=head1 NAME
Packit c4476c
Packit c4476c
BN_cmp, BN_ucmp, BN_is_zero, BN_is_one, BN_is_word, BN_is_odd - BIGNUM comparison and test functions
Packit c4476c
Packit c4476c
=head1 SYNOPSIS
Packit c4476c
Packit c4476c
 #include <openssl/bn.h>
Packit c4476c
Packit c4476c
 int BN_cmp(BIGNUM *a, BIGNUM *b);
Packit c4476c
 int BN_ucmp(BIGNUM *a, BIGNUM *b);
Packit c4476c
Packit c4476c
 int BN_is_zero(BIGNUM *a);
Packit c4476c
 int BN_is_one(BIGNUM *a);
Packit c4476c
 int BN_is_word(BIGNUM *a, BN_ULONG w);
Packit c4476c
 int BN_is_odd(BIGNUM *a);
Packit c4476c
Packit c4476c
=head1 DESCRIPTION
Packit c4476c
Packit c4476c
BN_cmp() compares the numbers B and B. BN_ucmp() compares their
Packit c4476c
absolute values.
Packit c4476c
Packit c4476c
BN_is_zero(), BN_is_one() and BN_is_word() test if B equals 0, 1,
Packit c4476c
or B<w> respectively. BN_is_odd() tests if a is odd.
Packit c4476c
Packit c4476c
BN_is_zero(), BN_is_one(), BN_is_word() and BN_is_odd() are macros.
Packit c4476c
Packit c4476c
=head1 RETURN VALUES
Packit c4476c
Packit c4476c
BN_cmp() returns -1 if B E<lt> B, 0 if B == B and 1 if
Packit c4476c
B E<gt> B. BN_ucmp() is the same using the absolute values
Packit c4476c
of B and B.
Packit c4476c
Packit c4476c
BN_is_zero(), BN_is_one() BN_is_word() and BN_is_odd() return 1 if
Packit c4476c
the condition is true, 0 otherwise.
Packit c4476c
Packit c4476c
=head1 COPYRIGHT
Packit c4476c
Packit c4476c
Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
Packit c4476c
Packit c4476c
Licensed under the OpenSSL license (the "License").  You may not use
Packit c4476c
this file except in compliance with the License.  You can obtain a copy
Packit c4476c
in the file LICENSE in the source distribution or at
Packit c4476c
L<https://www.openssl.org/source/license.html>.
Packit c4476c
Packit c4476c
=cut