Skip to content

Commit

Permalink
doc: Add LaTeX images to Mat3
Browse files Browse the repository at this point in the history
  • Loading branch information
jhasse committed Oct 26, 2024
1 parent 9e74ccf commit eb1ef12
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:
image: registry.fedoraproject.org/fedora-minimal:40
steps:
- name: Install dependencies
run: microdnf install -y git graphviz doxygen cmake make tar xz rsync
run: microdnf install -y git graphviz doxygen cmake make tar xz rsync texlive-latex texlive-newunicodechar texlive-dvips pdf2svg
- uses: actions/checkout@v4
with:
persist-credentials: false
Expand Down
2 changes: 1 addition & 1 deletion .gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ pages:
dependencies:
- web
script:
- microdnf install -y doxygen cmake make tar xz git >/dev/null
- microdnf install -y doxygen cmake make tar xz git texlive-latex texlive-newunicodechar texlive-dvips pdf2svg >/dev/null
- cd doc
- cmake .
- make
Expand Down
15 changes: 14 additions & 1 deletion src/jngl/Mat3.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,22 @@ class Vec2;
class Mat3 {
public:
/// creates identity matrix
///
/// \f[
/// \left( \begin{array}{rrr}
/// 1 & 0 & 0 \\ 0 & 1 & 0 \\ 0 & 0 & 1
/// \end{array}\right)
/// \f]
Mat3() = default;

/// construct matrix from row-major array with 9 elements
/// construct matrix from **row**-major array with 9 elements
///
/// `jngl::Mat3({ 1, 2, 3, 4, 5, 6, 7, 8, 9 })` is equivalent to:
/// \f[
/// \left( \begin{array}{rrr}
/// 1 & 2 & 3 \\ 4 & 5 & 6 \\ 7 & 8 & 9
/// \end{array}\right)
/// \f]
Mat3(std::initializer_list<float>);

/// Multiplies the matrix with a translation matrix generated from v
Expand Down

0 comments on commit eb1ef12

Please sign in to comment.