include/beecrypt/mp.h File Reference

Multi-precision integer routines. More...

#include "beecrypt/api.h"
#include "beecrypt/mpopt.h"

Include dependency graph for mp.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines

#define MP_HWBITS   (MP_WBITS >> 1)
#define MP_WBYTES   (MP_WBITS >> 3)
#define MP_WNIBBLES   (MP_WBITS >> 2)
#define MP_WORDS_TO_BITS(x)   ((x) << 6)
#define MP_WORDS_TO_NIBBLES(x)   ((x) << 4)
#define MP_WORDS_TO_BYTES(x)   ((x) << 3)
#define MP_BITS_TO_WORDS(x)   ((x) >> 6)
#define MP_NIBBLES_TO_WORDS(x)   ((x) >> 4)
#define MP_BYTES_TO_WORDS(x)   ((x) >> 3)
#define MP_MSBMASK   (((mpw) 0x1) << (MP_WBITS-1))
#define MP_LSBMASK   ((mpw) 0x1)
#define MP_ALLMASK   ~((mpw) 0x0)
#define mpcopy(size, dst, src)   memcpy(dst, src, MP_WORDS_TO_BYTES(size))
#define mpmove(size, dst, src)   memmove(dst, src, MP_WORDS_TO_BYTES(size))

Functions

BEECRYPTAPI void mpzero (size_t size, mpw *data)
 This function zeroes a multi-precision integer of a given size.
BEECRYPTAPI void mpfill (size_t size, mpw *data, mpw fill)
 This function fills each word of a multi-precision integer with a given value.
BEECRYPTAPI int mpodd (size_t size, const mpw *data)
 This functions tests if a multi-precision integer is odd.
BEECRYPTAPI int mpeven (size_t size, const mpw *data)
 This function tests if a multi-precision integer is even.
BEECRYPTAPI int mpz (size_t size, const mpw *data)
 This function tests if a multi-precision integer is zero.
BEECRYPTAPI int mpnz (size_t size, const mpw *data)
 This function tests if a multi-precision integer is not zero.
BEECRYPTAPI int mpeq (size_t size, const mpw *xdata, const mpw *ydata)
 This function tests if two multi-precision integers of the same size are equal.
BEECRYPTAPI int mpne (size_t size, const mpw *xdata, const mpw *ydata)
 This function tests if two multi-precision integers of the same size differ.
BEECRYPTAPI int mpgt (size_t size, const mpw *xdata, const mpw *ydata)
 This function tests if the first of two multi-precision integers of the same size is greater than the second.
BEECRYPTAPI int mplt (size_t size, const mpw *xdata, const mpw *ydata)
 This function tests if the first of two multi-precision integers of the same size is less than the second.
BEECRYPTAPI int mpge (size_t size, const mpw *xdata, const mpw *ydata)
 This function tests if the first of two multi-precision integers of the same size is greater than or equal to the second.
BEECRYPTAPI int mple (size_t size, const mpw *xdata, const mpw *ydata)
 This function tests if the first of two multi-precision integers of the same size is less than or equal to the second.
BEECRYPTAPI int mpcmp (size_t size, const mpw *xdata, const mpw *ydata)
 This function performs a comparison of two multi-precision integers of the same size.
BEECRYPTAPI int mpeqx (size_t xsize, const mpw *xdata, size_t ysize, const mpw *ydata)
 This function tests if two multi-precision integers of different size are equal.
BEECRYPTAPI int mpnex (size_t xsize, const mpw *xdata, size_t ysize, const mpw *ydata)
 This function tests if two multi-precision integers of different size are equal.
BEECRYPTAPI int mpgtx (size_t xsize, const mpw *xdata, size_t ysize, const mpw *ydata)
 This function tests if the first of two multi-precision integers of different size is greater than the second.
BEECRYPTAPI int mpltx (size_t xsize, const mpw *xdata, size_t ysize, const mpw *ydata)
 This function tests if the first of two multi-precision integers of different size is less than the second.
