doc/crypto/BN_add_word.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 BN_add_word, BN_sub_word, BN_mul_word, BN_div_word, BN_mod_word - Arithmetic
   6 functions on BIGNUMs with integers
   7
   8 =head1 SYNOPSIS
   9
  10  #include <openssl/bn.h>
  11
  12  int BN_add_word(BIGNUM *a, BN_ULONG w);
  13
  14  int BN_sub_word(BIGNUM *a, BN_ULONG w);
  15
  16  int BN_mul_word(BIGNUM *a, BN_ULONG w);
  17
  18  BN_ULONG BN_div_word(BIGNUM *a, BN_ULONG w);
  19
  20  BN_ULONG BN_mod_word(BIGNUM *a, BN_ULONG w);
  21
  22 =head1 DESCRIPTION
  23
  24 These functions perform arithmetic operations on BIGNUMs with unsigned
  25 integers. They are much more efficient than the normal BIGNUM
  26 arithmetic operations.
  27
  28 BN_add_word() adds B<w> to B<a> (C<a+=w>).
  29
  30 BN_sub_word() substracts B<w> from B<a> (C<a-=w>).
  31
  32 BN_mul_word() multiplies B<a> and B<w> (C<a*=b>).
  33
  34 BN_div_word() divides B<a> by B<w> (C<a/=w>) and returns the remainder.
  35
  36 BN_mod_word() returns the remainder of B<a> divided by B<w> (C<a%m>).
  37
  38 For BN_div_word() and BN_mod_word(), B<w> must not be 0.
  39
  40 =head1 RETURN VALUES
  41
  42 BN_add_word(), BN_sub_word() and BN_mul_word() return 1 for success, 0
  43 on error. The error codes can be obtained by ERR_get_error(3).
  44
  45 BN_mod_word() and BN_div_word() return B<a>%B<w>.
  46
  47 =head1 SEE ALSO
  48
  49 bn(3), err(3), BN_add(3)
  50
  51 =head1 HISTORY
  52
  53 BN_add_word() and BN_mod_word() are available in all versions of
  54 SSLeay and OpenSSL. BN_div_word() was added in SSLeay 0.8, and
  55 BN_sub_word() and BN_mul_word() in SSLeay 0.9.0.
  56
  57 =cut