Developers Homepage
Under construction
- A mandatory read for all new developers / contributors: Contributing guidelines, still under construction (but you should read it anyway - and help completing it).
- A document describing the general design of Ginkgo: Library design. If you're not sure how something in Ginkgo works, or why something was done in a certain way, start here. If there's no answer in the document, feel free to ask. Once you've found your answer (either by asking, or by looking at the code in more detail), we encourage you to update the document with what you've found.
- A guide for reviewing pull requests can be found here.
- A guide for creating a new Ginkgo release can be found here.
- If you're interested in how RTTI works, there's an informal description, with links to formal documents here.
- A funny slideshow on how to write good commit messages. Most of the tools are designed around these conventions, so it will make all our lives a bit easier if everyone follows that. If you don't like cats, you can read this instead (but feel free to read both).
- A tutorial about template metaprogramming can be found here.
- A collection of tutorials about "modern" CMake is here. We have to read this and improve our build system.
If you are interested in these topics, you should start by reading Thomas Becker's article on the subject in 11 sections which introduce you to all of these subjects. Sections 4, 5 and 9 are important for efficient use of these concepts (you could make your code very inefficient otherwise).
In Scott Meyers' article you will learn that && does not always mean rvalue-references, notably due to template reference collapsing rules (seen in section 8 of Thomas Becker's article). The same topic is covered in a video if you prefer that format.
A very simple and schematic way to view rvalues is an additional tool to standard references allowing pointer exchange through the reference system. std::move(x) converts its argument to an rvalue, and perfect forwarding (i.e. std::forward<X>(a) is really about returning the proper reference to what a actually is (rvalue or lvalue).
If you are using GDB or an IDE debugger built on top of GDB, Ginkgo provides a pretty-printer for the most commonly used storage structure gko::array to inspect its contents, as long as they are stored in CPU memory.
To load these pretty-printers, execute source <ginkgo-path>/dev_tools/scripts/gdb-ginkgo.py in the GDB shell or put the line into your ~/.gdbinit file to be loaded by default.
Arrays can then be inspected using print variable_name in the current scope.
