159191Skris=pod
259191Skris
359191Skris=head1 NAME
459191Skris
559191SkrisBN_add_word, BN_sub_word, BN_mul_word, BN_div_word, BN_mod_word - arithmetic
659191Skrisfunctions on BIGNUMs with integers
759191Skris
859191Skris=head1 SYNOPSIS
959191Skris
1059191Skris #include <openssl/bn.h>
1159191Skris
1259191Skris int BN_add_word(BIGNUM *a, BN_ULONG w);
1359191Skris
1459191Skris int BN_sub_word(BIGNUM *a, BN_ULONG w);
1559191Skris
1659191Skris int BN_mul_word(BIGNUM *a, BN_ULONG w);
1759191Skris
1859191Skris BN_ULONG BN_div_word(BIGNUM *a, BN_ULONG w);
1959191Skris
2059191Skris BN_ULONG BN_mod_word(const BIGNUM *a, BN_ULONG w);
2159191Skris
2259191Skris=head1 DESCRIPTION
2359191Skris
2459191SkrisThese functions perform arithmetic operations on BIGNUMs with unsigned
2559191Skrisintegers. They are much more efficient than the normal BIGNUM
2659191Skrisarithmetic operations.
2759191Skris
2859191SkrisBN_add_word() adds B<w> to B<a> (C<a+=w>).
2959191Skris
3059191SkrisBN_sub_word() subtracts B<w> from B<a> (C<a-=w>).
3159191Skris
32160814SsimonBN_mul_word() multiplies B<a> and B<w> (C<a*=w>).
3359191Skris
3459191SkrisBN_div_word() divides B<a> by B<w> (C<a/=w>) and returns the remainder.
3559191Skris
36160814SsimonBN_mod_word() returns the remainder of B<a> divided by B<w> (C<a%w>).
3759191Skris
3859191SkrisFor BN_div_word() and BN_mod_word(), B<w> must not be 0.
3959191Skris
4059191Skris=head1 RETURN VALUES
4159191Skris
4259191SkrisBN_add_word(), BN_sub_word() and BN_mul_word() return 1 for success, 0
4359191Skrison error. The error codes can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>.
4459191Skris
45160814SsimonBN_mod_word() and BN_div_word() return B<a>%B<w> on success and
46160814SsimonB<(BN_ULONG)-1> if an error occurred.
4759191Skris
4859191Skris=head1 SEE ALSO
4959191Skris
50109998SmarkmL<bn(3)|bn(3)>, L<ERR_get_error(3)|ERR_get_error(3)>, L<BN_add(3)|BN_add(3)>
5159191Skris
5259191Skris=head1 HISTORY
5359191Skris
5459191SkrisBN_add_word() and BN_mod_word() are available in all versions of
5559191SkrisSSLeay and OpenSSL. BN_div_word() was added in SSLeay 0.8, and
5659191SkrisBN_sub_word() and BN_mul_word() in SSLeay 0.9.0.
5759191Skris
58160814SsimonBefore 0.9.8a the return value for BN_div_word() and BN_mod_word()
59160814Ssimonin case of an error was 0.
60160814Ssimon
6159191Skris=cut
62