Эх сурвалжийг харах

note about colmajor

Former-commit-id: 8119b4fb9abcdcc1a96aef7190be9b07bbe159f4
Alec Jacobson 10 жил өмнө
parent
commit
b49e327e5b
1 өөрчлөгдсөн 22 нэмэгдсэн , 0 устгасан
  1. 22 0
      README.md

+ 22 - 0
README.md

@@ -121,6 +121,28 @@ BibTeX entry:
 }
 ```
 
+## Known Issues
+We really heavily on Eigen. Nearly all inputs and outputs are Eigen matrices of
+some kind. However, we currently _only_ support Eigen's default column-major
+ordering. That means, we **do not** expect our code to work for matrices using
+the `Eigen::RowMajor` flag. If you can, change definitions like:
+
+```cpp
+Eigen::Matrix<Float, Eigen::Dynamic, 3, Eigen::RowMajor> A;
+```
+
+to
+
+```cpp
+Eigen::Matrix<Float, Eigen::Dynamic, 3, Eigen::ColMajor> A;
+// or simply
+Eigen::Matrix<Float, Eigen::Dynamic, 3> A;
+```
+
+We hope to fix this, or at least identify which functions are safe (many of
+them probably work just fine). This requires setting up unit testing, which is
+a major _todo_ for our development.
+
 ## Contact
 
 Libigl is a group endeavor led by [Alec