1BN_add_word(3)                      OpenSSL                     BN_add_word(3)
2
3
4

NAME

6       BN_add_word, BN_sub_word, BN_mul_word, BN_div_word, BN_mod_word -
7       arithmetic functions on BIGNUMs with integers
8

SYNOPSIS

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(const BIGNUM *a, BN_ULONG w);
21

DESCRIPTION

23       These functions perform arithmetic operations on BIGNUMs with unsigned
24       integers. They are much more efficient than the normal BIGNUM
25       arithmetic operations.
26
27       BN_add_word() adds w to a ("a+=w").
28
29       BN_sub_word() subtracts w from a ("a-=w").
30
31       BN_mul_word() multiplies a and w ("a*=w").
32
33       BN_div_word() divides a by w ("a/=w") and returns the remainder.
34
35       BN_mod_word() returns the remainder of a divided by w ("a%w").
36
37       For BN_div_word() and BN_mod_word(), w must not be 0.
38

RETURN VALUES

40       BN_add_word(), BN_sub_word() and BN_mul_word() return 1 for success, 0
41       on error. The error codes can be obtained by ERR_get_error(3).
42
43       BN_mod_word() and BN_div_word() return a%w on success and (BN_ULONG)-1
44       if an error occurred.
45

SEE ALSO

47       bn(3), ERR_get_error(3), BN_add(3)
48

HISTORY

50       BN_add_word() and BN_mod_word() are available in all versions of SSLeay
51       and OpenSSL. BN_div_word() was added in SSLeay 0.8, and BN_sub_word()
52       and BN_mul_word() in SSLeay 0.9.0.
53
54       Before 0.9.8a the return value for BN_div_word() and BN_mod_word() in
55       case of an error was 0.
56
57
58
591.0.0e                            2005-07-25                    BN_add_word(3)