Sortix
Sortix Download Manual Development News Blog More
current nightly

Sortix 1.1dev nightly manual

This manual documents Sortix 1.1dev nightly, a development build that has not been officially released. You can instead view this document in the latest official manual.

BN_ADD_WORD(3) Library Functions Manual BN_ADD_WORD(3)

NAME

BN_add_word, BN_sub_word, BN_mul_word, BN_div_word, BN_mod_word —
arithmetic functions on BIGNUMs with integers

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

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 w to a (a+=w).
BN_sub_word() subtracts w from a (a-=w).
BN_mul_word() multiplies a and w (a*=w).
BN_div_word() divides a by w (a/=w) and returns the remainder.
BN_mod_word() returns the remainder of a divided by w (a%w).
For BN_div_word() and BN_mod_word(), w must not be 0.

RETURN VALUES

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

SEE ALSO

BN_add(3), BN_new(3)

HISTORY

BN_add_word(), BN_div_word(), and BN_mod_word() first appeared in SSLeay 0.5.1. BN_sub_word() and BN_mul_word() first appeared in SSLeay 0.9.0. All these functions have been available since OpenBSD 2.4.
Before 0.9.8a, the return value for BN_div_word() and BN_mod_word() in case of an error was 0.
June 10, 2019 Debian
Copyright 2011-2022 Jonas 'Sortie' Termansen and contributors.
Sortix is free software under the ISC license.
#sortix on irc.sortix.org
@sortix_org