Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/manid2/dsa

Data structures and algorithms code.
https://github.com/manid2/dsa

algorithms data-structures interview leetcode leetcode-solutions

Last synced: 2 months ago
JSON representation

Data structures and algorithms code.

Awesome Lists containing this project

README 

        
Data structures and algorithms (DSA)

====================================



The purpose of this repository is to help me prepare for online assessments,

programming competitions and software engineering interviews along with the

benefit of practicing in the programming language I currently (year 2024) work

in i.e. C++.



I had used C and Python 3 for previous practice sessions so that code is

retained but no new code is pushed due to me using C++ full time so I gain

expertise in that.



For these practice programs I have borrowed working code from various online

sources and relevant credits are given in code comments.  So I hope anyone who

finds this repository may use it for their own learning of data structures and

algorithms. After learning from working solutions in this repository you may

practice solving problems on coding contest platforms with time limit.



Use the code and documentation in this repository freely and share it with the

others.



Coding guidelines

-----------------



* Focus on C++ code and for online assessments, coding competition especially

  for platforms such as HackerRank, LeetCode.

* Fully working single source files with no external dependencies as required

  for coding competitions.

* Every C++ source file must build & run as a single file target the focus is

  on solving the problem correctly.

* Each C++ compiled binary must output test result as a single line in this

  format `Executed M implementations with N tests.`.  This makes it easy to

  get tests summary.

* For debugging each binary must print test name, test case number with input

  and output in this format and only when enabled with environment variable

  `SHOW_TEST_OUTPUT`:



  ```text

  Testing implementation M 

    test-0:  input: ,   output: 

    ...

    test-N:  input: ,   output: 

  Executed M implementations with N tests.

  ```



* Must use latest C++ version (as of now C++20) to be updated with the latest

  additions, improvements to C++ and STL library.



Build & test

------------



This repository requires Gnu g++ compiler minimum version 13 to support C++20

features such as `std::format()` used in code.



This repository uses Gnu Makefile to run build and test tasks along with some

helper tasks such as to run formatter, linter for source code.



Build is tested and tests are verified on Gnu/Linux & Cygwin (Windows)

operating systems.



### Examples



```bash

make venv # setup python virtual environment

make docs # generate sphinx docs



make cpp/arrays/2sum-01        # build a test binary from .cpp source file

make cpp/arrays/2sum-01-check  # run the test binary

make cpp/arrays/2sum-01-format # format .cpp source file



SHOW_TEST_OUTPUT=1 make cpp/arrays/2sum-01-check # run test with debug output

```



Test framework

--------------



This repository uses a single header file test "framework" to write test cases

to verify the correctness of the algorithms and various implementations.  It

is designed to execute test cases by providing definition to `TEST()` macros

with unique and name description to that test.  This step registers the test

with the tests registry.



To check the test conditions with expected and actual values it provides

`CHECK_EQ()` macro.  It checks a given condition and increments test case

count on success and reports error and exits on failure.  To convert the

expected & actual data into printable strings helper functions such as

`to_string()` have to be provided.  Use `SUCCESS()` & `FAIL()` macros to

create custom checks not provided by the framework.



The test output can be printed with `SHOW_OUTPUT()` macro to verify the inputs

passed to an algorithm and the output received from it.  The output can be

manipulated by providing the list of IO manipulators to `SET_IO()` and reset

with `RESET_IO()`. Custom test can be provided using `SET_CUSTOM_FAIL_MSG()`

or by providing `to_string()` overloads.



The test code is initialized with `INIT_TEST_MAIN()` macro that provides

`main()` function definition which includes `RUN_ALL_TESTS()` macro function

to run all the registered tests.



This framework removes the need to write test output and test logic code

across the implementations significantly reducing the number of source lines

in a single file and  improves readability.