src/sn_network.h

   1 /**
   2  * \file sn_network.h
   3  * \brief The sn_network_t class and associated methods.
   4  *
   5  * This is more details about what this file does.
   6  *
   7  * \verbatim
   8  * libsortnetwork - src/sn_network.h
   9  * Copyright (C) 2008-2010  Florian octo Forster
  10  *
  11  * This program is free software; you can redistribute it and/or modify it
  12  * under the terms of the GNU General Public License as published by the
  13  * Free Software Foundation; only version 2 of the License is applicable.
  14  *
  15  * This program is distributed in the hope that it will be useful, but
  16  * WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  23  *
  24  * Authors:
  25  *   Florian octo Forster <ff at octo.it>
  26  * \endverbatim
  27  **/
  28
  29
  30 #ifndef SN_NETWORK_H
  31 #define SN_NETWORK_H 1
  32
  33 #include <stdio.h>
  34
  35 #include "sn_comparator.h"
  36 #include "sn_stage.h"
  37
  38 /**
  39  * The global struct representing a comparator or sort network.
  40  */
  41 struct sn_network_s
  42 {
  43   int inputs_num;       /**< Number of inputs of the comparator network. */
  44   sn_stage_t **stages;  /**< Array of pointers to the stages of a comparator network. */
  45   int stages_num;       /**< Number of stages in this comparator network. */
  46 };
  47 typedef struct sn_network_s sn_network_t;
  48
  49 #define SN_NETWORK_STAGE_NUM(n) (n)->stages_num
  50 #define SN_NETWORK_STAGE_GET(n,i) ((n)->stages[i])
  51 #define SN_NETWORK_INPUT_NUM(n) (n)->inputs_num
  52
  53 /**
  54  * Creates an empty comparator network and returns a pointer to it.
  55  *
  56  * \param inputs_num Number of inputs the comparator network has.
  57  * \return Pointer to the comparator network or NULL on error.
  58  */
  59 sn_network_t *sn_network_create (int inputs_num);
  60
  61 /**
  62  * Clones an existing comparator network.
  63  *
  64  * \param n Comparator network to clone.
  65  * \return Copied sort network or NULL on error. The returned network must be
  66  *   freed using sn_network_destroy().
  67  */
  68 sn_network_t *sn_network_clone (const sn_network_t *n);
  69
  70 /**
  71  * Destroys a comparator network allocated with sn_network_create() or one of
  72  * the other methods returning a sn_network_t. This frees all allocated space.
  73  *
  74  * \param n The comparator network to destroy. May be NULL.
  75  */
  76 void sn_network_destroy (sn_network_t *n);
  77
  78 /**
  79  * Creates a new sort network using Batcher's Odd-Even-Mergesort algorithm.
  80  *
  81  * \param inputs_num Number of inputs / outputs of the sorting network.
  82  * \return A pointer to the newly allocated sorting network or NULL if an
  83  *   invalid number of inputs was given or allocation failed.
  84  */
  85 sn_network_t *sn_network_create_odd_even_mergesort (int inputs_num);
  86
  87 /**
  88  * Append a new stage to a comparator network.
  89  *
  90  * \param n The comparator network to which to add the stage.
  91  * \param s A pointer to a stage. The memory pointed to by this parameter is
  92  *   not copied and freed by sn_network_destroy(). It is the caller's
  93  *   responsibility to call sn_stage_clone() if appropriate.
  94  * \return Zero on success, non-zero on failure.
  95  */
  96 int sn_network_stage_add (sn_network_t *n, sn_stage_t *s);
  97
  98 /**
  99  * Remove a stage from a comparator network.
 100  *
 101  * \param n A pointer to the comparator network to modify.
 102  * \param s_num The depth of the comparator network to remove, with zero being
 103  *   meaning the stage closest to the inputs.
 104  * \return Zero on success, non-zero on failure.
 105  */
 106 int sn_network_stage_remove (sn_network_t *n, int s_num);
 107
 108 /**
 109  * Adds a comparator to a comparator network. The code tries to add the
 110  * comparator to the last stage, i.e. the stage closest to the outputs. If this
 111  * is not possible, because one line is used by another comparator, a new stage
 112  * is created and appended to the sorting network.
 113  *
 114  * \param n Pointer to the comparator netork.
 115  * \param c Pointer to a comparator to add. The given comparator is copied. It
 116  *   is the caller's responsibility to free c.
 117  * \return Zero on success, non-zero on failure.
 118  */
 119 int sn_network_comparator_add (sn_network_t *n, const sn_comparator_t *c);
 120
 121 /**
 122  * Returns the number of comparators contained in the comparator network. This
 123  * will traverse all comparators in all stages, resulting in a running time of
 124  * \f$ \mathcal{O}(n) \f$.
 125  *
 126  * \param n Comparator network to work with.
 127  * \return The number of comparators contained in the network or less than zero
 128  *  on error (n is NULL).
 129  */
 130 int sn_network_get_comparator_num (const sn_network_t *n);
 131
 132 /**
 133  * Applies a comparator network to an array of integers. This is implemented by
 134  * calling sn_stage_sort() with every stage of the network.
 135  *
 136  * \param n Pointer to the comparator netork.
 137  * \param[in,out] values Pointer to integer values to sort. The number of
 138  *   integer values pointed to must be at least the number of inputs of the
 139  *   comparator network. Otherwise, segmentation faults or memory corruption
 140  *   will occur.
 141  * \return Zero on success, non-zero on failure.
 142  */
 143 int sn_network_sort (sn_network_t *n, int *values);
 144
 145 /**
 146  * Checks whether a given comparator network is a sorting network by testing
 147  * all \f$ 2^n \f$ 0-1-patterns. Since this function has exponential running
 148  * time, using it with comparator networks with many inputs is not advisable.
 149  *
 150  * \param n The comparator network to test.
 151  * \return Zero if the comparator network is a sort network, one if the
 152  *   comparator network is \em not a sort network, or something else on error.
 153  */
 154 int sn_network_brute_force_check (sn_network_t *n);
 155
 156 int sn_network_show (sn_network_t *n);
 157
 158 /**
 159  * Inverts a comparator network by switching the direction of all comparators.
 160  *
 161  * \param n The network to invert.
 162  * \return Zero on success, non-zero on failure.
 163  */
 164 int sn_network_invert (sn_network_t *n);
 165
 166 /**
 167  * Shifts a comparator network (permutes the inputs). Each input is shifted
 168  * \f$ s \f$ positions, higher inputs are "wrapped around".
 169  *
 170  * \param n The comparator network to shift.
 171  * \param s The number of positions to shift.
 172  * \return Zero on success, non-zero on failure.
 173  */
 174 int sn_network_shift (sn_network_t *n, int s);
 175
 176 /**
 177  * Compresses a comparator network by moving all comparators to the earliest
 178  * possible stage and removing all remaining empty stages.
 179  *
 180  * \param n The network to compress.
 181  * \return Zero on success, non-zero on failure.
 182  */
 183 int sn_network_compress (sn_network_t *n);
 184
 185 /**
 186  * Converts a non-standard comparator network to a standard comparator network,
 187  * i.e. a network in which all comparators point in the same direction.
 188  *
 189  * \param n The network to normalize.
 190  * \return Zero on success, non-zero on failure.
 191  */
 192 int sn_network_normalize (sn_network_t *n);
 193
 194 /**
 195  * Removes an inputs from a comparator network by assuming positive or negative
 196  * infinity to be supplied to a given input. The value will take a
 197  * deterministic way through the comparator network. After removing the path
 198  * and all comparators it touched from the comparator network, a new comparator
 199  * network with \f$ n-1 \f$ inputs remains. The remaining outputs behave
 200  * identical to the original network with respect to one another.
 201  *
 202  * \param n The comparator network to modify.
 203  * \param input The input to remove.
 204  * \param dir The direction in which to cut, i.e. whether to assume positive or
 205  *   negative infinity.
 206  * \return Zero on success, non-zero on failure.
 207  */
 208 int sn_network_cut_at (sn_network_t *n, int input, enum sn_network_cut_dir_e dir);
 209 sn_network_t *sn_network_combine (sn_network_t *n0, sn_network_t *n1,
 210     int is_power_of_two);
 211 sn_network_t *sn_network_combine_bitonic (sn_network_t *n0, sn_network_t *n1);
 212
 213 /**
 214  * Combines two comparator networks using a bitonic merger. The number of
 215  * inputs of both comparator networks must be identical and a power of two.
 216  *
 217  * \param n0 First network.
 218  * \param n1 Second network.
 219  * \return Newly allocated network with twice the number of inputs or NULL on
 220  *   error.
 221  */
 222
 223 /**
 224  * Combines two comparator networks using the odd-even-merger.
 225  *
 226  * \param n0 First network.
 227  * \param n1 Second network.
 228  * \return Newly allocated network or NULL on error.
 229  */
 230 sn_network_t *sn_network_combine_odd_even_merge (sn_network_t *n0, sn_network_t *n1);
 231
 232 sn_network_t *sn_network_read (FILE *fh);
 233 sn_network_t *sn_network_read_file (const char *file);
 234 int sn_network_write (sn_network_t *n, FILE *fh);
 235 int sn_network_write_file (sn_network_t *n, const char *file);
 236
 237 int sn_network_serialize (sn_network_t *n, char **ret_buffer,
 238     size_t *ret_buffer_size);
 239 sn_network_t *sn_network_unserialize (char *buffer, size_t buffer_size);
 240 #endif /* SN_NETWORK_H */
 241
 242 /* vim: set shiftwidth=2 softtabstop=2 : */