Add developer docs for vector and matrix classes and handlers#425
Conversation
shakedregev
left a comment
There was a problem hiding this comment.
This is helpful! There are a few rendering errors. You can look at the source code for documentation we already have to fix those.
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen | ||
|
|
||
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen | ||
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen | ||
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen | ||
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen | ||
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen | ||
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen | ||
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen | ||
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen | ||
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen | ||
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen | ||
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen | ||
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen | ||
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen | ||
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen | ||
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen | ||
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen | ||
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen | ||
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen | ||
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen | ||
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen | ||
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen | ||
|
|
||
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen | ||
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen | ||
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen | ||
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen | ||
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen | ||
|
|
||
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen | ||
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen | ||
|
|
||
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen | ||
|
|
||
| OUTPUT_DIRECTORY=../_readthedocs/html/doxygen |
There was a problem hiding this comment.
this line seems to be repeated
|
Please also update the Changelog |
|
Updated. I removed the repeated Doxyfile lines and added the CHANGELOG entry. I may be missing the same rendering errors locally. Could you point me to where they are showing up specifically for you because I am not seeing them besides one small change? |
| Public Re::Solve documentation describes Re::Solve as an open-source library | ||
| that provides GPU-resident linear solvers. The library contains iterative and | ||
| direct solvers designed to run on NVIDIA GPUs, AMD GPUs, and CPU devices. | ||
| Because of this, Re::Solve code often needs to separate the high-level solver | ||
| logic from the backend-specific details needed to perform matrix and vector | ||
| operations. |
There was a problem hiding this comment.
This seems self referential.
| .. code:: cpp | ||
|
|
||
| vector::Vector* x = new vector::Vector(n); | ||
| x->allocate(memory::HOST); |
There was a problem hiding this comment.
Something isn't rendering here
|
The rendering is correct, see here. Just fix that one small comment I left and we can merge this. |
Description
This PR adds a Developer Guide page for the open-ended documentation/tutorial task.
The page explains how Re::Solve separates vector and matrix data classes from operation handlers, backend workspaces, and memory spaces. It focuses on the difference between data containers, such as
vector::Vectorandmatrix::Csr, and operation handlers, such asVectorHandlerandMatrixHandler.It also uses the SCCG path as a concrete example of how these pieces work together in backend-capable code.
@shakedregev
Proposed changes
docs/sphinx/developer_guide/vector_matrix_handlers.rst.VectorHandlerandMatrixHandleras operation handlers.memory::HOST, andmemory::DEVICE.Checklist
make testandmake test_installper testing instructions). Code tested on./examples/<your_example>.exe -hto get instructions how to run examples). Code tested on:-Wall -Wpedantic -Wconversion -Wextra.Testing
Ran
pre-commit run --all-files.Built the documentation locally with:
Documentation build succeeded with one existing warning from docs/doxygen/index.rst
Further comments
This is a documentation only PR, so backend tests, solver residual checks, compiler warning checks, and unit tests are not applicable.
I added the page to the Developer Guide index so it can be built and previewed with Sphinx. If this page should live somewhere else or be structured differently, please let me know.