BEECRYPTAPI int mpgex (size_t xsize, const mpw *xdata, size_t ysize, const mpw *ydata)
 This function tests if the first of two multi-precision integers of different size is greater than or equal to the second.
BEECRYPTAPI int mplex (size_t xsize, const mpw *xdata, size_t ysize, const mpw *ydata)
 This function tests if the first of two multi-precision integers of different size is less than or equal to the second.
BEECRYPTAPI int mpcmpx (size_t xsize, const mpw *xdata, size_t ysize, const mpw *ydata)
 This function performs a comparison of two multi-precision integers of the different size.
BEECRYPTAPI int mpisone (size_t size, const mpw *data)
 This functions tests if the value of a multi-precision integer is equal to one.
BEECRYPTAPI int mpistwo (size_t size, const mpw *data)
 This function tests if the value of a multi-precision integer is equal to two.
BEECRYPTAPI int mpleone (size_t size, const mpw *data)
 This function tests if the value of a multi-precision integer is less than or equal to one.
BEECRYPTAPI int mpeqmone (size_t size, const mpw *xdata, const mpw *ydata)
 This function tests if multi-precision integer x is equal to y minus one.
BEECRYPTAPI int mpmsbset (size_t size, const mpw *data)
 This function tests if the most significant bit of a multi-precision integer is set.
BEECRYPTAPI int mplsbset (size_t size, const mpw *data)
 This function tests if the leiast significant bit of a multi-precision integer is set.
BEECRYPTAPI void mpsetmsb (size_t size, mpw *data)
 This function sets the most significant bit of a multi-precision integer.
BEECRYPTAPI void mpsetlsb (size_t size, mpw *data)
 This function sets the least significant bit of a multi-precision integer.
BEECRYPTAPI void mpclrmsb (size_t size, mpw *data)
 This function clears the most significant bit of a multi-precision integer.
BEECRYPTAPI void mpclrlsb (size_t size, mpw *data)
 This function clears the least significant bit of a multi-precision integer.
BEECRYPTAPI void mpand (size_t size, mpw *xdata, const mpw *ydata)
 This function computes the bit-wise AND of two multi-precision integers. Modifies xdata.
BEECRYPTAPI void mpor (size_t size, mpw *xdata, const mpw *ydata)
 This function computes the bit-wise OR of two multi-precision integers. Modifies xdata.
BEECRYPTAPI void mpxor (size_t size, mpw *xdata, const mpw *ydata)
 This function computes the bit-wise XOR of two multi-precision integers. Modifies xdata.
BEECRYPTAPI void mpnot (size_t size, mpw *data)
 This function flips all bits of a multi-precision integer.
BEECRYPTAPI void mpsetw (size_t size, mpw *xdata, mpw y)
 This function sets the value of a multi-precision integer to the given word. The given value is copied into the least significant word, while the most significant words are zeroed.
BEECRYPTAPI void mpsetws (size_t size, mpw *xdata, size_t y)
 This function sets the value of a multi-precision integer to the given word. The given value is copied into the least significant word(s), while the most significant words are zeroed.
BEECRYPTAPI void mpsetx (size_t xsize, mpw *xdata, size_t ysize, const mpw *ydata)
 This function set the value of the first multi-precision integer to the second, truncating the most significant words if ysize > xsize, or zeroing the most significant words if ysize < xsize.
BEECRYPTAPI int mpaddw (size_t size, mpw *xdata, mpw y)
 This function adds one word to a multi-precision integer. The performed operation is in pseudocode: x += y.
BEECRYPTAPI int mpadd (size_t size, mpw *xdata, const mpw *ydata)
 This function adds two multi-precision integers of equal size. The performed operation is in pseudocode: x += y.
BEECRYPTAPI int mpaddx (size_t xsize, mpw *xdata, size_t ysize, const mpw *ydata)
 This function adds two multi-precision integers of different size. The performed operation in pseudocode: x += y.
