c4e_elements.h (Version 568)

Go to the documentation of this file.

/****************************** -*- mode: C -*- ******************************/
#ifndef C4E_ELEMENTS_H
#define C4E_ELEMENTS_H


/* INCLUDES ******************************************************************/

#include "c4e_sys.h"


#ifdef  __cplusplus
extern "C" {
#endif


/* DEFINES *******************************************************************/


/* TYPEDEFS ******************************************************************/


    typedef struct
    {
        C4eArchIdx size;

        C4eArchDigit* digits;
    } C4eElement;



    typedef enum
    {
        C4eElemCmpEQ,                                
        C4eElemCmpLT,                 
        C4eElemCmpGT               
    } C4eElemCmp;


    typedef struct
    {
        C4eElement val;                                           
        C4eArchSize len;                        
    } C4eElemOsp;


    typedef struct
    {
        C4eElement x;                                     
        C4eElement y;                                    
        C4eArchUint attr;                          
    } C4eElemPair;


    typedef struct
    {
        C4eElement x;             
        C4eElement y;   
        C4eElement z;          
        C4eArchUint attr; 
    } C4eElemTriple;



/* MACROS ********************************************************************/



/* MACRO *********************************************************************/
#define C4E_ELEM_ASGN_MEM(elem, digmem) \
    ((elem)->digits = (digmem))


/* MACRO *********************************************************************/
#define C4E_ELEM_DIGITS_NUM(bytes)                                             \
    C4E_SYS_CAST(C4eArchIdx, C4E_SYS_DIV_CEIL((bytes), C4E_ARCH_DIGIT_SIZE))


/* MACRO *********************************************************************/
#define C4E_ELEM_IS_ZERO(x)     ((x)->size == 0U)



/* MACRO *********************************************************************/
#define C4E_ELEM_IS_NZERO(x)    (!C4E_ELEM_IS_ZERO(x))



/* MACRO *********************************************************************/
#define C4E_ELEM_SET_ZERO(x)    ((x)->size = 0U)


/* MACRO *********************************************************************/
#define C4E_ELEM_IS_ONE(x)     (((x)->size == 1U) && \
                                ((x)->digits[0] == C4E_SYS_DIGIT_ONE))


/* MACRO *********************************************************************/
#define C4E_ELEM_SET_ONE(x)                     \
    do                                          \
    {                                           \
        (x)->digits[0] = C4E_SYS_DIGIT_ONE;     \
        (x)->size = 1U;                         \
    } while (C4E_FALSE)


/* MACRO *********************************************************************/
#define C4E_ELEM_IS_EVEN(elem)                                          \
    (((elem)->digits[0] & C4E_SYS_DIGIT_ONE) == C4E_SYS_DIGIT_ZERO)



/* MACRO *********************************************************************/
#define C4E_ELEM_IS_ODD(elem)  (!C4E_ELEM_IS_EVEN(elem))


/* MACRO *********************************************************************/
#define C4E_ELEM_IS_NORM(x)                                     \
    (C4E_ELEM_IS_ZERO(x) ||                                     \
     ((x)->digits[(x)->size - 1U] != C4E_SYS_DIGIT_ZERO))



/* MACRO *********************************************************************/
#define C4E_ELEM_MUL2(x)        c4e_elem_bits_shl((x), 1U)



/* MACRO *********************************************************************/
#define C4E_ELEM_DIV2(x)        c4e_elem_bits_shr((x), 1U)



/* MACRO *********************************************************************/
#define C4E_ELEM_ASSERT_IN(x)                                                  \
    C4E_ASSERT(((x) != NULL) && (C4E_ELEM_IS_ZERO(x) || ((x)->digits != NULL)))


/* MACRO *********************************************************************/
#define C4E_ELEM_ASSERT_PTR(x)                          \
    C4E_ASSERT(((x) != NULL) && ((x)->digits != NULL))



/* MACRO *********************************************************************/
#define C4E_ELEM_ASSERT_NORM(x) C4E_ASSERT(C4E_ELEM_IS_NORM(x))



/* MACRO *********************************************************************/
#define C4E_ELEM_ASSERT_NZERO(x)        \
    C4E_ASSERT(C4E_ELEM_IS_NZERO(x))




/* PROTOTYPES ****************************************************************/



/* FUNCTION ******************************************************************/
    C4eArchDigit c4e_elem_msb(C4E_CONST C4eElement* x);


/* FUNCTION ******************************************************************/
    C4eArchSize c4e_elem_bits(C4E_CONST C4eElement* x);


/* FUNCTION ******************************************************************/
    void c4e_elem_norm(C4eElement* x);


/* FUNCTION ******************************************************************/
    void c4e_elem_cpy(C4E_CONST C4eElement* C4E_RESTRICT src,
                      C4eElement* C4E_RESTRICT dst);


/* FUNCTION ******************************************************************/
    void c4e_elem_swap(C4eElement* C4E_RESTRICT elem1,
                       C4eElement* C4E_RESTRICT elem2);


/* FUNCTION ******************************************************************/
    void c4e_elem_fill(C4E_CONST C4eElement* x, C4eArchDigit digit);


/* FUNCTION ******************************************************************/
    C4eSysStatus c4e_elem_rand(C4eElement* x);


/* FUNCTION ******************************************************************/
    void c4e_elem_digits_shl(C4eElement* x, C4eArchIdx shift);


/* FUNCTION ******************************************************************/
    void c4e_elem_bits_shl(C4eElement* x, C4eArchUint shift);


/* FUNCTION ******************************************************************/
    void c4e_elem_shl(C4eElement* x, C4eArchSize shift);



/* FUNCTION ******************************************************************/
    void c4e_elem_digits_shr(C4eElement* x, C4eArchIdx shift);


/* FUNCTION ******************************************************************/
    void c4e_elem_bits_shr(C4eElement* x, C4eArchUint shift);


/* FUNCTION ******************************************************************/
    void c4e_elem_shr(C4eElement* x, C4eArchSize shift);


/* FUNCTION ******************************************************************/
    void c4e_elem_os2e(C4E_CONST C4eArchUint8* C4E_RESTRICT osp, C4eArchSize len,
                       C4eElement* C4E_RESTRICT elem);


/* FUNCTION ******************************************************************/
    C4eArchSize c4e_elem_e2os(C4E_CONST C4eElement* C4E_RESTRICT elem,
                              C4eArchSize bufsize, C4eArchUint8* C4E_RESTRICT buf);



#ifdef  __cplusplus
}
#endif


#endif /* C4E_ELEMENTS_H */


/******************************************************************************/
/* END OF FILE                                                                */
/******************************************************************************/

---