$NetBSD: BN_set_bit.3,v 1.25 2024/09/08 13:08:16 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..

..

.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "BN_set_bit 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
BN_set_bit, BN_clear_bit, BN_is_bit_set, BN_mask_bits, BN_lshift, BN_lshift1, BN_rshift, BN_rshift1 - bit operations on BIGNUMs Header "SYNOPSIS" .Vb 1 #include <openssl/bn.h> \& int BN_set_bit(BIGNUM *a, int n); int BN_clear_bit(BIGNUM *a, int n); \& int BN_is_bit_set(const BIGNUM *a, int n); \& int BN_mask_bits(BIGNUM *a, int n); \& int BN_lshift(BIGNUM *r, const BIGNUM *a, int n); int BN_lshift1(BIGNUM *r, BIGNUM *a); \& int BN_rshift(BIGNUM *r, BIGNUM *a, int n); int BN_rshift1(BIGNUM *r, BIGNUM *a); .Ve Header "DESCRIPTION" \fBBN_set_bit() sets bit n in a to 1 (\*(C`a|=(1<<n)\*(C'). The number is expanded if necessary.

\fBBN_clear_bit() sets bit n in a to 0 (\*(C`a&=~(1<<n)\*(C'). An error occurs if a is shorter than n bits.

\fBBN_is_bit_set() tests if bit n in a is set.

\fBBN_mask_bits() truncates a to an n bit number (\*(C`a&=~((~0)<<n)\*(C'). An error occurs if n is negative. An error is also returned if the internal representation of a is already shorter than \fBn bits. The internal representation depends on the platform's word size, and this error can be safely ignored. Use BN_num_bits\|(3) to determine the exact number of bits if needed.

\fBBN_lshift() shifts a left by n bits and places the result in \fBr (\*(C`r=a*2^n\*(C'). Note that n must be nonnegative. BN_lshift1() shifts \fBa left by one and places the result in r (\*(C`r=2*a\*(C').

\fBBN_rshift() shifts a right by n bits and places the result in \fBr (\*(C`r=a/2^n\*(C'). Note that n must be nonnegative. BN_rshift1() shifts \fBa right by one and places the result in r (\*(C`r=a/2\*(C').

For the shift functions, r and a may be the same variable.

Header "RETURN VALUES" \fBBN_is_bit_set() returns 1 if the bit is set, 0 otherwise.

All other functions return 1 for success, 0 on error. The error codes can be obtained by ERR_get_error\|(3).

Header "SEE ALSO" \fBBN_num_bytes\|(3), BN_add\|(3) Header "COPYRIGHT" Copyright 2000-2024 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.