BEECRYPTAPI int mpsubw (size_t size, mpw *xdata, mpw y)
 This function subtracts one word to a multi-precision integer. The performed operation in pseudocode: x -= y.
BEECRYPTAPI int mpsub (size_t size, mpw *xdata, const mpw *ydata)
 This function subtracts two multi-precision integers of equal size. The performed operation in pseudocode: x -= y.
BEECRYPTAPI int mpsubx (size_t xsize, mpw *xdata, size_t ysize, const mpw *ydata)
 This function subtracts two multi-precision integers of different size. The performed operation in pseudocode: x -= y.
BEECRYPTAPI int mpmultwo (size_t size, mpw *data)
BEECRYPTAPI void mpneg (size_t size, mpw *data)
 This function negates a multi-precision integer.
BEECRYPTAPI size_t mpsize (size_t size, const mpw *data)
 This function returns the true size of a multi-precision integer, after stripping leading zero words.
BEECRYPTAPI size_t mpbits (size_t size, const mpw *data)
 This function returns the number of significant bits in a multi-precision integer.
BEECRYPTAPI size_t mpmszcnt (size_t size, const mpw *data)
BEECRYPTAPI size_t mplszcnt (size_t size, const mpw *data)
BEECRYPTAPI void mplshift (size_t size, mpw *data, size_t count)
BEECRYPTAPI void mprshift (size_t size, mpw *data, size_t count)
BEECRYPTAPI size_t mprshiftlsz (size_t size, mpw *data)
BEECRYPTAPI size_t mpnorm (size_t size, mpw *data)
BEECRYPTAPI void mpdivtwo (size_t size, mpw *data)
BEECRYPTAPI void mpsdivtwo (size_t size, mpw *data)
BEECRYPTAPI mpw mpsetmul (size_t size, mpw *result, const mpw *data, mpw y)
 This function performs a multi-precision multiply-setup.
BEECRYPTAPI mpw mpaddmul (size_t size, mpw *result, const mpw *data, mpw y)
 This function performs a mult-precision multiply-accumulate.
BEECRYPTAPI void mpaddsqrtrc (size_t size, mpw *result, const mpw *data)
 This function is used in the calculation of a multi-precision squaring.
BEECRYPTAPI void mpmul (mpw *result, size_t xsize, const mpw *xdata, size_t ysize, const mpw *ydata)
 This function computes a full multi-precision product.
BEECRYPTAPI void mpsqr (mpw *result, size_t size, const mpw *data)
 This function computes a full multi-precision square.
BEECRYPTAPI void mpgcd_w (size_t size, const mpw *xdata, const mpw *ydata, mpw *result, mpw *wksp)
BEECRYPTAPI int mpextgcd_w (size_t size, const mpw *xdata, const mpw *ydata, mpw *result, mpw *wksp)
BEECRYPTAPI mpw mppndiv (mpw xhi, mpw xlo, mpw y)
BEECRYPTAPI void mpmod (mpw *result, size_t xsize, const mpw *xdata, size_t ysize, const mpw *ydata, mpw *wksp)
BEECRYPTAPI void mpndivmod (mpw *result, size_t xsize, const mpw *xdata, size_t ysize, const mpw *ydata, mpw *wksp)
BEECRYPTAPI void mpprint (size_t size, const mpw *data)
BEECRYPTAPI void mpprintln (size_t size, const mpw *data)
BEECRYPTAPI void mpfprint (FILE *f, size_t size, const mpw *data)
BEECRYPTAPI void mpfprintln (FILE *f, size_t size, const mpw *data)
BEECRYPTAPI int i2osp (byte *osdata, size_t ossize, const mpw *idata, size_t isize)
BEECRYPTAPI int os2ip (mpw *idata, size_t isize, const byte *osdata, size_t ossize)
BEECRYPTAPI int hs2ip (mpw *idata, size_t isize, const char *hsdata, size_t hssize)

Detailed Description

Multi-precision integer routines.

The routines declared here are all low-level operations, most of them suitable to be implemented in assembler. Prime candidates are in order of importance (according to gprof):

