FilesExpand file tree

 master

/

bitarray.h

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

96 lines (80 loc) · 3.57 KB

 master

/

bitarray.h

Copy path

Top

File metadata and controls

• Code
• Blame

96 lines (80 loc) · 3.57 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

/***************************************************************************

* Arrays of Arbitrary Bit Length

*

* File : bitarray.h

* Purpose : Header file for library supporting the creation and

* manipulation of arbitrary length arrays of bits.

* Author : Michael Dipperstein

* Date : January 30, 2004

*

****************************************************************************

*

* Bitarray: An ANSI C library for manipulating arbitrary length bit arrays

* Copyright (C) 2004, 2006-2007, 2014 by

* Michael Dipperstein (mdipperstein@gmail.com)

*

* This file is part of the bit array library.

*

* The bit array library is free software; you can redistribute it and/or

* modify it under the terms of the GNU Lesser General Public License as

* published by the Free Software Foundation; either version 3 of the

* License, or (at your option) any later version.

*

* The bit array library is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser

* General Public License for more details.

*

* You should have received a copy of the GNU Lesser General Public License

* along with this program. If not, see <http://www.gnu.org/licenses/>.

*

***************************************************************************/

#ifndef BIT_ARRAY_H

#define BIT_ARRAY_H

/***************************************************************************

* TYPE DEFINITIONS

***************************************************************************/

/* incomplete type to hide implementation */

struct bit_array_t;

typedef struct bit_array_t bit_array_t;

/***************************************************************************

* PROTOTYPES

***************************************************************************/

/* create/destroy functions */

bit_array_t *BitArrayCreate(const unsigned int bits);

void BitArrayDestroy(bit_array_t *ba);

/* debug functions */

void BitArrayDump(const bit_array_t *const ba, FILE *outFile);

/* set/clear functions */

void BitArraySetAll(const bit_array_t *const ba);

void BitArrayClearAll(const bit_array_t *const ba);

int BitArraySetBit(const bit_array_t *const ba, const unsigned int bit);

int BitArrayClearBit(const bit_array_t *const ba, const unsigned int bit);

/* raw bit access */

void *BitArrayGetBits(const bit_array_t *const ba);

/* bit test function */

int BitArrayTestBit(const bit_array_t *const ba, const unsigned int bit);

/* copy functions */

int BitArrayCopy(const bit_array_t *const dest, const bit_array_t *const src);

bit_array_t *BitArrayDuplicate(const bit_array_t *const src);

/* logical operations */

int BitArrayAnd(const bit_array_t *const dest,

const bit_array_t *const src1,

const bit_array_t *const src2);

int BitArrayOr(const bit_array_t *const dest,

const bit_array_t *const src1,

const bit_array_t *const src2);

int BitArrayXor(const bit_array_t *const dest,

const bit_array_t *const src1,

const bit_array_t *const src2);

int BitArrayNot(const bit_array_t *const dest,

const bit_array_t *const src);

/* bit shift functions */

int BitArrayShiftLeft(const bit_array_t *const ba, unsigned int shifts);

int BitArrayShiftRight(const bit_array_t *const ba, unsigned int shifts);

/* increment/decrement */

int BitArrayIncrement(const bit_array_t *const ba);

int BitArrayDecrement(const bit_array_t *const ba);

/* comparison */

int BitArrayCompare(const bit_array_t *ba1, const bit_array_t *ba2);

#endif /* ndef BIT_ARRAY_H */