NCBI C++ ToolKit
Public Member Functions | List of all members
mbedtls_mpi Struct Reference

Search Toolkit Book for mbedtls_mpi

MPI structure. More...

#include "bignum.h"
(Private to src/connect/mbedtls/mbedtls.)

Public Member Functions

mbedtls_mpi_uintMBEDTLS_PRIVATE (p)
 Pointer to limbs. More...
 
signed short MBEDTLS_PRIVATE (s)
 Sign: -1 if the mpi is negative, 1 otherwise. More...
 
unsigned short MBEDTLS_PRIVATE (n)
 Total number of limbs in p. More...
 

Detailed Description

MPI structure.

Definition at line 207 of file bignum.h.

Member Function Documentation

◆ MBEDTLS_PRIVATE() [1/3]

unsigned short mbedtls_mpi::MBEDTLS_PRIVATE ( n  )

Total number of limbs in p.

◆ MBEDTLS_PRIVATE() [2/3]

mbedtls_mpi_uint* mbedtls_mpi::MBEDTLS_PRIVATE ( )

Pointer to limbs.

This may be NULL if n is 0.

◆ MBEDTLS_PRIVATE() [3/3]

signed short mbedtls_mpi::MBEDTLS_PRIVATE ( )

Sign: -1 if the mpi is negative, 1 otherwise.

The number 0 must be represented with `s = +1`. Although many library functions treat all-limbs-zero as equivalent to a valid representation of 0 regardless of the sign bit, there are exceptions, so bignum functions and external callers must always set s to +1 for the number zero.

Note that this implies that calloc() or `... = {0}` does not create a valid MPI representation. You must call mbedtls_mpi_init().


The documentation for this struct was generated from the following file:
Modified on Wed Sep 04 15:04:28 2024 by modify_doxy.py rev. 669887