Devel

.github/workflows/unit_tests.yml

@@ -0,0 +1,61 @@
+name: Unit Tests
+
+on:
+  push:        # This workflow is triggered by pushing to a git branch specified below
+    branches:
+      - devel  # Project's branch name
+
+jobs:
+  test-on-ubuntu-linux:
+    runs-on: ubuntu-latest  # Runner (execution environment)
+
+    steps:
+    - name: Check Out Repository
+      uses: actions/checkout@v2  # Pre-built GitHub Actions workflow called "actions/checkout" with version 2 (v2)
+
+    - name: Set Up GNU Make
+      run: |
+        sudo apt-get -y install make
+      shell: bash
+
+    - name: Build Project
+      run: |
+        make
+      working-directory: ${{ github.workspace }}/build/GNUMake  # the directory in which the subsequent steps of the workflow will be executed; github.workspace - the root of the repository
+
+    - name: Run Unit Tests
+      run: |
+        make test
+      working-directory: ${{ github.workspace }}/build/GNUMake
+
+  test-on-windows:
+    runs-on: windows-latest  # Runner (execution environment)
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+
+      - name: Set Up CMake
+        run: |
+          choco install cmake --installargs 'ADD_CMAKE_TO_PATH=System'
+        shell: powershell
+
+      - name: Create Build Directory
+        run: |
+          mkdir win
+        working-directory: ${{ github.workspace }}/build/CMake
+
+      - name: Configure CMake
+        run: |
+          cmake -S . -B ./win
+        working-directory: ${{ github.workspace }}/build/CMake
+
+      - name: Build Project
+        run: |
+          cmake --build . --config Debug
+        working-directory: ${{ github.workspace }}/build/CMake/win
+
+      - name: Run Unit Tests
+        run: |
+          ctest -C Debug --output-on-failure
+        working-directory: ${{ github.workspace }}/build/CMake/win

.gitignore

@@ -30,3 +30,18 @@
 *.exe
 *.out
 *.app