With some smart use of available assembler instructions, it's possible to speed these routines up by a factor of 2 to 4.

Author:
Bob Deblier <bob.deblier@telenet.be>

Define Documentation

#define MP_ALLMASK   ~((mpw) 0x0)

#define MP_BITS_TO_WORDS ( x   )     ((x) >> 6)

#define MP_BYTES_TO_WORDS ( x   )     ((x) >> 3)

#define MP_HWBITS   (MP_WBITS >> 1)

#define MP_LSBMASK   ((mpw) 0x1)

#define MP_MSBMASK   (((mpw) 0x1) << (MP_WBITS-1))

#define MP_NIBBLES_TO_WORDS ( x   )     ((x) >> 4)

#define MP_WBYTES   (MP_WBITS >> 3)

#define MP_WNIBBLES   (MP_WBITS >> 2)

#define MP_WORDS_TO_BITS ( x   )     ((x) << 6)

#define MP_WORDS_TO_BYTES ( x   )     ((x) << 3)

#define MP_WORDS_TO_NIBBLES ( x   )     ((x) << 4)

#define mpcopy ( size,
dst,
src   )     memcpy(dst, src, MP_WORDS_TO_BYTES(size))

#define mpmove ( size,
dst,
src   )     memmove(dst, src, MP_WORDS_TO_BYTES(size))

Function Documentation

BEECRYPTAPI int hs2ip ( mpw *  idata,
size_t  isize,
const char *  hsdata,
size_t  hssize 
)

BEECRYPTAPI int i2osp ( byte *  osdata,
size_t  ossize,
const mpw *  idata,
size_t  isize 
)

int mpadd ( size_t  size,
mpw *  xdata,
const mpw *  ydata 
)

This function adds two multi-precision integers of equal size. The performed operation is in pseudocode: x += y.

Parameters:
size The size of the multi-precision integers.
xdata The first multi-precision integer.
ydata The second multi-precision integer.
Returns:
The carry-over value of the operation; this value is either 0 or 1.

mpw mpaddmul ( size_t  size,
mpw *  result,
const mpw *  data,
mpw  y 
)

This function performs a mult-precision multiply-accumulate.

This function is used in the computation of a full multi-precision multiplication. It computes the product-by-one-word and accumulates it with the previous result.

Parameters:
size The size of multi-precision integer multiplier.
result The place where result will be accumulated.
data The multi-precision integer multiplier.
y The multiplicand.
Return values:
The carry-over multi-precision word.

void mpaddsqrtrc ( size_t  size,
mpw *  result,
const mpw *  data 
)

This function is used in the calculation of a multi-precision squaring.

int mpaddw ( size_t  size,
mpw *  xdata,
mpw  y 
)

This function adds one word to a multi-precision integer. The performed operation is in pseudocode: x += y.

Parameters:
size The size of the multi-precision integer.
xdata The first multi-precision integer.
y The multi-precision word.
Returns:
The carry-over value of the operation; this value is either 0 or 1.

int mpaddx ( size_t  xsize,
mpw *  xdata,
size_t  ysize,
const mpw *  ydata 
)

This function adds two multi-precision integers of different size. The performed operation in pseudocode: x += y.

Parameters:
xsize The size of the first multi-precision integer.
xdata The first multi-precision integer.
ysize The size of the second multi-precision integer.
ydata The second multi-precision integer.
Returns:
The carry-over value of the operation; this value is either 0 or 1.

mpand ( size_t  size,
mpw *  xdata,
const mpw *  ydata 
)

This function computes the bit-wise AND of two multi-precision integers. Modifies xdata.

Parameters:
size The size of the multi-precision integers.
xdata The multi-precision integer data.
ydata The multi-precision integer data.

size_t mpbits ( size_t  size,
const mpw *  data 
)

This function returns the number of significant bits in a multi-precision integer.

Parameters:
size The size of the multi-precision integer.
data The multi-precision integer data.

