Skip to content
P(R*_{3, 0, 1}) specialized SIMD Geometric Algebra Library
C++ CMake GLSL HTML
Branch: master
Clone or download

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
c_src Enable cxx_std_11 compile feature on C-bindings build Mar 15, 2020
docs Fix documentation bug describing plane to line projections Mar 10, 2020
glsl Ensure GLSL symbols are prefixed to avoid user name collision Mar 2, 2020
perf Add Newton-Raphson refinements to usages of rcp and rsqrt Mar 9, 2020
public/klein Remove auto return type for further cxx11 compatibility Mar 15, 2020
scripts Support additional operations between and on branches Mar 6, 2020
sym Add support for SSE3 (new default) and option to target SSE4.2 Feb 29, 2020
test Add support for CXX11 and CXX14 Mar 15, 2020
theme/partials Add preliminary documentation Feb 16, 2020
.clang-format Add line translation and translator implicit conversion Feb 20, 2020
.gitignore Add plane reflection action call operator Feb 19, 2020
.sonarcloud.properties Add sonarcloud configuration Feb 21, 2020
.travis.yml Add support for CXX11 and CXX14 Mar 15, 2020
CMakeLists.txt Add support for CXX11 and CXX14 Mar 15, 2020
CONTRIBUTING.md Add CONTRIBUTING.MD Feb 27, 2020
Doxyfile Klein 2.0 commit (see commit body for details). Mar 4, 2020
LICENSE Initial commit Jan 28, 2020
README.md Add support for CXX11 and CXX14 Mar 15, 2020
appveyor.yml Add support for CXX11 and CXX14 Mar 15, 2020
mkdocs.yml Klein 2.0 commit (see commit body for details). Mar 4, 2020

README.md

Klein

License: MIT DOI

Build Status Build Status Coverity Status Codacy Badge

👉👉 Project Site 👈👈

Description

Do you need to do any of the following? Quickly? Really quickly even?

  • Projecting points onto lines, lines to planes, points to planes?
  • Measuring distances and angles between points, lines, and planes?
  • Rotate or translate points, lines, and planes?
  • Perform smooth rigid body transforms? Interpolate them smoothly?
  • Construct lines from points? Planes from points? Planes from a line and a point?
  • Intersect planes to form lines? Intersect a planes and lines to form points?

If so, then Klein is the library for you!

Klein is an implementation of P(R*_{3, 0, 1}), aka 3D Projective Geometric Algebra. It is designed for applications that demand high-throughput (animation libraries, kinematic solvers, etc). In contrast to other GA libraries, Klein does not attempt to generalize the metric or dimensionality of the space. In exchange for this loss of generality, Klein implements the algebraic operations using the full weight of SSE (Streaming SIMD Extensions) for maximum throughput.

Requirements

  • Machine with a processor that supports SSE3 or later (Steam hardware survey reports 100% market penetration)
  • C++11/14/17 compliant compiler (tested with GCC 9.2.1, Clang 9.0.1, and Visual Studio 2019)
  • Optional SSE4.1 support

Usage

You have two options to use Klein in your codebase. First, you can simply copy the contents of the public folder somewhere in your include path. Alternatively, you can include this entire project in your source tree, and using cmake, add_subdirectory(Klein) and link the klein::klein interface target.

In your code, there is a single header to include via #include <klein/klein.hpp>, at which point you can create planes, points, lines, ideal lines, bivectors, motors, directions, and use their operations. Please refer to the project site for the most up-to-date documentation.

Motivation

PGA fully streamlines traditionally used quaternions, and dual-quaternions in a single algebra. Normally, the onus is on the user to perform appropriate casts and ensure signs and memory layout are accounted for. Here, all types are unified within the geometric algebra, and operations such as applying quaternion or dual-quaternions (rotor/motor) to planes, points, and lines make sense. There is a surprising amount of uniformity in the algebra, which enables efficient implementation, a simple API, and reduced code size.

Performance Considerations

It is known that a "better" way to vectorize computation in general is to arrange the data in an SoA layout to avoid unnecessary cross-lane arithmetic or unnecessary shuffling. PGA is unique in that a given PGA multivector has a natural decomposition into 4 blocks of 4 floating-point quantities. For the even sub-algebra (isomorphic to the space of dual-quaternions) also known as the motor algebra, the geometric product can be densely packed and implemented efficiently using SSE.

References

Klein is deeply indebted to several members of the GA community and their work. Beyond the works cited here, the author stands of the shoulders of giants (Felix Klein, Sophus Lie, Arthur Cayley, William Rowan Hamilton, Julius Plücker, and William Kingdon Clifford, among others).

[1] Gunn, Charles G. (2019). Course notes Geometric Algebra for Computer Graphics, SIGGRAPH 2019. arXiv link

[2] Steven De Keninck and Charles Gunn. (2019). SIGGRAPH 2019 Geometric Algebra Course. youtube link

[3] Leo Dorst, Daniel Fontijne, Stephen Mann. (2007) Geometric Algebra for Computer Science. Burlington, MA: Morgan Kaufmann Publishers Inc.

You can’t perform that action at this time.