$NetBSD: BN_cmp.3,v 1.25 2024/09/08 13:08:16 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..

..

.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "BN_cmp 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
BN_cmp, BN_ucmp, BN_is_zero, BN_is_one, BN_is_word, BN_abs_is_word, BN_is_odd - BIGNUM comparison and test functions Header "SYNOPSIS" .Vb 1 #include <openssl/bn.h> \& int BN_cmp(const BIGNUM *a, const BIGNUM *b); int BN_ucmp(const BIGNUM *a, const BIGNUM *b); \& int BN_is_zero(const BIGNUM *a); int BN_is_one(const BIGNUM *a); int BN_is_word(const BIGNUM *a, const BN_ULONG w); int BN_abs_is_word(const BIGNUM *a, const BN_ULONG w); int BN_is_odd(const BIGNUM *a); .Ve Header "DESCRIPTION" \fBBN_cmp() compares the numbers a and b. BN_ucmp() compares their absolute values.

\fBBN_is_zero(), BN_is_one(), BN_is_word() and BN_abs_is_word() test if \fIa equals 0, 1, w, or |w| respectively. \fBBN_is_odd() tests if a is odd.

Header "RETURN VALUES" \fBBN_cmp() returns -1 if a < b, 0 if a == b and 1 if \fIa > b. BN_ucmp() is the same using the absolute values of a and b.

\fBBN_is_zero(), BN_is_one() BN_is_word(), BN_abs_is_word() and \fBBN_is_odd() return 1 if the condition is true, 0 otherwise.

Header "HISTORY" Prior to OpenSSL 1.1.0, BN_is_zero(), BN_is_one(), BN_is_word(), \fBBN_abs_is_word() and BN_is_odd() were macros. Header "COPYRIGHT" Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (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 <https://www.openssl.org/source/license.html>.