void mpclrlsb ( size_t  size,
mpw *  data 
)

This function clears the least significant bit of a multi-precision integer.

Parameters:
size The size of the multi-precision integer.
data The multi-precision integer data.

void mpclrmsb ( size_t  size,
mpw *  data 
)

This function clears the most significant bit of a multi-precision integer.

Parameters:
size The size of the multi-precision integer.
data The multi-precision integer data.

int mpcmp ( size_t  size,
const mpw *  xdata,
const mpw *  ydata 
)

This function performs a comparison of two multi-precision integers of the same size.

Note:
The comparison treats the arguments as unsigned.
Return values:
-1 if x < y
0 if x == y
1 if x > y

int mpcmpx ( size_t  xsize,
const mpw *  xdata,
size_t  ysize,
const mpw *  ydata 
)

This function performs a comparison of two multi-precision integers of the different size.

Note:
The comparison treats the arguments as unsigned.
Return values:
-1 if x < y
0 if x == y
1 if x > y

BEECRYPTAPI void mpdivtwo ( size_t  size,
mpw *  data 
)

int mpeq ( size_t  size,
const mpw *  xdata,
const mpw *  ydata 
)

This function tests if two multi-precision integers of the same size are equal.

Parameters:
size The size of the multi-precision integers.
xdata The first multi-precision integer.
ydata The second multi-precision integer.
Return values:
1 if equal
0 if not equal

int mpeqmone ( size_t  size,
const mpw *  xdata,
const mpw *  ydata 
)

This function tests if multi-precision integer x is equal to y minus one.

Parameters:
size The size of the multi-precision integers.
xdata The first multi-precision integer.
ydata The second multi-precision integer.
Return values:
1 if less than or equal to one.
0 if greater than one.

int mpeqx ( size_t  xsize,
const mpw *  xdata,
size_t  ysize,
const mpw *  ydata 
)

This function tests if two multi-precision integers of different size are equal.

Parameters:
xsize The size of the first multi-precision integer.
xdata The first multi-precision integer.
ysize The size of the first multi-precision integer.
ydata The second multi-precision integer.
Return values:
1 if equal
0 if not equal

int mpeven ( size_t  size,
const mpw *  data 
)

This function tests if a multi-precision integer is even.

Parameters:
size The size of the multi-precision integer.
data The multi-precision integer data.
Return values:
1 if even
0 if odd

BEECRYPTAPI int mpextgcd_w ( size_t  size,
const mpw *  xdata,
const mpw *  ydata,
mpw *  result,
mpw *  wksp 
)

void mpfill ( size_t  size,
mpw *  data,
mpw  fill 
)

This function fills each word of a multi-precision integer with a given value.

Parameters:
size The size of the multi-precision integer.
data The multi-precision integer data.
fill The value fill the data with.

BEECRYPTAPI void mpfprint ( FILE *  f,
size_t  size,
const mpw *  data 
)

BEECRYPTAPI void mpfprintln ( FILE *  f,
size_t  size,
const mpw *  data 
)

BEECRYPTAPI void mpgcd_w ( size_t  size,
const mpw *  xdata,
const mpw *  ydata,
mpw *  result,
mpw *  wksp 
)

int mpge ( size_t  size,
const mpw *  xdata,
const mpw *  ydata 
)

This function tests if the first of two multi-precision integers of the same size is greater than or equal to the second.

Note:
The comparison treats the arguments as unsigned.
Parameters:
size The size of the multi-precision integers.
xdata The first multi-precision integer.
ydata The second multi-precision integer.
Return values:
1 if greater or equal
0 if less

int mpgex ( size_t  xsize,
const mpw *  xdata,
size_t  ysize,
const mpw *  ydata 
)

This function tests if the first of two multi-precision integers of different size is greater than or equal to the second.

Note:
The comparison treats the arguments as unsigned.
Parameters:
xsize The size of the first multi-precision integer.
xdata The first multi-precision integer.
ysize The size of the second multi-precision integer.
ydata The second multi-precision integer.
Return values:
1 if greater or equal
0 if less

