2 * libsortnetwork - src/sn_network.c
3 * Copyright (C) 2008-2010 Florian octo Forster
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; only version 2 of the License is applicable.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 * Florian octo Forster <ff at octo.it>
22 #ifndef _ISOC99_SOURCE
23 # define _ISOC99_SOURCE
25 #ifndef _POSIX_C_SOURCE
26 # define _POSIX_C_SOURCE 200112L
30 # define DPRINTF(...) fprintf (stderr, "sn_network: " __VA_ARGS__)
32 # define DPRINTF(...) /**/
43 #include "sn_network.h"
44 #include "sn_random.h"
46 sn_network_t *sn_network_create (int inputs_num) /* {{{ */
50 n = (sn_network_t *) malloc (sizeof (sn_network_t));
53 memset (n, '\0', sizeof (sn_network_t));
55 n->inputs_num = inputs_num;
58 } /* }}} sn_network_t *sn_network_create */
60 void sn_network_destroy (sn_network_t *n) /* {{{ */
65 if (n->stages != NULL)
68 for (i = 0; i < n->stages_num; i++)
70 sn_stage_destroy (n->stages[i]);
78 } /* }}} void sn_network_destroy */
80 sn_network_t *sn_network_create_odd_even_mergesort (int inputs_num) /* {{{ */
84 n = sn_network_create (inputs_num);
86 assert (inputs_num > 0);
99 s = sn_stage_create (/* depth = */ 0);
100 sn_stage_comparator_add (s, &c);
101 sn_network_stage_add (n, s);
107 sn_network_t *n_left;
108 sn_network_t *n_right;
112 inputs_left = inputs_num / 2;
113 inputs_right = inputs_num - inputs_left;
115 n_left = sn_network_create_odd_even_mergesort (inputs_left);
119 n_right = sn_network_create_odd_even_mergesort (inputs_right);
122 sn_network_destroy (n_left);
126 n = sn_network_combine_odd_even_merge (n_left, n_right);
128 sn_network_destroy (n_left);
129 sn_network_destroy (n_right);
132 sn_network_compress (n);
136 } /* }}} sn_network_t *sn_network_create_odd_even_mergesort */
138 int sn_network_stage_add (sn_network_t *n, sn_stage_t *s) /* {{{ */
142 if ((n == NULL) || (s == NULL))
145 temp = (sn_stage_t **) realloc (n->stages, (n->stages_num + 1)
146 * sizeof (sn_stage_t *));
151 SN_STAGE_DEPTH (s) = n->stages_num;
152 n->stages[n->stages_num] = s;
156 } /* }}} int sn_network_stage_add */
158 int sn_network_stage_remove (sn_network_t *n, int s_num) /* {{{ */
160 int nmemb = n->stages_num - (s_num + 1);
163 if ((n == NULL) || (s_num >= n->stages_num))
166 sn_stage_destroy (n->stages[s_num]);
167 n->stages[s_num] = NULL;
171 memmove (n->stages + s_num, n->stages + (s_num + 1),
172 nmemb * sizeof (sn_stage_t *));
173 n->stages[n->stages_num - 1] = NULL;
177 /* Free the unused memory */
178 if (n->stages_num == 0)
185 temp = (sn_stage_t **) realloc (n->stages,
186 n->stages_num * sizeof (sn_stage_t *));
193 } /* }}} int sn_network_stage_remove */
195 sn_network_t *sn_network_clone (const sn_network_t *n) /* {{{ */
197 sn_network_t *n_copy;
200 n_copy = sn_network_create (n->inputs_num);
204 for (i = 0; i < n->stages_num; i++)
209 s = sn_stage_clone (n->stages[i]);
213 status = sn_network_stage_add (n_copy, s);
218 if (i < n->stages_num)
220 sn_network_destroy (n_copy);
225 } /* }}} sn_network_t *sn_network_clone */
227 int sn_network_comparator_add (sn_network_t *n, /* {{{ */
228 const sn_comparator_t *c)
232 if ((n == NULL) || (c == NULL))
235 if (n->stages_num > 0)
237 s = n->stages[n->stages_num - 1];
239 if (sn_stage_comparator_check_conflict (s, c) == 0)
241 sn_stage_comparator_add (s, c);
246 s = sn_stage_create (n->stages_num);
247 sn_stage_comparator_add (s, c);
248 sn_network_stage_add (n, s);
251 } /* }}} int sn_network_comparator_add */
253 int sn_network_get_comparator_num (const sn_network_t *n) /* {{{ */
262 for (i = 0; i < n->stages_num; i++)
263 num += n->stages[i]->comparators_num;
266 } /* }}} int sn_network_get_comparator_num */
268 int sn_network_show (sn_network_t *n) /* {{{ */
272 for (i = 0; i < n->stages_num; i++)
273 sn_stage_show (n->stages[i]);
276 } /* }}} int sn_network_show */
278 int sn_network_invert (sn_network_t *n) /* {{{ */
285 for (i = 0; i < n->stages_num; i++)
286 sn_stage_invert (n->stages[i]);
289 } /* }}} int sn_network_invert */
291 int sn_network_shift (sn_network_t *n, int sw) /* {{{ */
295 if ((n == NULL) || (sw < 0))
301 for (i = 0; i < n->stages_num; i++)
302 sn_stage_shift (n->stages[i], sw, SN_NETWORK_INPUT_NUM (n));
305 } /* }}} int sn_network_shift */
307 int sn_network_compress (sn_network_t *n) /* {{{ */
313 for (i = 1; i < n->stages_num; i++)
319 for (j = 0; j < SN_STAGE_COMP_NUM (s); j++)
321 sn_comparator_t *c = SN_STAGE_COMP_GET (s, j);
324 for (k = i - 1; k >= 0; k--)
328 conflict = sn_stage_comparator_check_conflict (n->stages[k], c);
343 sn_stage_comparator_add (n->stages[move_to], c);
344 sn_stage_comparator_remove (s, j);
350 while ((n->stages_num > 0)
351 && (SN_STAGE_COMP_NUM (n->stages[n->stages_num - 1]) == 0))
352 sn_network_stage_remove (n, n->stages_num - 1);
355 } /* }}} int sn_network_compress */
357 int sn_network_normalize (sn_network_t *n) /* {{{ */
361 for (i = 0; i < n->stages_num; i++)
368 for (j = 0; j < SN_STAGE_COMP_NUM (s); j++)
374 c = SN_STAGE_COMP_GET (s, j);
383 for (k = i; k < n->stages_num; k++)
384 sn_stage_swap (n->stages[k], min, max);
389 } /* for (j = 0 .. #comparators) */
390 } /* for (i = n->stages_num - 1 .. 0) */
393 } /* }}} int sn_network_normalize */
395 int sn_network_cut_at (sn_network_t *n, int input, /* {{{ */
396 enum sn_network_cut_dir_e dir)
399 int position = input;
401 for (i = 0; i < n->stages_num; i++)
407 new_position = sn_stage_cut_at (s, position, dir);
409 if (position != new_position)
413 for (j = 0; j < i; j++)
414 sn_stage_swap (n->stages[j], position, new_position);
417 position = new_position;
420 assert (((dir == DIR_MIN) && (position == 0))
421 || ((dir == DIR_MAX) && (position == (n->inputs_num - 1))));
423 for (i = 0; i < n->stages_num; i++)
424 sn_stage_remove_input (n->stages[i], position);
429 } /* }}} int sn_network_cut_at */
431 /* sn_network_concatenate
433 * `Glues' two networks together, resulting in a comparator network with twice
434 * as many inputs but one that doesn't really sort anymore. It produces a
435 * bitonic sequence, though, that can be used by the mergers below. */
436 static sn_network_t *sn_network_concatenate (sn_network_t *n0, /* {{{ */
444 stages_num = (n0->stages_num > n1->stages_num)
448 n = sn_network_create (n0->inputs_num + n1->inputs_num);
452 for (i = 0; i < stages_num; i++)
454 sn_stage_t *s = sn_stage_create (i);
456 if (i < n0->stages_num)
457 for (j = 0; j < SN_STAGE_COMP_NUM (n0->stages[i]); j++)
459 sn_comparator_t *c = SN_STAGE_COMP_GET (n0->stages[i], j);
460 sn_stage_comparator_add (s, c);
463 if (i < n1->stages_num)
464 for (j = 0; j < SN_STAGE_COMP_NUM (n1->stages[i]); j++)
466 sn_comparator_t *c_orig = SN_STAGE_COMP_GET (n1->stages[i], j);
467 sn_comparator_t c_copy;
469 SN_COMP_MIN(&c_copy) = SN_COMP_MIN(c_orig) + n0->inputs_num;
470 SN_COMP_MAX(&c_copy) = SN_COMP_MAX(c_orig) + n0->inputs_num;
472 sn_stage_comparator_add (s, &c_copy);
475 sn_network_stage_add (n, s);
479 } /* }}} sn_network_t *sn_network_concatenate */
481 static int sn_network_add_bitonic_merger_recursive (sn_network_t *n, /* {{{ */
491 s = sn_stage_create (n->stages_num);
497 for (i = low; i < (low + m); i++)
504 sn_stage_comparator_add (s, &c);
507 sn_network_stage_add (n, s);
509 sn_network_add_bitonic_merger_recursive (n, low, m);
510 sn_network_add_bitonic_merger_recursive (n, low + m, m);
513 } /* }}} int sn_network_add_bitonic_merger_recursive */
515 static int sn_network_add_bitonic_merger (sn_network_t *n) /* {{{ */
522 s = sn_stage_create (n->stages_num);
526 m = n->inputs_num / 2;
528 for (i = 0; i < m; i++)
533 c.max = n->inputs_num - (i + 1);
535 sn_stage_comparator_add (s, &c);
538 sn_network_stage_add (n, s);
540 sn_network_add_bitonic_merger_recursive (n, 0, m);
541 sn_network_add_bitonic_merger_recursive (n, m, m);
543 sn_network_add_bitonic_merger_recursive (n, 0, SN_NETWORK_INPUT_NUM (n));
547 } /* }}} int sn_network_add_bitonic_merger */
549 static int sn_network_add_odd_even_merger (sn_network_t *n, /* {{{ */
550 int *indizes_left, int indizes_left_num,
551 int *indizes_right, int indizes_right_num)
553 int tmp_left[indizes_left_num];
555 int tmp_right[indizes_left_num];
561 if ((indizes_left_num == 0) || (indizes_right_num == 0))
565 else if ((indizes_left_num == 1) && (indizes_right_num == 1))
570 c.min = *indizes_left;
571 c.max = *indizes_right;
573 s = sn_stage_create (n->stages_num);
577 sn_stage_comparator_add (s, &c);
578 sn_network_stage_add (n, s);
583 /* Merge odd sequences */
584 tmp_left_num = (indizes_left_num + 1) / 2;
585 for (i = 0; i < tmp_left_num; i++)
586 tmp_left[i] = indizes_left[2 * i];
588 tmp_right_num = (indizes_right_num + 1) / 2;
589 for (i = 0; i < tmp_right_num; i++)
590 tmp_right[i] = indizes_right[2 * i];
592 sn_network_add_odd_even_merger (n,
593 tmp_left, tmp_left_num,
594 tmp_right, tmp_right_num);
596 /* Merge even sequences */
597 tmp_left_num = indizes_left_num / 2;
598 for (i = 0; i < tmp_left_num; i++)
599 tmp_left[i] = indizes_left[(2 * i) + 1];
601 tmp_right_num = indizes_right_num / 2;
602 for (i = 0; i < tmp_right_num; i++)
603 tmp_right[i] = indizes_right[(2 * i) + 1];
605 sn_network_add_odd_even_merger (n,
606 tmp_left, tmp_left_num,
607 tmp_right, tmp_right_num);
609 /* Apply ``comparison-interchange'' operations. */
610 s = sn_stage_create (n->stages_num);
612 max_index = indizes_left_num + indizes_right_num;
613 if ((max_index % 2) == 0)
618 for (i = 1; i <= max_index; i += 2)
622 if (i < indizes_left_num)
623 c.min = indizes_left[i];
625 c.min = indizes_right[i - indizes_left_num];
627 if ((i + 1) < indizes_left_num)
628 c.max = indizes_left[i + 1];
630 c.max = indizes_right[i + 1 - indizes_left_num];
632 sn_stage_comparator_add (s, &c);
635 sn_network_stage_add (n, s);
638 } /* }}} int sn_network_add_odd_even_merger */
640 static sn_network_t *sn_network_combine_bitonic_shift (sn_network_t *n0, /* {{{ */
641 sn_network_t *n1, int do_shift)
644 sn_network_t *n1_clone;
647 n1_clone = sn_network_clone (n1);
648 if (n1_clone == NULL)
651 sn_network_invert (n1_clone);
653 n = sn_network_concatenate (n0, n1_clone);
657 sn_network_destroy (n1_clone);
660 shift = sn_bounded_random (0, SN_NETWORK_INPUT_NUM (n) - 1);
666 DPRINTF ("sn_network_combine_bitonic_shift: Shifting by %i.\n", shift);
667 sn_network_shift (n, shift);
670 sn_network_add_bitonic_merger (n);
673 } /* }}} sn_network_t *sn_network_combine_bitonic_shift */
675 sn_network_t *sn_network_combine_bitonic_merge (sn_network_t *n0, /* {{{ */
678 return (sn_network_combine_bitonic_shift (n0, n1, /* do_shift = */ 0));
679 } /* }}} sn_network_t *sn_network_combine_bitonic_merge */
681 sn_network_t *sn_network_combine_odd_even_merge (sn_network_t *n0, /* {{{ */
685 int indizes_left[n0->inputs_num];
686 int indizes_left_num;
687 int indizes_right[n1->inputs_num];
688 int indizes_right_num;
692 indizes_left_num = n0->inputs_num;
693 indizes_right_num = n1->inputs_num;
694 for (i = 0; i < indizes_left_num; i++)
696 for (i = 0; i < indizes_right_num; i++)
697 indizes_right[i] = indizes_left_num + i;
699 n = sn_network_concatenate (n0, n1);
703 status = sn_network_add_odd_even_merger (n,
704 indizes_left, indizes_left_num,
705 indizes_right, indizes_right_num);
708 sn_network_destroy (n);
712 sn_network_compress (n);
714 } /* }}} sn_network_t *sn_network_combine_odd_even_merge */
716 sn_network_t *sn_network_combine (sn_network_t *n0, /* {{{ */
719 return (sn_network_combine_odd_even_merge (n0, n1));
720 } /* }}} sn_network_t *sn_network_combine */
722 int sn_network_sort (sn_network_t *n, int *values) /* {{{ */
728 for (i = 0; i < n->stages_num; i++)
730 status = sn_stage_sort (n->stages[i], values);
736 } /* }}} int sn_network_sort */
738 int sn_network_brute_force_check (sn_network_t *n) /* {{{ */
740 int test_pattern[n->inputs_num];
741 int values[n->inputs_num];
745 memset (test_pattern, 0, sizeof (test_pattern));
751 /* Copy the current pattern and let the network sort it */
752 memcpy (values, test_pattern, sizeof (values));
753 status = sn_network_sort (n, values);
757 /* Check if the array is now sorted. */
758 previous = values[0];
759 for (i = 1; i < n->inputs_num; i++)
761 if (previous > values[i])
763 previous = values[i];
766 /* Generate the next test pattern */
768 for (i = 0; i < n->inputs_num; i++)
770 if (test_pattern[i] == 0)
783 /* Break out of the while loop if we tested all possible patterns */
788 /* All tests successfull */
790 } /* }}} int sn_network_brute_force_check */
792 sn_network_t *sn_network_read (FILE *fh) /* {{{ */
799 while (fgets (buffer, sizeof (buffer), fh) != NULL)
801 char *str_key = buffer;
802 char *str_value = NULL;
803 int buffer_len = strlen (buffer);
805 while ((buffer_len > 0) && ((buffer[buffer_len - 1] == '\n')
806 || (buffer[buffer_len - 1] == '\r')))
809 buffer[buffer_len] = '\0';
814 str_value = strchr (buffer, ':');
815 if (str_value == NULL)
817 printf ("Cannot parse line: %s\n", buffer);
821 *str_value = '\0'; str_value++;
822 while ((*str_value != '\0') && (isspace (*str_value) != 0))
825 if (strcasecmp ("Inputs", str_key) == 0)
826 opt_inputs = atoi (str_value);
828 printf ("Unknown key: %s\n", str_key);
829 } /* while (fgets) */
834 n = sn_network_create (opt_inputs);
840 s = sn_stage_read (fh);
844 sn_network_stage_add (n, s);
847 if (SN_NETWORK_STAGE_NUM (n) < 1)
849 sn_network_destroy (n);
854 } /* }}} sn_network_t *sn_network_read */
856 sn_network_t *sn_network_read_file (const char *file) /* {{{ */
861 fh = fopen (file, "r");
865 n = sn_network_read (fh);
870 } /* }}} sn_network_t *sn_network_read_file */
872 int sn_network_write (sn_network_t *n, FILE *fh) /* {{{ */
876 fprintf (fh, "Inputs: %i\n", n->inputs_num);
879 for (i = 0; i < n->stages_num; i++)
880 sn_stage_write (n->stages[i], fh);
883 } /* }}} int sn_network_write */
885 int sn_network_write_file (sn_network_t *n, const char *file) /* {{{ */
890 fh = fopen (file, "w");
894 status = sn_network_write (n, fh);
899 } /* }}} int sn_network_write_file */
901 int sn_network_serialize (sn_network_t *n, char **ret_buffer, /* {{{ */
902 size_t *ret_buffer_size)
909 buffer = *ret_buffer;
910 buffer_size = *ret_buffer_size;
912 #define SNPRINTF_OR_FAIL(...) \
913 status = snprintf (buffer, buffer_size, __VA_ARGS__); \
914 if ((status < 1) || (((size_t) status) >= buffer_size)) \
917 buffer_size -= status;
919 SNPRINTF_OR_FAIL ("Inputs: %i\r\n\r\n", n->inputs_num);
921 for (i = 0; i < n->stages_num; i++)
923 status = sn_stage_serialize (n->stages[i], &buffer, &buffer_size);
928 *ret_buffer = buffer;
929 *ret_buffer_size = buffer_size;
931 } /* }}} int sn_network_serialize */
933 sn_network_t *sn_network_unserialize (char *buffer, /* {{{ */
939 if (buffer_size == 0)
942 /* Read options first */
943 while (buffer_size > 0)
952 endptr = strchr (buffer, '\n');
959 line_len = strlen (line);
961 if ((line_len > 0) && (line[line_len - 1] == '\r'))
963 line[line_len - 1] = 0;
971 str_value = strchr (line, ':');
972 if (str_value == NULL)
974 printf ("Cannot parse line: %s\n", line);
978 *str_value = '\0'; str_value++;
979 while ((*str_value != '\0') && (isspace (*str_value) != 0))
982 if (strcasecmp ("Inputs", str_key) == 0)
983 opt_inputs = atoi (str_value);
985 printf ("Unknown key: %s\n", str_key);
986 } /* while (fgets) */
991 n = sn_network_create (opt_inputs);
997 s = sn_stage_unserialize (&buffer, &buffer_size);
1001 sn_network_stage_add (n, s);
1004 if (SN_NETWORK_STAGE_NUM (n) < 1)
1006 sn_network_destroy (n);
1011 } /* }}} sn_network_t *sn_network_unserialize */
1013 /* vim: set sw=2 sts=2 et fdm=marker : */