fetch upstream March 25, 2022

.github/workflows/run_pre-commit.yml

@@ -0,0 +1,12 @@
+name: pre-commit
+
+on: pull_request
+
+jobs:
+  pre-commit:
+    name: Run pre-commit on all files
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+    - uses: pre-commit/[email protected]

.github/workflows/run_pvl_tests.yml

@@ -0,0 +1,15 @@
+name: pvl-tests
+
+on: pull_request
+
+jobs:
+  pre-commit:
+    name: Run PVL tests
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+    - name: Get latest CMake
+      uses: lukka/get-cmake@latest
+    - name: Run tests
+      run: ./run.sh test

.gitignore

@@ -45,4 +45,7 @@
 /notebook/_docs
 /notebook/_tex
 
-/tests/build/
+/tests/build/
+
+.vscode/
+build/

.pre-commit-config.yaml

@@ -12,9 +12,24 @@ repos:
     rev: 9a5aa38207bf557961110d6a4f7e3a9d352911f9
     hooks:
       - id: cpplint
+        name: cpplint - pvl
+        files: pvl
         args: [
           "--exclude=pvl/abridged",
           "--filter=-legal/copyright,-readability/alt_tokens,-whitespace/parens,-build/include_what_you_use,-runtime/int",
           "--linelength=62"
         ]
-files: 'pvl'
+      - id: cpplint
+        name: cpplint - tests
+        files: tests
+        args: [
+          "--exclude=tests/build",
+          "--filter=-legal/copyright,-readability/alt_tokens,-whitespace/parens,-build/include_what_you_use,-runtime/int,-build/include_order,-runtime/threadsafe_fn",
+          "--linelength=80"
+        ]
+  - repo: https://github.com/psf/black
+    rev: 22.3.0
+    hooks:
+      - id: black
+        language_version: python3
+        args: ["--exclude=docs|tests\/build|pvl\/abridged"]

README.md

@@ -1,4 +1,5 @@
 # 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.
 