int mpgt ( size_t  size,
const mpw *  xdata,
const mpw *  ydata 
)

This function tests if the first of two multi-precision integers of the same size is greater than the second.

Note:
The comparison treats the arguments as unsigned.
Parameters:
size The size of the multi-precision integers.
xdata The first multi-precision integer.
ydata The second multi-precision integer.
Return values:
1 if greater
0 if less or equal

int mpgtx ( size_t  xsize,
const mpw *  xdata,
size_t  ysize,
const mpw *  ydata 
)

This function tests if the first of two multi-precision integers of different size is greater than the second.

Note:
The comparison treats the arguments as unsigned.
Parameters:
xsize The size of the first multi-precision integer.
xdata The first multi-precision integer.
ysize The size of the second multi-precision integer.
ydata The second multi-precision integer.
Return values:
1 if greater
0 if less or equal

int mpisone ( size_t  size,
const mpw *  data 
)

This functions tests if the value of a multi-precision integer is equal to one.

Parameters:
size The size of the multi-precision integer.
data The multi-precision integer data.
Return values:
1 if one
0 if not one

int mpistwo ( size_t  size,
const mpw *  data 
)

This function tests if the value of a multi-precision integer is equal to two.

Parameters:
size The size of the multi-precision integer.
data The multi-precision integer data.
Return values:
1 if two
0 if not two

int mple ( size_t  size,
const mpw *  xdata,
const mpw *  ydata 
)

This function tests if the first of two multi-precision integers of the same size is less than or equal to the second.

Note:
The comparison treats the arguments as unsigned.
Parameters:
size The size of the multi-precision integers.
xdata The first multi-precision integer.
ydata The second multi-precision integer.
Return values:
1 if less or equal
0 if greater

int mpleone ( size_t  size,
const mpw *  data 
)

This function tests if the value of a multi-precision integer is less than or equal to one.

Parameters:
size The size of the multi-precision integer.
data The multi-precision integer data.
Return values:
1 if less than or equal to one.
0 if greater than one.

int mplex ( size_t  xsize,
const mpw *  xdata,
size_t  ysize,
const mpw *  ydata 
)

This function tests if the first of two multi-precision integers of different size is less than or equal to the second.

Note:
The comparison treats the arguments as unsigned.
Parameters:
xsize The size of the first multi-precision integer.
xdata The first multi-precision integer.
ysize The size of the second multi-precision integer.
ydata The second multi-precision integer.
Return values:
1 if less or equal
0 if greater

int mplsbset ( size_t  size,
const mpw *  data 
)

This function tests if the leiast significant bit of a multi-precision integer is set.

Parameters:
size The size of the multi-precision integer.
data The multi-precision integer data.
Return values:
1 if set
0 if not set

BEECRYPTAPI void mplshift ( size_t  size,
mpw *  data,
size_t  count 
)

BEECRYPTAPI size_t mplszcnt ( size_t  size,
const mpw *  data 
)

int mplt ( size_t  size,
const mpw *  xdata,
const mpw *  ydata 
)

This function tests if the first of two multi-precision integers of the same size is less than the second.

Note:
The comparison treats the arguments as unsigned.
Parameters:
size The size of the multi-precision integers.
xdata The first multi-precision integer.
ydata The second multi-precision integer.
Return values:
1 if less
0 if greater or equal

int mpltx ( size_t  xsize,
const mpw *  xdata,
size_t  ysize,
const mpw *  ydata 
)

This function tests if the first of two multi-precision integers of different size is less than the second.

Note:
The comparison treats the arguments as unsigned.
Parameters:
xsize The size of the first multi-precision integer.
xdata The first multi-precision integer.
ysize The size of the second multi-precision integer.
ydata The second multi-precision integer.
Return values:
1 if less
0 if greater or equal

