Sorting_Network

Author: Alessandro Conti - AlessandroConti11

License: MIT license.

Tags: #2D-array, #2D_odd-even_transposition_sort, #3n_sort, #3n_sort_of_Schnorr_and_Shamir, #4-way_mergesort, #adapted_bitonic_sort, #array, #bitonic_sort, #c++, #cpp, #LS3_sort, #odd-even_mergesort, #odd-even_transposition_sort, #OpenMP, #rotatesort, #shearsort, #sorting, #sorting_network.

Specification

In this repository you can find the implementation of some sorting networks.

A Sorting Network is a comparator network that sorts all input sequences. Sorting networks are special cases of general sorting algorithms, since all comparisons are data-independent. This makes sorting network suitable for the implementation in hardware or in parallel processor arrays, sorting on two-dimensional processor arrays.

The implemented sorting networks are:

• odd-even transposition sort
• odd-even mergesort
• bitonic sort
• adapted bitonic sort
• LS3 sort
• 4-way mergesort
• rotatesort
• 3n sort of Schnorr and Shamir
• 2D odd-even transposition sort
• shearsort.

How to run

The steps below refer to a Unix environment, for other environments the commands may change.

0. install gcc

   sudo apt-get install gcc 

1. compile each source file into an object file

   g++ -std=c++20 -Wall -Werror -Wextra -O2 -fopenmp -c FILE.cpp -o FILE.o

2. link all object files into an executable

   g++ -std=c++20 -Wall -Werror -Wextra -O2 -fopenmp\
   main.o \
   odd-even_transposition_sort/odd-even_transposition_sort.o \
   odd-even_mergesort/odd-even_mergesort.o \
   bitonic_sort/bitonic_sort.o \
   adapted_bitonic_sort/adapted_bitonic_sort.o \
   LS3_sort/LS3_sort.o \
   4-way_mergesort/4-way_mergesort.o \
   rotatesort/rotatesort.o \
   3n_sort_Schnorr_and_Shamir/3n_sort_Schnorr_and_Shamir.o \
   2D_odd-even_transposition_sort/2D_odd-even_transposition_sort.o \
   shearsort/shearsort.o \
   -o EXECUTABLE

3. run the executable

   ./EXECUTABLE

The Makefile in the repository can also be used to compile the code.

• this option allows you to compile with the following tags: -std=c++20 -Wall -Werror -Wextra -O2

  make

• if you want to specify different tags, you can set them

  make compile CXXFLAGS=YOUR_FLAGS

• if you want to remove all .o files and the final executable

  make clean

The CMakeLists.txt in the repository can also be used to compile the code.

0. install cmake

   sudo apt-get install cmake

1. create the build folder

   mkdir build && cd build

2. generate compilation files

   cmake ..

3. build the project

   cmake --build .

4. run the executable

   ./sorting_network

Contribute

• If you find a security vulnerability, do NOT open an issue. Email Alessandro Conti instead.
• If you find a bug or error or want to add some other function that is not implemented yet
  1. FORK the repo
  2. CLONE the project to your own machine
  3. COMMIT to your own branch
  4. PUSH your work back up to your fork
  5. submit a PULL REQUEST so that I can review your changes

  NOTE: Be sure to merge the latest from "upstream" before making a pull request!

Code Style

Each new function must be documented using the following style:

• Short function description: A brief description explaining what the function does.
• @warning: A section listing all the assumptions made by the function, such as the preconditions that the parameters must fulfil.
• Blank line: Add a blank line to separate the documentation sections.
• @details: A detailed section describing how the function works, explaining the algorithms and logic used.
• Blank line: Add a blank line to separate the documentation sections.
• @param: A list of the parameters required by the function, each accompanied by a brief description of its role and type.
• @return: A description of what the function returns, including the data type.

In general, any additional comments that might improve understanding of the code are welcome. 😃