2 * libsortnetwork - src/sn_network.c
3 * Copyright (C) 2008-2010 Florian octo Forster
5 * This library is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU Lesser General Public License as published by
7 * the Free Software Foundation; either version 2.1 of the License, or (at
8 * your option) any later version.
10 * This library is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
15 * You should have received a copy of the GNU Lesser General Public License
16 * along with this library; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 * Florian octo Forster <ff at octo.it>
23 #ifndef _ISOC99_SOURCE
24 # define _ISOC99_SOURCE
26 #ifndef _POSIX_C_SOURCE
27 # define _POSIX_C_SOURCE 200112L
31 # define DPRINTF(...) fprintf (stderr, "sn_network: " __VA_ARGS__)
33 # define DPRINTF(...) /**/
44 #include "sn_network.h"
45 #include "sn_random.h"
47 sn_network_t *sn_network_create (int inputs_num) /* {{{ */
51 n = (sn_network_t *) malloc (sizeof (sn_network_t));
54 memset (n, '\0', sizeof (sn_network_t));
56 n->inputs_num = inputs_num;
59 } /* }}} sn_network_t *sn_network_create */
61 void sn_network_destroy (sn_network_t *n) /* {{{ */
66 if (n->stages != NULL)
69 for (i = 0; i < n->stages_num; i++)
71 sn_stage_destroy (n->stages[i]);
79 } /* }}} void sn_network_destroy */
81 sn_network_t *sn_network_create_odd_even_mergesort (int inputs_num) /* {{{ */
85 n = sn_network_create (inputs_num);
87 assert (inputs_num > 0);
100 s = sn_stage_create (/* depth = */ 0);
101 sn_stage_comparator_add (s, &c);
102 sn_network_stage_add (n, s);
108 sn_network_t *n_left;
109 sn_network_t *n_right;
113 inputs_left = inputs_num / 2;
114 inputs_right = inputs_num - inputs_left;
116 n_left = sn_network_create_odd_even_mergesort (inputs_left);
120 n_right = sn_network_create_odd_even_mergesort (inputs_right);
123 sn_network_destroy (n_left);
127 n = sn_network_combine_odd_even_merge (n_left, n_right);
129 sn_network_destroy (n_left);
130 sn_network_destroy (n_right);
133 sn_network_compress (n);
137 } /* }}} sn_network_t *sn_network_create_odd_even_mergesort */
139 static int sn_network_create_pairwise_internal (sn_network_t *n, /* {{{ */
140 int *inputs, int inputs_num)
143 int inputs_copy[inputs_num];
146 for (i = 1; i < inputs_num; i += 2)
148 sn_comparator_t *c = sn_comparator_create (inputs[i-1], inputs[i]);
149 sn_network_comparator_add (n, c);
150 sn_comparator_destroy (c);
156 /* Sort "pairs" recursively. Like with odd-even mergesort, odd and even lines
157 * are handled recursively and later reunited. */
158 for (i = 0; i < inputs_num; i += 2)
159 inputs_copy[(int) (i / 2)] = inputs[i];
160 /* Recursive call #1 with first set of lines */
161 sn_network_create_pairwise_internal (n, inputs_copy,
162 (int) ((inputs_num + 1) / 2));
164 for (i = 1; i < inputs_num; i += 2)
165 inputs_copy[(int) (i / 2)] = inputs[i];
166 /* Recursive call #2 with second set of lines */
167 sn_network_create_pairwise_internal (n, inputs_copy,
168 (int) (inputs_num/ 2));
170 /* m is the "amplitude" of the sorted pairs. This is a bit tricky to read due
171 * to different indices being used in the paper, unfortunately. */
175 for (i = 1; (i + (m - 1)) < inputs_num; i += 2)
178 int right = i + (m - 1);
181 assert (left < right);
182 c = sn_comparator_create (inputs[left], inputs[right]);
183 sn_network_comparator_add (n, c);
184 sn_comparator_destroy (c);
188 } /* while (m > 1) */
191 } /* }}} int sn_network_create_pairwise_internal */
193 sn_network_t *sn_network_create_pairwise (int inputs_num) /* {{{ */
195 sn_network_t *n = sn_network_create (inputs_num);
196 int inputs[inputs_num];
202 for (i = 0; i < inputs_num; i++)
205 sn_network_create_pairwise_internal (n, inputs, inputs_num);
206 sn_network_compress (n);
209 } /* }}} sn_network_t *sn_network_create_pairwise */
211 int sn_network_network_add (sn_network_t *n, sn_network_t *other) /* {{{ */
216 if ((n == NULL) || (other == NULL))
219 stages_num = n->stages_num + other->stages_num;
220 if (stages_num <= n->stages_num)
223 tmp = realloc (n->stages, sizeof (*n->stages) * stages_num);
228 memcpy (n->stages + n->stages_num, other->stages,
229 sizeof (*other->stages) * other->stages_num);
230 n->stages_num = stages_num;
232 free (other->stages);
236 } /* }}} int sn_network_network_add */
238 int sn_network_stage_add (sn_network_t *n, sn_stage_t *s) /* {{{ */
242 if ((n == NULL) || (s == NULL))
245 temp = (sn_stage_t **) realloc (n->stages, (n->stages_num + 1)
246 * sizeof (sn_stage_t *));
251 SN_STAGE_DEPTH (s) = n->stages_num;
252 n->stages[n->stages_num] = s;
256 } /* }}} int sn_network_stage_add */
258 int sn_network_stage_remove (sn_network_t *n, int s_num) /* {{{ */
260 int nmemb = n->stages_num - (s_num + 1);
263 if ((n == NULL) || (s_num >= n->stages_num))
266 sn_stage_destroy (n->stages[s_num]);
267 n->stages[s_num] = NULL;
271 memmove (n->stages + s_num, n->stages + (s_num + 1),
272 nmemb * sizeof (sn_stage_t *));
273 n->stages[n->stages_num - 1] = NULL;
277 /* Free the unused memory */
278 if (n->stages_num == 0)
285 temp = (sn_stage_t **) realloc (n->stages,
286 n->stages_num * sizeof (sn_stage_t *));
293 } /* }}} int sn_network_stage_remove */
295 sn_network_t *sn_network_clone (const sn_network_t *n) /* {{{ */
297 sn_network_t *n_copy;
300 n_copy = sn_network_create (n->inputs_num);
304 for (i = 0; i < n->stages_num; i++)
309 s = sn_stage_clone (n->stages[i]);
313 status = sn_network_stage_add (n_copy, s);
318 if (i < n->stages_num)
320 sn_network_destroy (n_copy);
325 } /* }}} sn_network_t *sn_network_clone */
327 int sn_network_comparator_add (sn_network_t *n, /* {{{ */
328 const sn_comparator_t *c)
332 if ((n == NULL) || (c == NULL))
335 if (n->stages_num > 0)
337 s = n->stages[n->stages_num - 1];
339 if (sn_stage_comparator_check_conflict (s, c) == 0)
341 sn_stage_comparator_add (s, c);
346 s = sn_stage_create (n->stages_num);
347 sn_stage_comparator_add (s, c);
348 sn_network_stage_add (n, s);
351 } /* }}} int sn_network_comparator_add */
353 int sn_network_get_comparator_num (const sn_network_t *n) /* {{{ */
362 for (i = 0; i < n->stages_num; i++)
363 num += n->stages[i]->comparators_num;
366 } /* }}} int sn_network_get_comparator_num */
368 int sn_network_show (sn_network_t *n) /* {{{ */
372 for (i = 0; i < n->stages_num; i++)
373 sn_stage_show (n->stages[i]);
376 } /* }}} int sn_network_show */
378 int sn_network_invert (sn_network_t *n) /* {{{ */
385 for (i = 0; i < n->stages_num; i++)
386 sn_stage_invert (n->stages[i]);
389 } /* }}} int sn_network_invert */
391 int sn_network_shift (sn_network_t *n, int sw) /* {{{ */
395 if ((n == NULL) || (sw < 0))
401 for (i = 0; i < n->stages_num; i++)
402 sn_stage_shift (n->stages[i], sw, SN_NETWORK_INPUT_NUM (n));
405 } /* }}} int sn_network_shift */
407 int sn_network_compress (sn_network_t *n) /* {{{ */
413 for (i = 1; i < n->stages_num; i++)
419 for (j = 0; j < SN_STAGE_COMP_NUM (s); j++)
421 sn_comparator_t *c = SN_STAGE_COMP_GET (s, j);
424 for (k = i - 1; k >= 0; k--)
428 conflict = sn_stage_comparator_check_conflict (n->stages[k], c);
443 sn_stage_comparator_add (n->stages[move_to], c);
444 sn_stage_comparator_remove (s, j);
450 while ((n->stages_num > 0)
451 && (SN_STAGE_COMP_NUM (n->stages[n->stages_num - 1]) == 0))
452 sn_network_stage_remove (n, n->stages_num - 1);
455 } /* }}} int sn_network_compress */
457 int sn_network_normalize (sn_network_t *n) /* {{{ */
461 for (i = 0; i < n->stages_num; i++)
468 for (j = 0; j < SN_STAGE_COMP_NUM (s); j++)
474 c = SN_STAGE_COMP_GET (s, j);
483 for (k = i; k < n->stages_num; k++)
484 sn_stage_swap (n->stages[k], min, max);
489 } /* for (j = 0 .. #comparators) */
490 } /* for (i = n->stages_num - 1 .. 0) */
493 } /* }}} int sn_network_normalize */
495 int sn_network_remove_input (sn_network_t *n, int input) /* {{{ */
499 if ((n == NULL) || (input < 0) || (input >= n->inputs_num))
502 for (i = 0; i < n->stages_num; i++)
503 sn_stage_remove_input (n->stages[i], input);
508 } /* }}} int sn_network_remove_input */
510 int sn_network_cut_at (sn_network_t *n, int input, /* {{{ */
511 enum sn_network_cut_dir_e dir)
514 int position = input;
516 for (i = 0; i < n->stages_num; i++)
522 new_position = sn_stage_cut_at (s, position, dir);
524 if (position != new_position)
528 for (j = 0; j < i; j++)
529 sn_stage_swap (n->stages[j], position, new_position);
532 position = new_position;
535 assert (((dir == DIR_MIN) && (position == 0))
536 || ((dir == DIR_MAX) && (position == (n->inputs_num - 1))));
538 sn_network_remove_input (n, position);
541 } /* }}} int sn_network_cut_at */
543 int sn_network_cut (sn_network_t *n, int *mask) /* {{{ */
548 for (i = 0; i < n->stages_num; i++)
550 sn_stage_t *s = n->stages[i];
552 sn_stage_cut (s, mask, n->stages);
555 /* Use a copy of this member since it will be updated by
556 * sn_network_remove_input(). */
557 inputs_num = n->inputs_num;
558 for (i = 0; i < inputs_num; i++)
561 sn_network_remove_input (n, 0);
562 else if (mask[i] > 0)
563 sn_network_remove_input (n, n->inputs_num - 1);
567 } /* }}} int sn_network_cut */
569 /* sn_network_concatenate
571 * `Glues' two networks together, resulting in a comparator network with twice
572 * as many inputs but one that doesn't really sort anymore. It produces a
573 * bitonic sequence, though, that can be used by the mergers below. */
574 static sn_network_t *sn_network_concatenate (sn_network_t *n0, /* {{{ */
582 stages_num = (n0->stages_num > n1->stages_num)
586 n = sn_network_create (n0->inputs_num + n1->inputs_num);
590 for (i = 0; i < stages_num; i++)
592 sn_stage_t *s = sn_stage_create (i);
594 if (i < n0->stages_num)
595 for (j = 0; j < SN_STAGE_COMP_NUM (n0->stages[i]); j++)
597 sn_comparator_t *c = SN_STAGE_COMP_GET (n0->stages[i], j);
598 sn_stage_comparator_add (s, c);
601 if (i < n1->stages_num)
602 for (j = 0; j < SN_STAGE_COMP_NUM (n1->stages[i]); j++)
604 sn_comparator_t *c_orig = SN_STAGE_COMP_GET (n1->stages[i], j);
605 sn_comparator_t c_copy;
607 SN_COMP_MIN(&c_copy) = SN_COMP_MIN(c_orig) + n0->inputs_num;
608 SN_COMP_MAX(&c_copy) = SN_COMP_MAX(c_orig) + n0->inputs_num;
610 sn_stage_comparator_add (s, &c_copy);
613 sn_network_stage_add (n, s);
617 } /* }}} sn_network_t *sn_network_concatenate */
619 static int sn_network_add_bitonic_merger_recursive (sn_network_t *n, /* {{{ */
629 s = sn_stage_create (n->stages_num);
635 for (i = low; i < (low + m); i++)
642 sn_stage_comparator_add (s, &c);
645 sn_network_stage_add (n, s);
647 sn_network_add_bitonic_merger_recursive (n, low, m);
648 sn_network_add_bitonic_merger_recursive (n, low + m, m);
651 } /* }}} int sn_network_add_bitonic_merger_recursive */
653 static int sn_network_add_bitonic_merger (sn_network_t *n) /* {{{ */
660 s = sn_stage_create (n->stages_num);
664 m = n->inputs_num / 2;
666 for (i = 0; i < m; i++)
671 c.max = n->inputs_num - (i + 1);
673 sn_stage_comparator_add (s, &c);
676 sn_network_stage_add (n, s);
678 sn_network_add_bitonic_merger_recursive (n, 0, m);
679 sn_network_add_bitonic_merger_recursive (n, m, m);
681 sn_network_add_bitonic_merger_recursive (n, 0, SN_NETWORK_INPUT_NUM (n));
685 } /* }}} int sn_network_add_bitonic_merger */
687 static int sn_network_add_odd_even_merger (sn_network_t *n, /* {{{ */
688 int *indizes_left, int indizes_left_num,
689 int *indizes_right, int indizes_right_num)
691 int tmp_left[indizes_left_num];
693 int tmp_right[indizes_left_num];
699 if ((indizes_left_num == 0) || (indizes_right_num == 0))
703 else if ((indizes_left_num == 1) && (indizes_right_num == 1))
708 c.min = *indizes_left;
709 c.max = *indizes_right;
711 s = sn_stage_create (n->stages_num);
715 sn_stage_comparator_add (s, &c);
716 sn_network_stage_add (n, s);
721 /* Merge odd sequences */
722 tmp_left_num = (indizes_left_num + 1) / 2;
723 for (i = 0; i < tmp_left_num; i++)
724 tmp_left[i] = indizes_left[2 * i];
726 tmp_right_num = (indizes_right_num + 1) / 2;
727 for (i = 0; i < tmp_right_num; i++)
728 tmp_right[i] = indizes_right[2 * i];
730 sn_network_add_odd_even_merger (n,
731 tmp_left, tmp_left_num,
732 tmp_right, tmp_right_num);
734 /* Merge even sequences */
735 tmp_left_num = indizes_left_num / 2;
736 for (i = 0; i < tmp_left_num; i++)
737 tmp_left[i] = indizes_left[(2 * i) + 1];
739 tmp_right_num = indizes_right_num / 2;
740 for (i = 0; i < tmp_right_num; i++)
741 tmp_right[i] = indizes_right[(2 * i) + 1];
743 sn_network_add_odd_even_merger (n,
744 tmp_left, tmp_left_num,
745 tmp_right, tmp_right_num);
747 /* Apply ``comparison-interchange'' operations. */
748 s = sn_stage_create (n->stages_num);
750 max_index = indizes_left_num + indizes_right_num;
751 if ((max_index % 2) == 0)
756 for (i = 1; i <= max_index; i += 2)
760 if (i < indizes_left_num)
761 c.min = indizes_left[i];
763 c.min = indizes_right[i - indizes_left_num];
765 if ((i + 1) < indizes_left_num)
766 c.max = indizes_left[i + 1];
768 c.max = indizes_right[i + 1 - indizes_left_num];
770 sn_stage_comparator_add (s, &c);
773 sn_network_stage_add (n, s);
776 } /* }}} int sn_network_add_odd_even_merger */
778 static sn_network_t *sn_network_combine_bitonic_shift (sn_network_t *n0, /* {{{ */
779 sn_network_t *n1, int do_shift)
782 sn_network_t *n1_clone;
785 n1_clone = sn_network_clone (n1);
786 if (n1_clone == NULL)
789 sn_network_invert (n1_clone);
791 n = sn_network_concatenate (n0, n1_clone);
795 sn_network_destroy (n1_clone);
798 shift = sn_bounded_random (0, SN_NETWORK_INPUT_NUM (n) - 1);
804 DPRINTF ("sn_network_combine_bitonic_shift: Shifting by %i.\n", shift);
805 sn_network_shift (n, shift);
808 sn_network_add_bitonic_merger (n);
811 } /* }}} sn_network_t *sn_network_combine_bitonic_shift */
813 sn_network_t *sn_network_combine_bitonic_merge (sn_network_t *n0, /* {{{ */
816 return (sn_network_combine_bitonic_shift (n0, n1, /* do_shift = */ 0));
817 } /* }}} sn_network_t *sn_network_combine_bitonic_merge */
819 sn_network_t *sn_network_combine_odd_even_merge (sn_network_t *n0, /* {{{ */
823 int indizes_left[n0->inputs_num];
824 int indizes_left_num;
825 int indizes_right[n1->inputs_num];
826 int indizes_right_num;
830 indizes_left_num = n0->inputs_num;
831 indizes_right_num = n1->inputs_num;
832 for (i = 0; i < indizes_left_num; i++)
834 for (i = 0; i < indizes_right_num; i++)
835 indizes_right[i] = indizes_left_num + i;
837 n = sn_network_concatenate (n0, n1);
841 status = sn_network_add_odd_even_merger (n,
842 indizes_left, indizes_left_num,
843 indizes_right, indizes_right_num);
846 sn_network_destroy (n);
850 sn_network_compress (n);
852 } /* }}} sn_network_t *sn_network_combine_odd_even_merge */
854 sn_network_t *sn_network_combine (sn_network_t *n0, /* {{{ */
857 return (sn_network_combine_odd_even_merge (n0, n1));
858 } /* }}} sn_network_t *sn_network_combine */
860 int sn_network_sort (sn_network_t *n, int *values) /* {{{ */
866 for (i = 0; i < n->stages_num; i++)
868 status = sn_stage_sort (n->stages[i], values);
874 } /* }}} int sn_network_sort */
876 int sn_network_brute_force_check (sn_network_t *n) /* {{{ */
878 int test_pattern[n->inputs_num];
879 int values[n->inputs_num];
883 memset (test_pattern, 0, sizeof (test_pattern));
889 /* Copy the current pattern and let the network sort it */
890 memcpy (values, test_pattern, sizeof (values));
891 status = sn_network_sort (n, values);
895 /* Check if the array is now sorted. */
896 previous = values[0];
897 for (i = 1; i < n->inputs_num; i++)
899 if (previous > values[i])
901 previous = values[i];
904 /* Generate the next test pattern */
906 for (i = 0; i < n->inputs_num; i++)
908 if (test_pattern[i] == 0)
921 /* Break out of the while loop if we tested all possible patterns */
926 /* All tests successfull */
928 } /* }}} int sn_network_brute_force_check */
930 sn_network_t *sn_network_read (FILE *fh) /* {{{ */
937 while (fgets (buffer, sizeof (buffer), fh) != NULL)
939 char *str_key = buffer;
940 char *str_value = NULL;
941 int buffer_len = strlen (buffer);
943 while ((buffer_len > 0) && ((buffer[buffer_len - 1] == '\n')
944 || (buffer[buffer_len - 1] == '\r')))
947 buffer[buffer_len] = '\0';
952 str_value = strchr (buffer, ':');
953 if (str_value == NULL)
955 printf ("Cannot parse line: %s\n", buffer);
959 *str_value = '\0'; str_value++;
960 while ((*str_value != '\0') && (isspace (*str_value) != 0))
963 if (strcasecmp ("Inputs", str_key) == 0)
964 opt_inputs = atoi (str_value);
966 printf ("Unknown key: %s\n", str_key);
967 } /* while (fgets) */
972 n = sn_network_create (opt_inputs);
978 s = sn_stage_read (fh);
982 sn_network_stage_add (n, s);
985 if (SN_NETWORK_STAGE_NUM (n) < 1)
987 sn_network_destroy (n);
992 } /* }}} sn_network_t *sn_network_read */
994 sn_network_t *sn_network_read_file (const char *file) /* {{{ */
999 fh = fopen (file, "r");
1003 n = sn_network_read (fh);
1008 } /* }}} sn_network_t *sn_network_read_file */
1010 int sn_network_write (sn_network_t *n, FILE *fh) /* {{{ */
1014 fprintf (fh, "Inputs: %i\n", n->inputs_num);
1017 for (i = 0; i < n->stages_num; i++)
1018 sn_stage_write (n->stages[i], fh);
1021 } /* }}} int sn_network_write */
1023 int sn_network_write_file (sn_network_t *n, const char *file) /* {{{ */
1028 fh = fopen (file, "w");
1032 status = sn_network_write (n, fh);
1037 } /* }}} int sn_network_write_file */
1039 int sn_network_serialize (sn_network_t *n, char **ret_buffer, /* {{{ */
1040 size_t *ret_buffer_size)
1047 buffer = *ret_buffer;
1048 buffer_size = *ret_buffer_size;
1050 #define SNPRINTF_OR_FAIL(...) \
1051 status = snprintf (buffer, buffer_size, __VA_ARGS__); \
1052 if ((status < 1) || (((size_t) status) >= buffer_size)) \
1055 buffer_size -= status;
1057 SNPRINTF_OR_FAIL ("Inputs: %i\r\n\r\n", n->inputs_num);
1059 for (i = 0; i < n->stages_num; i++)
1061 status = sn_stage_serialize (n->stages[i], &buffer, &buffer_size);
1066 *ret_buffer = buffer;
1067 *ret_buffer_size = buffer_size;
1069 } /* }}} int sn_network_serialize */
1071 sn_network_t *sn_network_unserialize (char *buffer, /* {{{ */
1077 if (buffer_size == 0)
1080 /* Read options first */
1081 while (buffer_size > 0)
1090 endptr = strchr (buffer, '\n');
1097 line_len = strlen (line);
1099 if ((line_len > 0) && (line[line_len - 1] == '\r'))
1101 line[line_len - 1] = 0;
1109 str_value = strchr (line, ':');
1110 if (str_value == NULL)
1112 printf ("Cannot parse line: %s\n", line);
1116 *str_value = '\0'; str_value++;
1117 while ((*str_value != '\0') && (isspace (*str_value) != 0))
1120 if (strcasecmp ("Inputs", str_key) == 0)
1121 opt_inputs = atoi (str_value);
1123 printf ("Unknown key: %s\n", str_key);
1124 } /* while (fgets) */
1129 n = sn_network_create (opt_inputs);
1135 s = sn_stage_unserialize (&buffer, &buffer_size);
1139 sn_network_stage_add (n, s);
1142 if (SN_NETWORK_STAGE_NUM (n) < 1)
1144 sn_network_destroy (n);
1149 } /* }}} sn_network_t *sn_network_unserialize */
1151 /* vim: set sw=2 sts=2 et fdm=marker : */