BEECRYPTAPI void mpmod ( mpw *  result,
size_t  xsize,
const mpw *  xdata,
size_t  ysize,
const mpw *  ydata,
mpw *  wksp 
)

int mpmsbset ( size_t  size,
const mpw *  data 
)

This function tests if the most significant bit of a multi-precision integer is set.

Parameters:
size The size of the multi-precision integer.
data The multi-precision integer data.
Return values:
1 if set
0 if not set

BEECRYPTAPI size_t mpmszcnt ( size_t  size,
const mpw *  data 
)

void mpmul ( mpw *  result,
size_t  xsize,
const mpw *  xdata,
size_t  ysize,
const mpw *  ydata 
)

This function computes a full multi-precision product.

BEECRYPTAPI int mpmultwo ( size_t  size,
mpw *  data 
)

BEECRYPTAPI void mpndivmod ( mpw *  result,
size_t  xsize,
const mpw *  xdata,
size_t  ysize,
const mpw *  ydata,
mpw *  wksp 
)

int mpne ( size_t  size,
const mpw *  xdata,
const mpw *  ydata 
)

This function tests if two multi-precision integers of the same size differ.

Parameters:
size The size of the multi-precision integers.
xdata The first multi-precision integer.
ydata The second multi-precision integer.
Return values:
1 if not equal
0 if equal

void mpneg ( size_t  size,
mpw *  data 
)

This function negates a multi-precision integer.

Parameters:
size The size of the multi-precision integer.
data The multi-precision integer data.

int mpnex ( size_t  xsize,
const mpw *  xdata,
size_t  ysize,
const mpw *  ydata 
)

This function tests if two multi-precision integers of different size are equal.

Parameters:
xsize The size of the first multi-precision integer.
xdata The first multi-precision integer.
ysize The size of the first multi-precision integer.
ydata The second multi-precision integer.
Return values:
1 if equal
0 if not equal

BEECRYPTAPI size_t mpnorm ( size_t  size,
mpw *  data 
)

mpnot ( size_t  size,
mpw *  data 
)

This function flips all bits of a multi-precision integer.

Parameters:
size The size of the multi-precision integer.
data The multi-precision integer data.

int mpnz ( size_t  size,
const mpw *  data 
)

This function tests if a multi-precision integer is not zero.

Parameters:
size The size of the multi-precision integer.
data The multi-precision integer data.
Return values:
1 if not zero
0 if zero

int mpodd ( size_t  size,
const mpw *  data 
)

This functions tests if a multi-precision integer is odd.

Parameters:
size The size of the multi-precision integer.
data The multi-precision integer data.
Return values:
1 if odd
0 if even

void mpor ( size_t  size,
mpw *  xdata,
const mpw *  ydata 
)

This function computes the bit-wise OR of two multi-precision integers. Modifies xdata.

Parameters:
size The size of the multi-precision integer.
xdata The multi-precision integer data.
ydata The multi-precision integer data.

BEECRYPTAPI mpw mppndiv ( mpw  xhi,
mpw  xlo,
mpw  y 
)

BEECRYPTAPI void mpprint ( size_t  size,
const mpw *  data 
)

BEECRYPTAPI void mpprintln ( size_t  size,
const mpw *  data 
)

BEECRYPTAPI void mprshift ( size_t  size,
mpw *  data,
size_t  count 
)

BEECRYPTAPI size_t mprshiftlsz ( size_t  size,
mpw *  data 
)

BEECRYPTAPI void mpsdivtwo ( size_t  size,
mpw *  data 
)

void mpsetlsb ( size_t  size,
mpw *  data 
)

This function sets the least significant bit of a multi-precision integer.

Parameters:
size The size of the multi-precision integer.
data The multi-precision integer data.

void mpsetmsb ( size_t  size,
mpw *  data 
)

This function sets the most significant bit of a multi-precision integer.

Parameters:
size The size of the multi-precision integer.
data The multi-precision integer data.

mpw mpsetmul ( size_t  size,
mpw *  result,
const mpw *  data,
mpw  y 
)

