Index Index for
Section 3
Index Alphabetical
listing for B
Bottom of page Bottom of
page		 

BN_cmp(3)


NAME

  BN_cmp, BN_ucmp, BN_is_zero, BN_is_one, BN_is_word, BN_is_odd - BIGNUM
  comparison and test functions


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 );


DESCRIPTION

  The BN_cmp() function compares the numbers a and b. The BN_ucmp() function
  compares their absolute values.

  The BN_is_zero(), BN_is_one(), and BN_is_word() test if a equals 0, 1, or w
  respectively. The BN_is_odd() tests if a is odd.

  The BN_is_zero(), BN_is_one(), BN_is_word(), and BN_is_odd() are macros.


RETURN VALUES

  The BN_cmp() functon returns -1 if a < b, 0 if a == b and 1 if a > b. The
  BN_ucmp() function is the same using the absolute values of a and b.

  The BN_is_zero(), BN_is_one(), BN_is_word(), and BN_is_odd() macros return
  1 if the condition is true, 0 otherwise.


HISTORY

  The BN_cmp(), BN_ucmp(), BN_is_zero(), BN_is_one(), and BN_is_word()
  functions are available in all versions of SSLeay and OpenSSL.  The
  BN_is_odd() function was added in SSLeay 0.8.


SEE ALSO

  Functions: bn(3)

Index Index for
Section 3
Index Alphabetical
listing for B
Top of page Top of
page