Resources

Data Structures, Algorithms, Utility Classes

• C++ Resources compile with g++-10 in C++11, C++14, C++17, and C++20 on Ubuntu and Windows
• Java Resources compile in Java 8, Java 11
• Kotlin Resources compile in Kotlin 1.5

Licensing

• most files are covered under LICENSE.txt (Creative Commons Zero 1.0), with certain files being covered under a different license, which are listed below, and stated at the top of those files with the license files also being provided in their folders

Apache License 2.0

• Content/C++/string/SAISSuffixArray.h LICENSE

GNU General Public License 3.0

• Content/C++/graph/other/MaximumClique.h LICENSE

Style Guidelines

• 79 character line limit unless the line contains the string http
• 2 spaces for indentation
• very compressed coding style to reduce wasted space in PDF, with multiple statements on a single line
• if, else, for, while, etc ... statements should either be immediately followed by a single statement and a newline, a block wrapped in curly braces followed by a newline, a curly brace and a newline, or only a newline
• short functions and blocks can be squeezed onto a single line wrapped in curly braces
• all lines should end in \n
• important variables and constants should be completely capitalized, classes and filename should be upper camel case, other variables and functions should be lower camel case, unless it is to match C++ STL conventions
• otherwise mostly adheres to Google's Style Guide
• templates should either be a standalone function, or a struct/class
• functions and classes should have generic types if possible
• classes should have constant parameters passed as template parameters if possible, variable parameters should be passed in the constructor
• classes and functions should have a quick summary, specify conventions used, descriptions of template parameters, constructor arguments, member functions and fields, mention the constant factor (roughly) relative to its advertised time complexity, time complexity and memory complexity, and specify where it was tested
• constant factors (very small, small, moderate, large, very large) roughly differ by factors of 10
• if template parameters are non-trivial, those should be described as well, possibly with an example provided
• std::vector is preferred over fixed-sized arrays and std::string, use std::vector::reserve if possible
• the new operator should be avoided and memory should be allocated on the stack, or std::unique_ptr should be used