@@ -10,12 +11,14 @@ This repo is a mixture of our previous team notebook, [Reykjavik University's op
 
 ## Goals
 
-### Long-term Goals:
+### Long-term Goals
+
 - Develop this into a fully-fledged code library for competitive programming. Like [Atcoder's AC Library](https://github.com/atcoder/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.
@@ -25,82 +28,101 @@ This repo is a mixture of our previous team notebook, [Reykjavik University's op
 
 ## How to Contribute
 
-### Prerequisites
-- Latex and extra plugins and fonts
+> **Note:** It's best to use Linux or [WSL 2](https://docs.microsoft.com/en-us/windows/wsl), if you're using Windows.
+
+### Install requirements
+
+To install all system & Python library requirements, simply run:
+
+```shell
+./run.sh init
 ```
-// Warning: this could take up around 2 Gb of space
+
+> 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
+
+```shell
+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,
-
-// Warning: this could take up around 5 Gb of space
+// or simply: (requires ~5 Gb of space)
 sudo apt install texlive-full
 ```
+
 - Pygments
-```
+
+```shell
 pip3 install Pygments
 // or
 pip install Pygments
 ```
+
 - Cmake, for testing
-```
+
+```shell
 sudo apt install cmake
 ```
 
 #### Pre-commit
+
 We use [Pre-commit](https://pre-commit.com/) 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:
+### 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. Add codes to the folder `/pvl`
-4. Add tests if necessary. See the section below for more details.
-5. Add an abridged version of your codes to `/pvl/abridged`
-6. Document your codes in `notebook.tex`
-7. Run `notebook/makefile.sh` to generate the notebook
-8. Submit a pull request
-9. Tag someone to review your code
-10. Merge your PR only after receiving at least 1 approval from a reviewer
+3. Install the requirements using `./run.sh init`
+4. Add codes to the folder `/pvl`
+5. Add tests if necessary. See [Testing](#tests) 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](https://github.com/google/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`:
-```
+
+```shell
 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])
 ```
-#### Testing
-- First, go to `/tests/`
-```
-cd tests
-```
-- Then build the tests
-```
-cmake -S . -B build && cmake --build build
-```
-- Go to `build/`
-```
-cd build
-```
-- And finally, run the tests
-```
-ctest
+
+#### Running the tests
+
+Simply run:
+
+```shell
+./run.sh test
 ```
 
-### (sub)(sub)Section Syntax:
+### (sub)(sub)Section Syntax
+
 - <span style="color:red">Red</span>: copy-pasted / non-tested code.
 - <span style="color:black">Black</span>: 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:
@@ -109,10 +131,18 @@ ctest
 - Add benchmarking with [Google Benchmark](https://github.com/google/benchmark)
 
 ## Maintainers
+
 ### Lead Maintainer
+
 - [Franz Louis Cesista](https://github.com/leloykun)
-  - World Finalist on the [International Collegiate Programming Contest](https://icpc.global/)
-  - Software Engineer @ [Expedock](https://www.expedock.com/)
+  - 2x World Finalist on the [International Collegiate Programming Contest](https://icpc.global/)
+  - 2x Wolrd Finalist on the [International Olympiad in Informatics](https://ioinformatics.org/)
+  - Machine Learning Research Engineer @ [Expedock](https://www.expedock.com/)
   - BS Mathematics @ Ateneo de Manila
+
 ### Contributors
+
 - Ateneo's Programming Varsity Alumni
+- [Justin M. Tan](https://github.com/bullybutcher)
+- [Raphael Jose A. Montemayor](https://github.com/rap2montemayor)
+- [Mark Kevin A. Ong Yiu](https://github.com/ongyiumark)

notebook/build_notebook.sh

@@ -0,0 +1,22 @@
+while getopts n: flag
+do
+    case "${flag}" in
+        n) teamname=${OPTARG};;
+    esac
+done
+
+rm -rf *.{aux,log,toc,fls,fdb_latexmk} _code/ _docs/
+python3 preprocess.py
+# python3 build_tex.py
+
+echo "Building truncated notebook for team $teamname..."
+pdflatex -shell-escape -jobname="notebook-trunc" "\def\ICPCCONFIG{1} \def\TEAMNAME{$teamname} \input{notebook.tex}"
+pdflatex -shell-escape -jobname="notebook-trunc" "\def\ICPCCONFIG{1} \def\TEAMNAME{$teamname} \input{notebook.tex}"
+echo "Finished building truncated notebook for team $teamname."
+
+echo "Building full notebook for team $teamname..."
+pdflatex -shell-escape "\def\ICPCCONFIG{1} \def\TEAMNAME{$teamname} \input{notebook.tex}"
+pdflatex -shell-escape "\def\ICPCCONFIG{1} \def\TEAMNAME{$teamname} \input{notebook.tex}"
+echo "Finished building full notebook for team $teamname."
+
+rm -rf *.{aux,log,toc,fls,fdb_latexmk} _minted-notebook*

notebook/build_tex.py

@@ -1,46 +1,71 @@
 import os
 
-for path, dirs, files in os.walk('./structure'):
-  for f in files:
-    if not f.endswith('.md'): continue
-
-    p = os.path.join(path, f)
-    fout_tex = os.path.join("tex", '.'.join(f.split('.')[:-1]) + '.tex')
-    print(fout_tex)
-
-    try:
-      os.makedirs(os.path.dirname(fout_tex))
-      print("Created file", fout_tex)
-    except:
-      print("Couldn't create file", fout_tex)
-      pass
-
-    dat = [line for line in open(p).read().splitlines()]
-
-    with open(fout_tex, 'w') as out:
-      print("\\section{{{}}}".format(dat[0]), file=out)
-      for line in dat[1:]:
-        num_spaces = len(line) - len(line.lstrip()) + 2
-        subs = num_spaces//2
-        line = line.lstrip()[2:]
-        blocks = line.split('|')
-
-        if "comment" in blocks: continue
-
-        if (line.endswith(".cpp") or line.endswith('.java') or
-            line.endswith('.sh') or line.endswith('.py')):
-
-          fdocs = os.path.join("_docs", f[:-3], '.'.join(blocks[-1].split('.')[:-1]) + '.md')
-          with open(fdocs, 'r') as fdocs_:
-            for doc_line in fdocs_.readlines():
-              if len(doc_line.strip()) == 0: continue
-              print(" "*num_spaces + doc_line, end="", file=out)
-
-          print(" "*num_spaces + "\\code{{{}/{}}}".format(f[:-3], blocks[-1]), file=out)
-        else:
-          if "black" in blocks:
-            print(" "*num_spaces + "\\" + "sub" * subs + "sectionBlack{{{}}}".format(blocks[-1]), file=out)
-          elif "red" in blocks:
-            print(" "*num_spaces + "\\" + "sub" * subs + "sectionRed{{{}}}".format(blocks[-1]), file=out)
-          else:
-            print(" "*num_spaces + "\\" + "sub" * subs + "section{{{}}}".format(blocks[-1]), file=out)
+for path, dirs, files in os.walk("./structure"):
+    for f in files:
+        if not f.endswith(".md"):
+            continue
+
+        p = os.path.join(path, f)
+        fout_tex = os.path.join("tex", ".".join(f.split(".")[:-1]) + ".tex")
+        print(fout_tex)
+
+        os.makedirs(os.path.dirname(fout_tex), exist_ok=True)
+
+        dat = [line for line in open(p).read().splitlines()]
+
+        with open(fout_tex, "w") as out:
+            print("\\section{{{}}}".format(dat[0]), file=out)
+            for line in dat[1:]:
+                num_spaces = len(line) - len(line.lstrip()) + 2
+                subs = num_spaces // 2
+                line = line.lstrip()[2:]
+                blocks = line.split("|")
+
+                if "comment" in blocks:
+                    continue
+
+                if (
+                    line.endswith(".cpp")
+                    or line.endswith(".java")
+                    or line.endswith(".sh")
+                    or line.endswith(".py")
+                ):
+
+                    fdocs = os.path.join(
+                        "_docs", f[:-3], ".".join(blocks[-1].split(".")[:-1]) + ".md"
+                    )
+                    with open(fdocs, "r") as fdocs_:
+                        for doc_line in fdocs_.readlines():
+                            if len(doc_line.strip()) == 0:
+                                continue
+                            print(" " * num_spaces + doc_line, end="", file=out)
+
+                    print(
+                        " " * num_spaces + "\\code{{{}/{}}}".format(f[:-3], blocks[-1]),
+                        file=out,
+                    )
+                else:
+                    if "black" in blocks:
+                        print(
+                            " " * num_spaces
+                            + "\\"
+                            + "sub" * subs
+                            + "sectionBlack{{{}}}".format(blocks[-1]),
+                            file=out,
+                        )
+                    elif "red" in blocks:
+                        print(
+                            " " * num_spaces
+                            + "\\"
+                            + "sub" * subs
+                            + "sectionRed{{{}}}".format(blocks[-1]),
+                            file=out,
+                        )
+                    else:
+                        print(
+                            " " * num_spaces
+                            + "\\"
+                            + "sub" * subs
+                            + "section{{{}}}".format(blocks[-1]),
+                            file=out,
+                        )