This function performs a multi-precision multiply-setup.

This function is used in the computation of a full multi-precision multiplication. By using it we can shave off a few cycles; otherwise we'd have to zero the least significant half of the result first and use another call to the slightly slower mpaddmul function.

Parameters:
size The size of multi-precision integer multiplier.
result The place where result will be accumulated.
data The multi-precision integer multiplier.
y The multiplicand.
Returns:
The carry-over multi-precision word.

void mpsetw ( size_t  size,
mpw *  xdata,
mpw  y 
)

This function sets the value of a multi-precision integer to the given word. The given value is copied into the least significant word, while the most significant words are zeroed.

Parameters:
size The size of the multi-precision integer.
xdata The multi-precision integer data.
y The value to be assigned.

void mpsetws ( size_t  size,
mpw *  xdata,
size_t  y 
)

This function sets the value of a multi-precision integer to the given word. The given value is copied into the least significant word(s), while the most significant words are zeroed.

Parameters:
size The size of the multi-precision integer.
xdata The multi-precision integer data.
y The value.

void mpsetx ( size_t  xsize,
mpw *  xdata,
size_t  ysize,
const mpw *  ydata 
)

This function set the value of the first multi-precision integer to the second, truncating the most significant words if ysize > xsize, or zeroing the most significant words if ysize < xsize.

Parameters:
xsize The size of the first multi-precision integer.
xdata The first multi-precision integer.
ysize The size of the second multi-precision integer.
ydata The second multi-precision integer.

size_t mpsize ( size_t  size,
const mpw *  data 
)

This function returns the true size of a multi-precision integer, after stripping leading zero words.

Parameters:
size The size of the multi-precision integer.
data The multi-precision integer data.

void mpsqr ( mpw *  result,
size_t  size,
const mpw *  data 
)

This function computes a full multi-precision square.

int mpsub ( size_t  size,
mpw *  xdata,
const mpw *  ydata 
)

This function subtracts two multi-precision integers of equal size. The performed operation in pseudocode: x -= y.

Parameters:
size The size of the multi-precision integers.
xdata The first multi-precision integer.
ydata The second multi-precision integer.
Returns:
The carry-over value of the operation; this value is either 0 or 1.

int mpsubw ( size_t  size,
mpw *  xdata,
mpw  y 
)

This function subtracts one word to a multi-precision integer. The performed operation in pseudocode: x -= y.

Parameters:
size The size of the multi-precision integers.
xdata The first multi-precision integer.
y The multi-precision word.
Returns:
The carry-over value of the operation; this value is either 0 or 1.

int mpsubx ( size_t  xsize,
mpw *  xdata,
size_t  ysize,
const mpw *  ydata 
)

This function subtracts two multi-precision integers of different size. The performed operation in pseudocode: x -= y.

Parameters:
xsize The size of the first multi-precision integer.
xdata The first multi-precision integer.
ysize The size of the second multi-precision integer.
ydata The second multi-precision integer.
Returns:
The carry-over value of the operation; this value is either 0 or 1.

void mpxor ( size_t  size,
mpw *  xdata,
const mpw *  ydata 
)

This function computes the bit-wise XOR of two multi-precision integers. Modifies xdata.

Parameters:
size The size of the multi-precision integer.
xdata The multi-precision integer data.
ydata The multi-precision integer data.

int mpz ( size_t  size,
const mpw *  data 
)

This function tests if a multi-precision integer is zero.

Parameters:
size The size of the multi-precision integer.
data The multi-precision integer data.
Return values:
1 if zero
0 if not zero

void mpzero ( size_t  size,
mpw *  data 
)

This function zeroes a multi-precision integer of a given size.

Parameters:
size The size of the multi-precision integer.
data The multi-precision integer data.

BEECRYPTAPI int os2ip ( mpw *  idata,
size_t  isize,
const byte *  osdata,
size_t  ossize 
)

Generated on Fri Jun 19 13:38:54 2009 for BeeCrypt by  doxygen 1.5.8