mirror of
https://github.com/openssl/openssl.git
synced 2024-12-27 06:21:43 +08:00
9e183d2271
Add 2017 copyright year
Add missing typedef to NAME
Remove ec(7) and bn(7) doc links
Remove .pod link errors, bogus links, make a few typo corrections
Fix some typo's in links and some missing items.
Don't link to C runtime functions (See OPENSSL_malloc for example/precedent)
Document ASN1_tag2str(), add a few typedef's that were missing from NAME
Update doc-nits target; addresses
https://github.com/openssl/openssl/pull/1900#issuecomment-259943891,
Merge check-doc-links into find-doc-nits; if run regularly, would have found
https://github.com/openssl/openssl/pull/2825
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/2862)
48 lines
1.2 KiB
Plaintext
48 lines
1.2 KiB
Plaintext
=pod
|
|
|
|
=head1 NAME
|
|
|
|
BN_cmp, BN_ucmp, BN_is_zero, BN_is_one, BN_is_word, BN_is_odd - BIGNUM comparison and test functions
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
#include <openssl/bn.h>
|
|
|
|
int BN_cmp(BIGNUM *a, BIGNUM *b);
|
|
int BN_ucmp(BIGNUM *a, BIGNUM *b);
|
|
|
|
int BN_is_zero(BIGNUM *a);
|
|
int BN_is_one(BIGNUM *a);
|
|
int BN_is_word(BIGNUM *a, BN_ULONG w);
|
|
int BN_is_odd(BIGNUM *a);
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
BN_cmp() compares the numbers B<a> and B<b>. BN_ucmp() compares their
|
|
absolute values.
|
|
|
|
BN_is_zero(), BN_is_one() and BN_is_word() test if B<a> equals 0, 1,
|
|
or B<w> respectively. BN_is_odd() tests if a is odd.
|
|
|
|
BN_is_zero(), BN_is_one(), BN_is_word() and BN_is_odd() are macros.
|
|
|
|
=head1 RETURN VALUES
|
|
|
|
BN_cmp() returns -1 if B<a> E<lt> B<b>, 0 if B<a> == B<b> and 1 if
|
|
B<a> E<gt> B<b>. BN_ucmp() is the same using the absolute values
|
|
of B<a> and B<b>.
|
|
|
|
BN_is_zero(), BN_is_one() BN_is_word() and BN_is_odd() return 1 if
|
|
the condition is true, 0 otherwise.
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
|
|
|
|
Licensed under the OpenSSL license (the "License"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file LICENSE in the source distribution or at
|
|
L<https://www.openssl.org/source/license.html>.
|
|
|
|
=cut
|