summaryrefslogtreecommitdiff
path: root/support/dktools/dk3bf.h
blob: 671400e0351e40a447558a3d29d958d5987ff990 (plain)
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
/*
Copyright (C) 2011-2020, Dirk Krause
SPDX-License-Identifier: BSD-3-Clause
*/

/*
	WARNING: This file was generated by the dkct program (see
	http://dktools.sourceforge.net/ for details).
	Changes you make here will be lost if dkct is run again!
	You should modify the original source and run dkct on it.
	Original source: dk3bf.ctr
*/

/**	@file dk3bf.h Header file for the dk3bf module.
*/

#ifndef DK3BF_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK3BF_H_INCLUDED 1


#line 8 "dk3bf.ctr"

#include "dk3conf.h"
#include "dk3types.h"

#ifdef __cplusplus
extern "C" {
#endif


/**	Open a bit field (bit array).
	@param	nbits	Number of bits.
	@param	app	Application structure for diagnostics, may be NULL.
	@return	Pointer to new bit field on success, NULL on error.
*/
dk3_bf_t *
dk3bf_open_app(size_t nbits, dk3_app_t *app);

/**	Close bit field.
	@param	b	Bit field to close.
*/
void
dk3bf_close(dk3_bf_t *b);

/**	Set or reset one bit.
	@param	b	Bit field.
	@param	n	Index of bit to set.
	@param	v	New bit value (1 or 0).
*/
void
dk3bf_set(dk3_bf_t *b, size_t n, int v);

/**	Get one bit value.
	@param	b	Bit field.
	@param	n	Index of bit.
	@return	1 or 0 depending on the bit value.
*/
int
dk3bf_get(dk3_bf_t const *b, size_t n);

/**	Open a bit matrix.
	@param	x	Number of columns.
	@param	y	Number of rows.
	@param	app	Application structure for diagnostics, may be NULL.
	@return	Pointer to new bit matrix on success, NULL on error.
*/
dk3_bm_t *
dk3bm_open(size_t x, size_t y, dk3_app_t *app);

/**	Close bit matrix.
	@param	b	Bit matrix to close.
*/
void
dk3bm_close(dk3_bm_t *b);

/**	Set cache size (threshold to switch between traditional
	algorithm for dk3bm_expand and cache friendly algorithm).
	@param	b	Bit matrix.
	@param	cs	Maximum matrix size for traditional algorithm.
*/
void
dk3bm_set_cache_size(dk3_bm_t *b, size_t cs);

/**	Set or reset  one bit.
	@param	b	Bit matrix.
	@param	x	Column number.
	@param	y	Row number.
	@param	v	New value for bit.
*/
void
dk3bm_set(dk3_bm_t *b, size_t x, size_t y, int v);

/**	Get one bit.
	@param	b	Bit matrix.
	@param	x	Column number.
	@param	y	Row number.
	@return	1 or 0 depending on the bit value.
*/
int
dk3bm_get(dk3_bm_t const *b, size_t x, size_t y);

/**	Expand bit matrix. The matrix must be square.
	@param	b	Bit matrix.
*/
void
dk3bm_expand(dk3_bm_t *b);


#ifdef __cplusplus
}
#endif




#endif