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 static int sn_network_create_pairwise_internal (sn_network_t *n, /* {{{ */
139 int *inputs, int inputs_num)
142 int inputs_copy[inputs_num];
145 for (i = 1; i < inputs_num; i += 2)
147 sn_comparator_t *c = sn_comparator_create (inputs[i-1], inputs[i]);
148 sn_network_comparator_add (n, c);
149 sn_comparator_destroy (c);
155 /* Sort "pairs" recursively. Like with odd-even mergesort, odd and even lines
156 * are handled recursively and later reunited. */
157 for (i = 0; i < inputs_num; i += 2)
158 inputs_copy[(int) (i / 2)] = inputs[i];
159 /* Recursive call #1 with first set of lines */
160 sn_network_create_pairwise_internal (n, inputs_copy,
161 (int) ((inputs_num + 1) / 2));
163 for (i = 1; i < inputs_num; i += 2)
164 inputs_copy[(int) (i / 2)] = inputs[i];
165 /* Recursive call #2 with second set of lines */
166 sn_network_create_pairwise_internal (n, inputs_copy,
167 (int) (inputs_num/ 2));
169 /* m is the "amplitude" of the sorted pairs. This is a bit tricky to read due
170 * to different indices being used in the paper, unfortunately. */
174 for (i = 1; (i + (m - 1)) < inputs_num; i += 2)
177 int right = i + (m - 1);
180 assert (left < right);
181 c = sn_comparator_create (inputs[left], inputs[right]);
182 sn_network_comparator_add (n, c);
183 sn_comparator_destroy (c);
187 } /* while (m > 1) */
190 } /* }}} int sn_network_create_pairwise_internal */
192 sn_network_t *sn_network_create_pairwise (int inputs_num) /* {{{ */
194 sn_network_t *n = sn_network_create (inputs_num);
195 int inputs[inputs_num];
201 for (i = 0; i < inputs_num; i++)
204 sn_network_create_pairwise_internal (n, inputs, inputs_num);
205 sn_network_compress (n);
208 } /* }}} sn_network_t *sn_network_create_pairwise */
210 int sn_network_stage_add (sn_network_t *n, sn_stage_t *s) /* {{{ */
214 if ((n == NULL) || (s == NULL))
217 temp = (sn_stage_t **) realloc (n->stages, (n->stages_num + 1)
218 * sizeof (sn_stage_t *));
223 SN_STAGE_DEPTH (s) = n->stages_num;
224 n->stages[n->stages_num] = s;
228 } /* }}} int sn_network_stage_add */
230 int sn_network_stage_remove (sn_network_t *n, int s_num) /* {{{ */
232 int nmemb = n->stages_num - (s_num + 1);
235 if ((n == NULL) || (s_num >= n->stages_num))
238 sn_stage_destroy (n->stages[s_num]);
239 n->stages[s_num] = NULL;
243 memmove (n->stages + s_num, n->stages + (s_num + 1),
244 nmemb * sizeof (sn_stage_t *));
245 n->stages[n->stages_num - 1] = NULL;
249 /* Free the unused memory */
250 if (n->stages_num == 0)
257 temp = (sn_stage_t **) realloc (n->stages,
258 n->stages_num * sizeof (sn_stage_t *));
265 } /* }}} int sn_network_stage_remove */
267 sn_network_t *sn_network_clone (const sn_network_t *n) /* {{{ */
269 sn_network_t *n_copy;
272 n_copy = sn_network_create (n->inputs_num);
276 for (i = 0; i < n->stages_num; i++)
281 s = sn_stage_clone (n->stages[i]);
285 status = sn_network_stage_add (n_copy, s);
290 if (i < n->stages_num)
292 sn_network_destroy (n_copy);
297 } /* }}} sn_network_t *sn_network_clone */
299 int sn_network_comparator_add (sn_network_t *n, /* {{{ */
300 const sn_comparator_t *c)
304 if ((n == NULL) || (c == NULL))
307 if (n->stages_num > 0)
309 s = n->stages[n->stages_num - 1];
311 if (sn_stage_comparator_check_conflict (s, c) == 0)
313 sn_stage_comparator_add (s, c);
318 s = sn_stage_create (n->stages_num);
319 sn_stage_comparator_add (s, c);
320 sn_network_stage_add (n, s);
323 } /* }}} int sn_network_comparator_add */
325 int sn_network_get_comparator_num (const sn_network_t *n) /* {{{ */
334 for (i = 0; i < n->stages_num; i++)
335 num += n->stages[i]->comparators_num;
338 } /* }}} int sn_network_get_comparator_num */
340 int sn_network_show (sn_network_t *n) /* {{{ */
344 for (i = 0; i < n->stages_num; i++)
345 sn_stage_show (n->stages[i]);
348 } /* }}} int sn_network_show */
350 int sn_network_invert (sn_network_t *n) /* {{{ */
357 for (i = 0; i < n->stages_num; i++)
358 sn_stage_invert (n->stages[i]);
361 } /* }}} int sn_network_invert */
363 int sn_network_shift (sn_network_t *n, int sw) /* {{{ */
367 if ((n == NULL) || (sw < 0))
373 for (i = 0; i < n->stages_num; i++)
374 sn_stage_shift (n->stages[i], sw, SN_NETWORK_INPUT_NUM (n));
377 } /* }}} int sn_network_shift */
379 int sn_network_compress (sn_network_t *n) /* {{{ */
385 for (i = 1; i < n->stages_num; i++)
391 for (j = 0; j < SN_STAGE_COMP_NUM (s); j++)
393 sn_comparator_t *c = SN_STAGE_COMP_GET (s, j);
396 for (k = i - 1; k >= 0; k--)
400 conflict = sn_stage_comparator_check_conflict (n->stages[k], c);
415 sn_stage_comparator_add (n->stages[move_to], c);
416 sn_stage_comparator_remove (s, j);
422 while ((n->stages_num > 0)
423 && (SN_STAGE_COMP_NUM (n->stages[n->stages_num - 1]) == 0))
424 sn_network_stage_remove (n, n->stages_num - 1);
427 } /* }}} int sn_network_compress */
429 int sn_network_normalize (sn_network_t *n) /* {{{ */
433 for (i = 0; i < n->stages_num; i++)
440 for (j = 0; j < SN_STAGE_COMP_NUM (s); j++)
446 c = SN_STAGE_COMP_GET (s, j);
455 for (k = i; k < n->stages_num; k++)
456 sn_stage_swap (n->stages[k], min, max);
461 } /* for (j = 0 .. #comparators) */
462 } /* for (i = n->stages_num - 1 .. 0) */
465 } /* }}} int sn_network_normalize */
467 int sn_network_remove_input (sn_network_t *n, int input) /* {{{ */
471 if ((n == NULL) || (input < 0) || (input >= n->inputs_num))
474 for (i = 0; i < n->stages_num; i++)
475 sn_stage_remove_input (n->stages[i], input);
480 } /* }}} int sn_network_remove_input */
482 int sn_network_cut_at (sn_network_t *n, int input, /* {{{ */
483 enum sn_network_cut_dir_e dir)
486 int position = input;
488 for (i = 0; i < n->stages_num; i++)
494 new_position = sn_stage_cut_at (s, position, dir);
496 if (position != new_position)
500 for (j = 0; j < i; j++)
501 sn_stage_swap (n->stages[j], position, new_position);
504 position = new_position;
507 assert (((dir == DIR_MIN) && (position == 0))
508 || ((dir == DIR_MAX) && (position == (n->inputs_num - 1))));
510 sn_network_remove_input (n, position);
513 } /* }}} int sn_network_cut_at */
515 int sn_network_cut (sn_network_t *n, int *mask) /* {{{ */
520 for (i = 0; i < n->stages_num; i++)
522 sn_stage_t *s = n->stages[i];
524 sn_stage_cut (s, mask, n->stages);
527 /* Use a copy of this member since it will be updated by
528 * sn_network_remove_input(). */
529 inputs_num = n->inputs_num;
530 for (i = 0; i < inputs_num; i++)
533 sn_network_remove_input (n, 0);
534 else if (mask[i] > 0)
535 sn_network_remove_input (n, n->inputs_num - 1);
539 } /* }}} int sn_network_cut */
541 /* sn_network_concatenate
543 * `Glues' two networks together, resulting in a comparator network with twice
544 * as many inputs but one that doesn't really sort anymore. It produces a
545 * bitonic sequence, though, that can be used by the mergers below. */
546 static sn_network_t *sn_network_concatenate (sn_network_t *n0, /* {{{ */
554 stages_num = (n0->stages_num > n1->stages_num)
558 n = sn_network_create (n0->inputs_num + n1->inputs_num);
562 for (i = 0; i < stages_num; i++)
564 sn_stage_t *s = sn_stage_create (i);
566 if (i < n0->stages_num)
567 for (j = 0; j < SN_STAGE_COMP_NUM (n0->stages[i]); j++)
569 sn_comparator_t *c = SN_STAGE_COMP_GET (n0->stages[i], j);
570 sn_stage_comparator_add (s, c);
573 if (i < n1->stages_num)
574 for (j = 0; j < SN_STAGE_COMP_NUM (n1->stages[i]); j++)
576 sn_comparator_t *c_orig = SN_STAGE_COMP_GET (n1->stages[i], j);
577 sn_comparator_t c_copy;
579 SN_COMP_MIN(&c_copy) = SN_COMP_MIN(c_orig) + n0->inputs_num;
580 SN_COMP_MAX(&c_copy) = SN_COMP_MAX(c_orig) + n0->inputs_num;
582 sn_stage_comparator_add (s, &c_copy);
585 sn_network_stage_add (n, s);
589 } /* }}} sn_network_t *sn_network_concatenate */
591 static int sn_network_add_bitonic_merger_recursive (sn_network_t *n, /* {{{ */
601 s = sn_stage_create (n->stages_num);
607 for (i = low; i < (low + m); i++)
614 sn_stage_comparator_add (s, &c);
617 sn_network_stage_add (n, s);
619 sn_network_add_bitonic_merger_recursive (n, low, m);
620 sn_network_add_bitonic_merger_recursive (n, low + m, m);
623 } /* }}} int sn_network_add_bitonic_merger_recursive */
625 static int sn_network_add_bitonic_merger (sn_network_t *n) /* {{{ */
632 s = sn_stage_create (n->stages_num);
636 m = n->inputs_num / 2;
638 for (i = 0; i < m; i++)
643 c.max = n->inputs_num - (i + 1);
645 sn_stage_comparator_add (s, &c);
648 sn_network_stage_add (n, s);
650 sn_network_add_bitonic_merger_recursive (n, 0, m);
651 sn_network_add_bitonic_merger_recursive (n, m, m);
653 sn_network_add_bitonic_merger_recursive (n, 0, SN_NETWORK_INPUT_NUM (n));
657 } /* }}} int sn_network_add_bitonic_merger */
659 static int sn_network_add_odd_even_merger (sn_network_t *n, /* {{{ */
660 int *indizes_left, int indizes_left_num,
661 int *indizes_right, int indizes_right_num)
663 int tmp_left[indizes_left_num];
665 int tmp_right[indizes_left_num];
671 if ((indizes_left_num == 0) || (indizes_right_num == 0))
675 else if ((indizes_left_num == 1) && (indizes_right_num == 1))
680 c.min = *indizes_left;
681 c.max = *indizes_right;
683 s = sn_stage_create (n->stages_num);
687 sn_stage_comparator_add (s, &c);
688 sn_network_stage_add (n, s);
693 /* Merge odd sequences */
694 tmp_left_num = (indizes_left_num + 1) / 2;
695 for (i = 0; i < tmp_left_num; i++)
696 tmp_left[i] = indizes_left[2 * i];
698 tmp_right_num = (indizes_right_num + 1) / 2;
699 for (i = 0; i < tmp_right_num; i++)
700 tmp_right[i] = indizes_right[2 * i];
702 sn_network_add_odd_even_merger (n,
703 tmp_left, tmp_left_num,
704 tmp_right, tmp_right_num);
706 /* Merge even sequences */
707 tmp_left_num = indizes_left_num / 2;
708 for (i = 0; i < tmp_left_num; i++)
709 tmp_left[i] = indizes_left[(2 * i) + 1];
711 tmp_right_num = indizes_right_num / 2;
712 for (i = 0; i < tmp_right_num; i++)
713 tmp_right[i] = indizes_right[(2 * i) + 1];
715 sn_network_add_odd_even_merger (n,
716 tmp_left, tmp_left_num,
717 tmp_right, tmp_right_num);
719 /* Apply ``comparison-interchange'' operations. */
720 s = sn_stage_create (n->stages_num);
722 max_index = indizes_left_num + indizes_right_num;
723 if ((max_index % 2) == 0)
728 for (i = 1; i <= max_index; i += 2)
732 if (i < indizes_left_num)
733 c.min = indizes_left[i];
735 c.min = indizes_right[i - indizes_left_num];
737 if ((i + 1) < indizes_left_num)
738 c.max = indizes_left[i + 1];
740 c.max = indizes_right[i + 1 - indizes_left_num];
742 sn_stage_comparator_add (s, &c);
745 sn_network_stage_add (n, s);
748 } /* }}} int sn_network_add_odd_even_merger */
750 static sn_network_t *sn_network_combine_bitonic_shift (sn_network_t *n0, /* {{{ */
751 sn_network_t *n1, int do_shift)
754 sn_network_t *n1_clone;
757 n1_clone = sn_network_clone (n1);
758 if (n1_clone == NULL)
761 sn_network_invert (n1_clone);
763 n = sn_network_concatenate (n0, n1_clone);
767 sn_network_destroy (n1_clone);
770 shift = sn_bounded_random (0, SN_NETWORK_INPUT_NUM (n) - 1);
776 DPRINTF ("sn_network_combine_bitonic_shift: Shifting by %i.\n", shift);
777 sn_network_shift (n, shift);
780 sn_network_add_bitonic_merger (n);
783 } /* }}} sn_network_t *sn_network_combine_bitonic_shift */
785 sn_network_t *sn_network_combine_bitonic_merge (sn_network_t *n0, /* {{{ */
788 return (sn_network_combine_bitonic_shift (n0, n1, /* do_shift = */ 0));
789 } /* }}} sn_network_t *sn_network_combine_bitonic_merge */
791 sn_network_t *sn_network_combine_odd_even_merge (sn_network_t *n0, /* {{{ */
795 int indizes_left[n0->inputs_num];
796 int indizes_left_num;
797 int indizes_right[n1->inputs_num];
798 int indizes_right_num;
802 indizes_left_num = n0->inputs_num;
803 indizes_right_num = n1->inputs_num;
804 for (i = 0; i < indizes_left_num; i++)
806 for (i = 0; i < indizes_right_num; i++)
807 indizes_right[i] = indizes_left_num + i;
809 n = sn_network_concatenate (n0, n1);
813 status = sn_network_add_odd_even_merger (n,
814 indizes_left, indizes_left_num,
815 indizes_right, indizes_right_num);
818 sn_network_destroy (n);
822 sn_network_compress (n);
824 } /* }}} sn_network_t *sn_network_combine_odd_even_merge */
826 sn_network_t *sn_network_combine (sn_network_t *n0, /* {{{ */
829 return (sn_network_combine_odd_even_merge (n0, n1));
830 } /* }}} sn_network_t *sn_network_combine */
832 int sn_network_sort (sn_network_t *n, int *values) /* {{{ */
838 for (i = 0; i < n->stages_num; i++)
840 status = sn_stage_sort (n->stages[i], values);
846 } /* }}} int sn_network_sort */
848 int sn_network_brute_force_check (sn_network_t *n) /* {{{ */
850 int test_pattern[n->inputs_num];
851 int values[n->inputs_num];
855 memset (test_pattern, 0, sizeof (test_pattern));
861 /* Copy the current pattern and let the network sort it */
862 memcpy (values, test_pattern, sizeof (values));
863 status = sn_network_sort (n, values);
867 /* Check if the array is now sorted. */
868 previous = values[0];
869 for (i = 1; i < n->inputs_num; i++)
871 if (previous > values[i])
873 previous = values[i];
876 /* Generate the next test pattern */
878 for (i = 0; i < n->inputs_num; i++)
880 if (test_pattern[i] == 0)
893 /* Break out of the while loop if we tested all possible patterns */
898 /* All tests successfull */
900 } /* }}} int sn_network_brute_force_check */
902 sn_network_t *sn_network_read (FILE *fh) /* {{{ */
909 while (fgets (buffer, sizeof (buffer), fh) != NULL)
911 char *str_key = buffer;
912 char *str_value = NULL;
913 int buffer_len = strlen (buffer);
915 while ((buffer_len > 0) && ((buffer[buffer_len - 1] == '\n')
916 || (buffer[buffer_len - 1] == '\r')))
919 buffer[buffer_len] = '\0';
924 str_value = strchr (buffer, ':');
925 if (str_value == NULL)
927 printf ("Cannot parse line: %s\n", buffer);
931 *str_value = '\0'; str_value++;
932 while ((*str_value != '\0') && (isspace (*str_value) != 0))
935 if (strcasecmp ("Inputs", str_key) == 0)
936 opt_inputs = atoi (str_value);
938 printf ("Unknown key: %s\n", str_key);
939 } /* while (fgets) */
944 n = sn_network_create (opt_inputs);
950 s = sn_stage_read (fh);
954 sn_network_stage_add (n, s);
957 if (SN_NETWORK_STAGE_NUM (n) < 1)
959 sn_network_destroy (n);
964 } /* }}} sn_network_t *sn_network_read */
966 sn_network_t *sn_network_read_file (const char *file) /* {{{ */
971 fh = fopen (file, "r");
975 n = sn_network_read (fh);
980 } /* }}} sn_network_t *sn_network_read_file */
982 int sn_network_write (sn_network_t *n, FILE *fh) /* {{{ */
986 fprintf (fh, "Inputs: %i\n", n->inputs_num);
989 for (i = 0; i < n->stages_num; i++)
990 sn_stage_write (n->stages[i], fh);
993 } /* }}} int sn_network_write */
995 int sn_network_write_file (sn_network_t *n, const char *file) /* {{{ */
1000 fh = fopen (file, "w");
1004 status = sn_network_write (n, fh);
1009 } /* }}} int sn_network_write_file */
1011 int sn_network_serialize (sn_network_t *n, char **ret_buffer, /* {{{ */
1012 size_t *ret_buffer_size)
1019 buffer = *ret_buffer;
1020 buffer_size = *ret_buffer_size;
1022 #define SNPRINTF_OR_FAIL(...) \
1023 status = snprintf (buffer, buffer_size, __VA_ARGS__); \
1024 if ((status < 1) || (((size_t) status) >= buffer_size)) \
1027 buffer_size -= status;
1029 SNPRINTF_OR_FAIL ("Inputs: %i\r\n\r\n", n->inputs_num);
1031 for (i = 0; i < n->stages_num; i++)
1033 status = sn_stage_serialize (n->stages[i], &buffer, &buffer_size);
1038 *ret_buffer = buffer;
1039 *ret_buffer_size = buffer_size;
1041 } /* }}} int sn_network_serialize */
1043 sn_network_t *sn_network_unserialize (char *buffer, /* {{{ */
1049 if (buffer_size == 0)
1052 /* Read options first */
1053 while (buffer_size > 0)
1062 endptr = strchr (buffer, '\n');
1069 line_len = strlen (line);
1071 if ((line_len > 0) && (line[line_len - 1] == '\r'))
1073 line[line_len - 1] = 0;
1081 str_value = strchr (line, ':');
1082 if (str_value == NULL)
1084 printf ("Cannot parse line: %s\n", line);
1088 *str_value = '\0'; str_value++;
1089 while ((*str_value != '\0') && (isspace (*str_value) != 0))
1092 if (strcasecmp ("Inputs", str_key) == 0)
1093 opt_inputs = atoi (str_value);
1095 printf ("Unknown key: %s\n", str_key);
1096 } /* while (fgets) */
1101 n = sn_network_create (opt_inputs);
1107 s = sn_stage_unserialize (&buffer, &buffer_size);
1111 sn_network_stage_add (n, s);
1114 if (SN_NETWORK_STAGE_NUM (n) < 1)
1116 sn_network_destroy (n);
1121 } /* }}} sn_network_t *sn_network_unserialize */
1123 /* vim: set sw=2 sts=2 et fdm=marker : */