Debian Codegraph @

upstream/debian-unstable/man3/BN_add_word.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "BN_ADD_WORD 3SSL"
58 .TH BN_ADD_WORD 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 BN_add_word, BN_sub_word, BN_mul_word, BN_div_word, BN_mod_word \- arithmetic
65 functions on BIGNUMs with integers
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/bn.h>
70 \&
71 \& int BN_add_word(BIGNUM *a, BN_ULONG w);
72 \&
73 \& int BN_sub_word(BIGNUM *a, BN_ULONG w);
74 \&
75 \& int BN_mul_word(BIGNUM *a, BN_ULONG w);
76 \&
77 \& BN_ULONG BN_div_word(BIGNUM *a, BN_ULONG w);
78 \&
79 \& BN_ULONG BN_mod_word(const BIGNUM *a, BN_ULONG w);
80 .Ve
81 .SH DESCRIPTION
82 .IX Header "DESCRIPTION"
83 These functions perform arithmetic operations on BIGNUMs with unsigned
84 integers. They are much more efficient than the normal BIGNUM
85 arithmetic operations.
86 .PP
87 \&\fBBN_add_word()\fR adds \fBw\fR to \fBa\fR (\f(CW\*(C`a+=w\*(C'\fR).
88 .PP
89 \&\fBBN_sub_word()\fR subtracts \fBw\fR from \fBa\fR (\f(CW\*(C`a\-=w\*(C'\fR).
90 .PP
91 \&\fBBN_mul_word()\fR multiplies \fBa\fR and \fBw\fR (\f(CW\*(C`a*=w\*(C'\fR).
92 .PP
93 \&\fBBN_div_word()\fR divides \fBa\fR by \fBw\fR (\f(CW\*(C`a/=w\*(C'\fR) and returns the remainder.
94 .PP
95 \&\fBBN_mod_word()\fR returns the remainder of \fBa\fR divided by \fBw\fR (\f(CW\*(C`a%w\*(C'\fR).
96 .PP
97 For \fBBN_div_word()\fR and \fBBN_mod_word()\fR, \fBw\fR must not be 0.
98 .SH "RETURN VALUES"
99 .IX Header "RETURN VALUES"
100 \&\fBBN_add_word()\fR, \fBBN_sub_word()\fR and \fBBN_mul_word()\fR return 1 for success, 0
101 on error. The error codes can be obtained by \fBERR_get_error\fR\|(3).
102 .PP
103 \&\fBBN_mod_word()\fR and \fBBN_div_word()\fR return \fBa\fR%\fBw\fR on success and
104 \&\fB(BN_ULONG)\-1\fR if an error occurred.
105 .SH "SEE ALSO"
106 .IX Header "SEE ALSO"
107 \&\fBERR_get_error\fR\|(3), \fBBN_add\fR\|(3)
108 .SH COPYRIGHT
109 .IX Header "COPYRIGHT"
110 Copyright 2000\-2017 The OpenSSL Project Authors. All Rights Reserved.
111 .PP
112 Licensed under the Apache License 2.0 (the "License"). You may not use
113 this file except in compliance with the License. You can obtain a copy
114 in the file LICENSE in the source distribution or at
115 <https://www.openssl.org/source/license.html>.