summaryrefslogtreecommitdiff
path: root/support/dktools/dk4bml.ctr
blob: 86acc9edb74a3264b47d47cc6ecf1f74ab2db8a7 (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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
%%	options

copyright owner	=	Dirk Krause
copyright year	=	2019-xxxx
SPDX-License-Identifier:	BSD-3-Clause


%%	header

/**	@file	dk4bml.h	Levelize graph using a bit matrix.

	Levelizing means counting the path length from start nodes (nodes
	with no predecessor) to a certain node.

	Levelizing here must be able to handle loops.

	Two nodes are in the same loop if there is both a path from one node
	to the other and a path vice versa.

	Node a is a one-way predecessor of node b if a is a predecessor of b
	and there is a path from a to b but not path from b to a.
	This means a and b are not in the same loop.

	Nodes without a predecessor are level 0 nodes.

	In each pass all nodes not yet evaluated are checked.
	A node is evaluated if at least all one-way predecessor nodes are evaluated.
	The nodes value/level is the maximum value of all (not just the one-way)
	predecessors already evaluated, increased by one.

*/


#ifndef	DK4BM_H_INCLUDED
#if	DK4_BUILDING_DKTOOLS4
#include "dk4bm.h"
#else
#include <dktools-4/dk4bm.h>
#endif
#endif

#ifdef	__cplusplus
extern "C" {
#endif


/**	Levelize graph nodes.

	CRT on Windows: Optional.

	@param	pdest	Destination array for the node levels.
	@param	szdest	Size of destination array.
	@param	pbm		Bit matrix representing the graph.
	@param	isrev	Flag: Reverse notation is used in pbm.
	@param	erp		Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if pdest or pbm is NULL or szdest is 0,
	- DK4_E_SYNTAX<br>
	  if the matrix is not square or szdest is smaller then the number of rows,
	- DK4_E_MATH_OVERFLOW<br>
	  if a numeric overflow happens in size calculations for
	  temporary data,
	- DK4_E_MEMORY_ALLOCATION_FAILED<br>
	  if a memory allocation attempt for temporary data fails.
*/

int
dk4bm_levelize(
	size_t					*pdest,
	size_t					 szdest,
	dk4_bit_matrix_t const	*pbm,
	int						 isrev,
	dk4_er_t				*erp
);


/**	Levelize graph nodes.

	CRT on Windows: Optional.

	@param	pdest	Destination array for the node levels.
	@param	szdest	Size of destination array.
	@param	pbm		Bit matrix representing the graph, must already be expanded.
	@param	isrev	Flag: Reverse notation is used in pbm.
	@param	erp		Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if pdest or pbm is NULL or szdest is 0,
	- DK4_E_SYNTAX<br>
	  if the matrix is not square or szdest is smaller then the number of rows,
	- DK4_E_MATH_OVERFLOW<br>
	  if a numeric overflow happens in size calculations for
	  temporary data,
	- DK4_E_MEMORY_ALLOCATION_FAILED<br>
	  if a memory allocation attempt for temporary data fails.
*/

int
dk4bm_levelize_expanded(
	size_t					*pdest,
	size_t					 szdest,
	dk4_bit_matrix_t const	*pbm,
	int						 isrev,
	dk4_er_t				*erp
);


#ifdef	__cplusplus
}
#endif

%%	module

#include "dk4bml.h"
#include "dk4bf.h"

$!trace-include


/**	0 as size_t.
*/
#define	SZ0	((size_t)0U)

/**	1 as size_t.
*/
#define	SZ1	((size_t)1U)



/**	Mark all nodes without predecessors as evaluated.
	@param	pbm	Bit matrix containing reverse graph representation, must be
				already expanded.
	@param	pbf	Bits to mark nodes as evaluated.
*/

static
void
dk4bm_i_reverse_start(
	dk4_bit_matrix_t const	*pbm,
	dk4_bit_field_t			*pbf
)
{
	size_t		i;		/* Current node to inspect */
	size_t		j;		/* Predecessor candidate */
	int			hp;		/* Flag: Have predecessor */
	int			v;		/* Bit value */
	$? "+ dk4bm_i_reverse_start"
	for (i = SZ0; i < pbm->rows; i++) {
		hp = 0;
		for (j = SZ0; j < pbm->rows; j++) {
			if (i != j) {
				v = 0;
				if (0 != dk4bm_get(&v, pbm, i, j, NULL)) {
					if (0 != v) {
						hp = 1;
					}
				}
				else {
					i = j = pbm->rows - SZ1;
				}
			}
		}
		if (0 == hp) {
			dk4bf_set(pbf, i, 1, NULL);
		}
	}	$? "- dk4bm_i_reverse_start"
}



/**	Levelize graph nodes from bit matrix containig reversed representation.

	@param	pdest	Destination array for the node levels.
	@param	pbm		Bit matrix representing the graph, must already be expanded.
	@param	pbf		Bit field, which nodes are already evaluated.
*/

static
void
dk4bm_i_reverse_levelize(
	size_t					*pdest,
	dk4_bit_matrix_t const	*pbm,
	dk4_bit_field_t			*pbf
)
{
	size_t		i;		/* Current node to inspect */
	size_t		j;		/* Predecessor candidate */
	size_t		max;	/* Maximum evaluation value found so far */
#if	TRACE_DEBUG
	size_t		passno;	/* Current pass number */
#endif
	int			ch;		/* Flag: Change occured in current pass */
	int			unev;	/* Flag: Node has unevaluated predecessor */
	int			v;		/* Test value */
	$? "+ dk4bm_i_reverse_levelize"
	/*
		Mark all nodes without predecessor as evaluated.
	*/
	dk4bm_i_reverse_start(pbm, pbf);
#if	TRACE_DEBUG
	passno = SZ0;
#endif
	do {							$? ". pass %lu", (unsigned long)passno
		ch = 0;
		for (i = SZ0; i < pbm->rows; i++) {
			v = 0;					$? ". check node %lu", (unsigned long)i
			if (0 != dk4bf_get(&v, pbf, i, NULL)) {
				if (0 == v) {		$? ". not yet evaluated"
					/*
						Current node i is not yet evaluated
					*/
					max = SZ0;
					unev = 0;
					for (j = SZ0; j < pbm->rows; j++) {
						if (i != j) {
							v = 0;
							if (0 != dk4bm_get(&v, pbm, i, j, NULL)) {
								if (0 != v) {
									v = 0;
									if (0 != dk4bf_get(&v, pbf, j, NULL)) {
										if (0 != v) {
											/*
												Node j is already evaluated
											*/
											if (pdest[j] > max) {
												max = pdest[j];
											}
										}
										else {
											/*
												Node j is not yet evaluated
											*/
											v = 0;
											if(0 != dk4bm_get(&v,pbm,j,i,NULL)){
												/*
													We can not evaluate node i
													unless i and j are in a
													loop.
												*/
												if (0 == v) {
													unev = 1;
												}
											}
											else {
												/* ERROR */
												i = j = pbm->rows - SZ1; ch = 0;
											}
										}
									}
									else {
										/* ERROR */
										i = j = pbm->rows - SZ1; ch = 0;
									}
								}
							}
							else {
								/* ERROR */
								i = j = pbm->rows - SZ1; ch = 0;
							}
						}
					}
					/*
						Evaluate node if no unevaluated predecessors
					*/
					if (0 == unev) {
						pdest[i] = max + SZ1;
						dk4bf_set(pbf, i, 1, NULL);
						ch = 1;
						$?  ". pass=%lu node=%lu level=%lu", (unsigned long)passno, (unsigned long)i, (unsigned long)(max + SZ1)
					}
				}
#if	TRACE_DEBUG
				else {	$? ". already evaluated %lu", (unsigned long)(pdest[i])
				}
#endif
			}
			else {
				/* ERROR */
				i = pbm->rows - SZ1; ch = 0;
			}
		}
#if	TRACE_DEBUG
		passno++;
#endif
	} while(1 == ch);
	$? "- dk4bm_i_reverse_levelize"
}



/**	Mark all nodes without predecessors as evaluated.
	@param	pbm	Bit matrix containing forward graph representation, must
				be expanded.
	@param	pbf	Bits to mark nodes as evaluated.
*/

static
void
dk4bm_i_forward_start(
	dk4_bit_matrix_t const	*pbm,
	dk4_bit_field_t			*pbf
)
{
	size_t		i;		/* Current node to inspect */
	size_t		j;		/* Predecessor candidate */
	int			hp;		/* Flag: Have predecessor */
	int			v;		/* Bit value */
	$? "+ dk4bm_i_forward_start"
	for (i = SZ0; i < pbm->rows; i++) {
		hp = 0;
		for (j = SZ0; j < pbm->rows; j++) {
			if (i != j) {
				v = 0;
				if (0 != dk4bm_get(&v, pbm, j, i, NULL)) {
					if (0 != v) {
						hp = 1;
					}
				}
				else {
					i = j = pbm->rows - SZ1;
				}
			}
		}
		if (0 == hp) {
			dk4bf_set(pbf, i, 1, NULL);
		}
	}	$? "- dk4bm_i_forward_start"
}



/**	Levelize graph nodes from bit matrix containig forward  representation.

	@param	pdest	Destination array for the node levels.
	@param	szdest	Size of destination array.
	@param	pbm		Bit matrix representing the graph, must already be expanded.
	@param	pbf		Bit field, which nodes are already evaluated.
*/

static
void
dk4bm_i_forward_levelize(
	size_t					*pdest,
	dk4_bit_matrix_t const	*pbm,
	dk4_bit_field_t			*pbf
)
{
	size_t		i;		/* Current node to inspect */
	size_t		j;		/* Predecessor candidate */
	size_t		max;	/* Maximum evaluation value found so far */
#if	TRACE_DEBUG
	size_t		passno;	/* Current pass number */
#endif
	int			ch;		/* Flag: Change occured in current pass */
	int			unev;	/* Flag: Node has unevaluated predecessor */
	int			v;		/* Value */
	$? "+ dk4bm_i_forward_levelize"
	/*
		Mark all nodes without predecessor as evaluated.
	*/
	dk4bm_i_forward_start(pbm, pbf);
#if	TRACE_DEBUG
	passno = SZ0;
#endif
	do {							$? ". pass %lu", (unsigned long)passno
		ch = 0;
		for (i = SZ0; i < pbm->rows; i++) {
			v = 0;					$? ". check node %lu", (unsigned long)i
			if (0 != dk4bf_get(&v, pbf, i, NULL)) {
				if (0 == v) {		$? ". not yet evaluated"
					/*
						Current node i is not yet evaluated
					*/
					max = SZ0;
					unev = 0;
					for (j = SZ0; j < pbm->rows; j++) {
						if (i != j) {
							v = 0;
							if (0 != dk4bm_get(&v, pbm, j, i, NULL)) {
								if (0 != v) {
									v = 0;
									if (0 != dk4bf_get(&v, pbf, j, NULL)) {
										if (0 != v) {
											/*
												Node j is already evaluated
											*/
											if (pdest[j] > max) {
												max = pdest[j];
											}
										}
										else {
											/*
												Node j is not yet evaluated
											*/
											v = 0;
											if(0 != dk4bm_get(&v,pbm,i,j,NULL)){
												/*
													We can not evaluate node i
													unless i and j are in a
													loop.
												*/
												if (0 == v) {
													unev = 1;
												}
											}
											else {
												/* ERROR */
												i = j = pbm->rows - SZ1; ch = 0;
											}
										}
									}
									else {
										/* ERROR */
										i = j = pbm->rows - SZ1; ch = 0;
									}
								}
							}
							else {
								/* ERROR */
								i = j = pbm->rows - SZ1; ch = 0;
							}
						}
					}
					/*
						Evaluate node if no unevaluated predecessors
					*/
					if (0 == unev) {
						pdest[i] = max + SZ1;
						dk4bf_set(pbf, i, 1, NULL);
						ch = 1;
						$?  ". pass=%lu node=%lu level=%lu", (unsigned long)passno, (unsigned long)i, (unsigned long)(max + SZ1)
					}
				}
#if	TRACE_DEBUG
				else {	$? ". already evaluated %lu", (unsigned long)(pdest[i])
				}
#endif
			}
			else {
				/* ERROR */
				i = pbm->rows - SZ1; ch = 0;
			}
		}
#if	TRACE_DEBUG
		passno++;
#endif
	} while(1 == ch);
	$? "- dk4bm_i_forward_levelize"
}



static
int
dk4bm_i_levelize(
	size_t					*pdest,
	size_t					 szdest,
	dk4_bit_matrix_t const	*pbm,
	int						 isrev,
	dk4_er_t				*erp
)
{
	dk4_bit_matrix_t	*bm	= NULL;
	dk4_bit_field_t		*bf	= NULL;
	size_t				*pres;
	size_t				 i;
	int					 back = 0;
	$? "+ dk4bm_i_levelize"
	bm = dk4bm_open_copy(pbm, erp);
	if (NULL != bm) {
		bf = dk4bf_open(bm->columns, erp);
		if (NULL != bf) {
			dk4bm_expand(bm, erp);
			pres = pdest;
			for (i = 0; i < szdest; i++) { *(pres++) = 0; }
			if (0 != isrev) {
				dk4bm_i_reverse_levelize(pdest, bm, bf);
			}
			else {
				dk4bm_i_forward_levelize(pdest, bm, bf);
			}
			back = 1;
			dk4bf_close(bf);
		}
		dk4bm_close(bm, 1);
	}	$? "- dk4bm_i_levelize %d", back
	return back;
}



static
int
dk4bm_i_expanded_levelize(
	size_t					*pdest,
	size_t					 szdest,
	dk4_bit_matrix_t const	*pbm,
	int						 isrev,
	dk4_er_t				*erp
)
{
	dk4_bit_field_t		*bf	= NULL;
	size_t				*pres;
	size_t				 i;
	int					 back = 0;
	$? "+ dk4bm_i_expanded_levelize"
	bf = dk4bf_open(pbm->columns, erp);
	if (NULL != bf) {
		pres = pdest;
		for (i = 0; i < szdest; i++) { *(pres++) = 0; }
		if (0 != isrev) {
			dk4bm_i_reverse_levelize(pdest, pbm, bf);
		}
		else {
			dk4bm_i_forward_levelize(pdest, pbm, bf);
		}
		back = 1;
		dk4bf_close(bf);
	}
	$? "- dk4bm_i_expanded_levelize %d", back
	return back;
}



int
dk4bm_levelize(
	size_t					*pdest,
	size_t					 szdest,
	dk4_bit_matrix_t const	*pbm,
	int						 isrev,
	dk4_er_t				*erp
)
{
	int		 back	= 0;
	$? "+ dk4bm_levelize"
	if ((NULL != pdest) && (0 < szdest) && (NULL != pbm)) {
		if ((pbm->rows <= szdest) && (pbm->rows == pbm->columns)) {
			back = dk4bm_i_levelize(pdest, szdest, pbm, isrev, erp);
		}
		else {
			dk4error_set_simple_error_code(erp, DK4_E_SYNTAX);
		}
	}
	else {
		dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
	}	$? "- dk4bm_levelize %d", back
	return back;
}



int
dk4bm_levelize_expanded(
	size_t					*pdest,
	size_t					 szdest,
	dk4_bit_matrix_t const	*pbm,
	int						 isrev,
	dk4_er_t				*erp
)
{
	int		 back	= 0;
	$? "+ dk4bm_levelize_expanded"
	if ((NULL != pdest) && (0 < szdest) && (NULL != pbm)) {
		if ((pbm->rows <= szdest) && (pbm->rows == pbm->columns)) {
			back = dk4bm_i_expanded_levelize(pdest, szdest, pbm, isrev, erp);
		}
		else {
			dk4error_set_simple_error_code(erp, DK4_E_SYNTAX);
		}
	}
	else {
		dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
	}	$? "- dk4bm_levelize_expanded %d", back
	return back;
}



/* vim: set ai sw=4 ts=4 : */