+
+# Directories
+bin/
+install/
+
+# Visual Studio cache/options directory
+**/.vs/
+**/x64/
+**/[Dd]ebug/
+**/[Rr]elease/
+
+# CMake
+!build/CMake/
+build/CMake/*
+!/build/CMake/CMakeLists.txt

ReadMe.md

@@ -0,0 +1,92 @@
+# computer-science
+
+This is an educational project containing implementations of some core computer science algorithms.
+
+## Table of Contents
+
+- [About](#about)
+- [Algorithms](#algorithms)
+- [Prerequisites](#prerequisites)
+- [How to build](#how-to-build)
+- [Usage](#usage)
+- [Contributing](#contributing)
+- [License](#license)
+
+## About
+
+The project is written in C++. Its goal is to showcase several things:
+- Clean well-documented C++ code
+- Usage of different build systems (MSBuild, CMake, GNU Make)
+- Unit testing via Catch2 framework
+- Automated testing via GitHub Actions
+
+## Algorithms
+
+The list of implemented algorithms.
+- Simple sorting algorithms ([simple_sorts.h](src/simple_sorts.h))
+  - selection sort
+  - insertion sort
+  - bubble sort
+- Merge sort ([merge_sort.h](src/merge_sort.h))
+- Quick sort ([quick_sort.h](quick_sort.h))
+- [Trial division](https://en.wikipedia.org/wiki/Trial_division) ([prime.h](src/prime.h))
+
+## Prerequisites
+
+On Linux install GNU Make and CMake build systems (example below is given for APT package manager which is used by default in Debian based Linux, e.g. Ubuntu and Linux Mint):
+
+```bash
+sudo apt-get -y install make
+sudo apt-get -y install cmake
+```
+
+On Windows install CMake build system using [Chocolatey](https://chocolatey.org/) package manager:
+```
+choco install cmake --installargs 'ADD_CMAKE_TO_PATH=System'
+```
+...or [download CMake installer for Windows](https://cmake.org/download/)
+
+## How to build
+
+Clone the repository:
+
+```bash
+git clone https://github.com/dvsav/computer-science.git
+cd computer-science
+```
+
+Compile the sources using one of convenience scripts that call either GNU Make:
+
+```bash
+./make.sh test
+```
+If the build is successful, you'll find the binary files in `build/GNUMake/bin` directory.
+
+...or CMake:
+
+```bash
+./cmake.sh
+```
+If the build is successful, you'll find a binary executable `computer-science` in `build/CMake/gnumake` directory.
+
+## Usage
+
+You can include the source code of this project into your own project, e.g. add this git repository as a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules):
+```
+cd your_repository
+git submodule add https://github.com/dvsav/computer-science.git
+```
+
+## Contributing
+
+Contributions are welcome! Please follow these steps:
+
+[Fork the repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo).  
+Create a new branch (`git checkout -b feature/YourFeature`).  
+Commit your changes (`git commit -m 'Add some feature'`).  
+Push to the branch (`git push origin feature/YourFeature`).  
+[Open a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).

build/CMake/CMakeLists.txt

@@ -0,0 +1,107 @@
+cmake_minimum_required(VERSION 3.22 FATAL_ERROR)
+
+option(VERBOSE "Show explanatory messages" ON)
+
+function(print_message msg)
+    if (VERBOSE)
+        message("${msg}")
+    endif()
+endfunction()
+
+print_message("${CMAKE_GENERATOR} generator has been selected")
+# determine whether we are generating a Visual Studio project
+if (${CMAKE_GENERATOR} MATCHES "Visual Studio")
+    print_message("Visual Studio generator detected")
+    set (VISUAL_STUDIO TRUE)
+    set (NOT_VISUAL_STUDIO FALSE)
+else()
+    set (VISUAL_STUDIO FALSE)
+    set (NOT_VISUAL_STUDIO TRUE)
+endif()
+
+print_message("-------------------- COMPUTER SCIENCE --------------------")
+
+# specifies the project name (in MS Visual Studio defines the solution name)
+project(computer-science
+        VERSION 1.0
+        DESCRIPTION "Computer Science (c) 2023-2025 Dmitry Savchenkov"
+        LANGUAGES CXX)
+
+# the repository's root is two folders higher than this CMakeLists file
+set(ROOT_DIR "${PROJECT_SOURCE_DIR}/../..")
+set(SRC_DIR "${ROOT_DIR}/src")
+set(TEST_DIR "${ROOT_DIR}/test")
+
+# collect the source and header files
+file(GLOB SOURCE_FILES CONFIGURE_DEPENDS
+     "${SRC_DIR}/*.cpp"
+     "${SRC_DIR}/*.h")
+
+foreach (file ${SOURCE_FILES})
+    print_message("source file = ${file}")
+endforeach()
+
+# defines the executable file name (target) and its dependencies
+add_executable(${PROJECT_NAME} ${SOURCE_FILES})
+
+if (VISUAL_STUDIO)
+    # set our project as the startup project in the Visual Studio solution
+    set_property(
+        DIRECTORY "${PROJECT_SOURCE_DIR}"
+        PROPERTY VS_STARTUP_PROJECT "${PROJECT_NAME}")
+
+    # set Visual Studio Debug working directory to the repository's root directory
+    set_target_properties(
+        ${PROJECT_NAME} PROPERTIES 
+        VS_DEBUGGER_WORKING_DIRECTORY "${ROOT_DIR}")
+else() # CYGWIN MSYS2 *NIX environment is assumed below
+    # Linking to libstdc++fs is required for use of the Filesystem library extensions in <experimental/filesystem>
+    target_link_libraries(${PROJECT_NAME} PRIVATE "stdc++fs")
+
+    # extract standard libraries' search paths from the compiler
+    execute_process(
+        COMMAND ${CMAKE_CXX_COMPILER} -print-search-dirs
+        COMMAND grep libraries
+        COMMAND cut -d= -f2
+        OUTPUT_STRIP_TRAILING_WHITESPACE
+        OUTPUT_VARIABLE CXX_STD_LIB_PATHS)
+
+    # replace colons ':' with semicolons ';'
+    string(REPLACE ":" ";" CXX_STD_LIB_PATHS "${CXX_STD_LIB_PATHS}")
+    print_message("CXX_STD_LIB_PATHS = ${CXX_STD_LIB_PATHS}")
+
+    # embed library search directories into the executable
+    get_target_property(RPATH ${PROJECT_NAME} BUILD_RPATH)
+    list(APPEND RPATH ${CXX_STD_LIB_PATHS})
+
+    set_target_properties(
+        ${PROJECT_NAME} PROPERTIES 
+        BUILD_RPATH "${RPATH}")
+
+    set_target_properties(
+        ${PROJECT_NAME} PROPERTIES 
+        INSTALL_RPATH "${RPATH}")
+endif()
+
+print_message("-------------------- CTEST --------------------")
+
+# enable testing functionality
+enable_testing()
+
+# define tests
+add_test(
+    NAME ${PROJECT_NAME}
+    COMMAND $<TARGET_FILE:${PROJECT_NAME}>
+	WORKING_DIRECTORY ${TEST_DIR})
+
+print_message("-------------------- INSTALLATION --------------------")
+
+# install the executable file to ${CMAKE_INSTALL_PREFIX}
+install(TARGETS ${PROJECT_NAME}
+        CONFIGURATIONS Release
+        PERMISSIONS OWNER_READ
+                    GROUP_READ
+                    WORLD_READ
+                    OWNER_WRITE
+                    GROUP_WRITE
+                    WORLD_WRITE)