BN_add_word.pod 1.2 KB
Newer Older
U
Ulf Möller 已提交
1 2 3 4
=pod

=head1 NAME

U
Ulf Möller 已提交
5
BN_add_word, BN_sub_word, BN_mul_word, BN_div_word, BN_mod_word - arithmetic
U
Ulf Möller 已提交
6 7 8 9 10 11 12 13 14 15 16 17 18 19
functions on BIGNUMs with integers

=head1 SYNOPSIS

 #include <openssl/bn.h>

 int BN_add_word(BIGNUM *a, BN_ULONG w);

 int BN_sub_word(BIGNUM *a, BN_ULONG w);

 int BN_mul_word(BIGNUM *a, BN_ULONG w);

 BN_ULONG BN_div_word(BIGNUM *a, BN_ULONG w);

B
Bodo Möller 已提交
20
 BN_ULONG BN_mod_word(const BIGNUM *a, BN_ULONG w);
U
Ulf Möller 已提交
21 22 23 24 25 26 27 28 29

=head1 DESCRIPTION

These functions perform arithmetic operations on BIGNUMs with unsigned
integers. They are much more efficient than the normal BIGNUM
arithmetic operations.

BN_add_word() adds B<w> to B<a> (C<a+=w>).

U
Ulf Möller 已提交
30
BN_sub_word() subtracts B<w> from B<a> (C<a-=w>).
U
Ulf Möller 已提交
31

32
BN_mul_word() multiplies B<a> and B<w> (C<a*=w>).
U
Ulf Möller 已提交
33 34 35

BN_div_word() divides B<a> by B<w> (C<a/=w>) and returns the remainder.

36
BN_mod_word() returns the remainder of B<a> divided by B<w> (C<a%w>).
U
Ulf Möller 已提交
37 38 39 40 41 42

For BN_div_word() and BN_mod_word(), B<w> must not be 0.

=head1 RETURN VALUES

BN_add_word(), BN_sub_word() and BN_mul_word() return 1 for success, 0
R
Rich Salz 已提交
43
on error. The error codes can be obtained by L<ERR_get_error(3)>.
U
Ulf Möller 已提交
44

45 46
BN_mod_word() and BN_div_word() return B<a>%B<w> on success and
B<(BN_ULONG)-1> if an error occurred.
U
Ulf Möller 已提交
47 48 49

=head1 SEE ALSO

R
Rich Salz 已提交
50
L<bn(3)>, L<ERR_get_error(3)>, L<BN_add(3)>
U
Ulf Möller 已提交
51 52

=cut