Skip to content

Latest commit

 

History

History
148 lines (101 loc) · 4.76 KB

README.md

File metadata and controls

148 lines (101 loc) · 4.76 KB
Raw

AdMU ProgVar Competitive Programming Library

A collection of algorithms, data structures and other useful information for competitive programming. Used and maintained by members of the Ateneo de Manila University Programming Varsity.

front page

This repo is a mixture of our previous team notebook, Reykjavik University's open-source team notebook, and various code snippets from the web.

Goals

Long-term Goals

  • Develop this into a fully-fledged code library for competitive programming. Like Atcoder's AC Library but with more algorithms and data structures.
  • Write wikis, documentation, and tutorials for each of the algorithms and data structures here.
  • Make the team notebook easily customizable; maybe based on analytics on how often a team uses each code snippet.

Short-term Goals

  • Move the codes in pvl/abridged to pvl and add tests for each of them.
  • Clean-up the team notebook.
  • Add tutorials (even just as comments) on how to use each code snippet.
  • Replace the headline image with something more catchy.

How to Contribute

Note: It's best to use Linux or WSL 2, if you're using Windows.

Install requirements

To install all system & Python library requirements, simply run:

./run.sh init

Note: If you get a permission error, try running chmod +x ./run.sh first.

Alternatively, you can install the requirements individually:

  • Latex and extra plugins and fonts
cat $SCRIPT_DIR/requirements.system.txt | xargs sudo apt install;

// or: (requires ~2 Gb of space)
sudo apt install texlive-latex-base
sudo apt install texlive-latex-extra
sudo apt install texlive-fonts-extra

// or simply: (requires ~5 Gb of space)
sudo apt install texlive-full
  • Pygments
pip3 install Pygments
// or
pip install Pygments
  • Cmake, for testing
sudo apt install cmake

Pre-commit

We use Pre-commit to make sure the codes are properly linted.

  • Install Pre-commit using pip3 install pre-commit.
  • Then run pre-commit install to setup the git hook scripts.

Contribution Workflow

  1. Clone this repository using git clone https://github.com/admu-progvar/progvar-library.git
  2. Create a new branch using git checkout -b [add your 2-letter initials here]--[branch code]. For example git checkout -b fc--edit-readme
  3. Install the requirements using ./run.sh init
  4. Add codes to the folder /pvl
  5. Add tests if necessary. See Testing for more info.
  6. Add an abridged version of your codes to /pvl/abridged
  7. Document your codes in notebook.tex
  8. Run ./run.sh build-notebook to generate the notebook
  9. Submit a pull request
  10. Tag someone to review your code
  11. Merge your PR only after receiving at least 1 approval from a reviewer

Tests

We use GoogleTest for writing tests for C++.

Adding tests

  • Add tests in the /tests directory. Say, hello_test.cc.
  • Add the following to /tests/CMakeLists.txt:
add_executable([Name of Test] /path/to/test/hello_test.cc)
target_link_libraries([Name of Test] gtest_main)
gtest_discover_tests([Name of Test])

Running the tests

Simply run:

./run.sh test

(sub)(sub)Section Syntax

  • Red: copy-pasted / non-tested code.
  • Black: either no code yet or we intentionally removed it from the default format of the team notebook.
  • To color a (sub)(sub)section, simple use (sub)(sub)section(COLOR)
    • For example, subsectionBlack gets you a black-colored subsection

Todo

  • Add layout.txt
  • Add more tests
  • Add implementation of:
    • Dominator Tree
    • Fast Matrix Inverse in $F_2$
  • Add benchmarking with Google Benchmark

Maintainers

Lead Maintainer

Contributors