tejaswingm/Terathon-Math-Library

C++ math library for 2D/3D/4D vector, matrix, quaternion, and geometric algebra.

Terathon Math Library

This is a C++ math library containing classes for vectors, matrices, quaternions, and elements of projective geometric algebra. The specific classes are the following:

• Vector2D – A 2D vector (x, y) that extends to four dimensions as (x, y, 0, 0).
• Vector3D – A 3D vector (x, y, z) that extends to four dimensions as (x, y, z, 0).
• Vector4D – A 4D vector (x, y, z, w).
• Point2D – A 2D point (x, y) that extends to four dimensions as (x, y, 0, 1).
• Point3D – A 3D point (x, y, z) that extends to four dimensions as (x, y, z, 1).
• Matrix2D – A 2×2 matrix.
• Matrix3D – A 3×3 matrix.
• Matrix4D – A 4×4 matrix.
• Transform4D – A 4×4 matrix with fourth row always (0, 0, 0, 1).
• Quaternion – A convention quaternion xi + yj + zk + w.
• Bivector3D – A 3D bivector x e₂₃ + y e₃₁ + z e₁₂.
• Bivector4D – A 4D bivector (line) v_x e₄₁ + v_y e₄₂ + v_z e₄₃ + m_x e₂₃ + m_y e₃₁ + m_z e₁₂.
• Trivector4D – A 4D trivector (plane) x e₂₃₄ + y e₃₁₄ + z e₁₂₄ + w e₃₂₁.
• Motor – A 4D motion operator r_x e₄₁ + r_y e₄₂ + r_z e₄₃ + r_w 𝟙 + u_x e₂₃ + u_y e₃₁ + u_z e₁₂ + u_w.

Component Swizzling

Vector components can be swizzled using shading-language syntax as long as there are no repeated components. As an example, the following expressions are all valid for a Vector3D object v:

• v.x – The x component of v.
• v.xy – A 2D vector having the x and y components of v.
• v.yzx – A 3D vector having the components of v in the order (y, z, x).

Rows, columns, and submatrices can be extracted from matrix objects using a similar syntax. As an example, the following expressions are all valid for a Matrix3D object m:

• m.m12 – The (1,2) entry of m.
• m.row0 – The first row of m.
• m.col1 – The second column of m.
• m.matrix2D – The upper-left 2×2 submatrix of m.
• m.transpose – The transpose of m.

All of the above are generally free operations, with no copying, when their results are consumed by an expression. For more information, see Eric Lengyel's 2018 GDC talk Linear Algebra Upgraded.

Geometric Algebra

The ^ operator is overloaded for cases in which the wedge or antiwedge product can be applied between vectors, bivectors, points, lines, and planes. (Note that ^ has lower precedence than just about everything else, so parentheses will be necessary.)

The library does not provide operators that directly calculate the geometric product and antiproduct because they would tend to generate inefficient code and produce intermediate results having useless types when something like the sandwich product Q ⟇ p ⟇ ~Q appears in an expression. Instead, there are Transform() functions that take some object p for the first parameter and the motor Q with which to transform it for the second parameter.

See Eric Lengyel's Projective Geometric Algebra website for more information about operations among these types.

API Documentation

There is API documentation embedded in the header files. The formatted equivalent can be found in the C4 Engine documentation.