Use 'i' as parameter name not 'I'.
[openssl.git] / doc / man3 / BN_cmp.pod
1 =pod
2
3 =head1 NAME
4
5 BN_cmp, BN_ucmp, BN_is_zero, BN_is_one, BN_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(BIGNUM *a, BIGNUM *b);
12  int BN_ucmp(BIGNUM *a, BIGNUM *b);
13
14  int BN_is_zero(BIGNUM *a);
15  int BN_is_one(BIGNUM *a);
16  int BN_is_word(BIGNUM *a, BN_ULONG w);
17  int BN_is_odd(BIGNUM *a);
18
19 =head1 DESCRIPTION
20
21 BN_cmp() compares the numbers B<a> and B<b>. BN_ucmp() compares their
22 absolute values.
23
24 BN_is_zero(), BN_is_one() and BN_is_word() test if B<a> equals 0, 1,
25 or B<w> respectively. BN_is_odd() tests if a is odd.
26
27 BN_is_zero(), BN_is_one(), BN_is_word() and BN_is_odd() are macros.
28
29 =head1 RETURN VALUES
30
31 BN_cmp() returns -1 if B<a> E<lt> B<b>, 0 if B<a> == B<b> and 1 if
32 B<a> E<gt> B<b>. BN_ucmp() is the same using the absolute values
33 of B<a> and B<b>.
34
35 BN_is_zero(), BN_is_one() BN_is_word() and BN_is_odd() return 1 if
36 the condition is true, 0 otherwise.
37
38 =head1 COPYRIGHT
39
40 Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
41
42 Licensed under the OpenSSL license (the "License").  You may not use
43 this file except in compliance with the License.  You can obtain a copy
44 in the file LICENSE in the source distribution or at
45 L<https://www.openssl.org/source/license.html>.
46
47 =cut