phynexis-deps/igl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation and code clean ups (MIQ related) (#971)

Browse Source 
* remove commented code

* typo

* clean up list of the arguments

* typo

* typos and different names

* rename files due to a typo and remove double include

* remove comments that do not document the code but are used to comment out code or to store TODOs that should not be placed in the code, anyway.

* clean up the documentation

* remove commented code

* add information to the doc

* improve readability of the code

* typo and a missing space

* fix a typo: missmatch -> mismatch

* remove unnecessary header files

* typos

* changed to camel notation

* clean up

* typo

* add limitations into the documentation

* camelCase

* lost refactor

* unify the variable's names

* clean up

* clean up

* missed refactor

* clean up

* name in the doc

* name in the doc

* further nameing convention changes

* refactored names missed by clion.

* unify names

* align the constructor's args
This commit is contained in:
Kacper Pluta
2018-10-24 13:30:58 -04:00
committed by Jérémie Dumas
parent f838c51c03
commit 75d60e40a8
20 changed files with 520 additions and 534 deletions
Download Patch File Download Diff File Expand all files Collapse all files
python/py_doc.cpp
+3 -3
View File
@@ -431,7 +431,7 @@ const char *__doc_igl_covariance_scatter_matrix = R"igl_Qu8mg5v7(// Construct th
// CSM dim*#V/#F by dim*#V sparse matrix containing special laplacians along
// the diagonal so that when multiplied by V gives covariance matrix
// elements, can be used to speed up covariance matrix computation)igl_Qu8mg5v7";
const char *__doc_igl_cross_field_missmatch = R"igl_Qu8mg5v7(// Inputs:
const char *__doc_igl_cross_field_mismatch = R"igl_Qu8mg5v7(// Inputs:
// V #V by 3 eigen Matrix of mesh vertex 3D positions
// F #F by 3 eigen Matrix of face (quad) indices
// PD1 #F by 3 eigen Matrix of the first per face cross field vector
@@ -439,7 +439,7 @@ const char *__doc_igl_cross_field_missmatch = R"igl_Qu8mg5v7(// Inputs:
// isCombed boolean, specifying whether the field is combed (i.e. matching has been precomputed.
// If not, the field is combed first.
// Output:
// Handle_MMatch #F by 3 eigen Matrix containing the integer missmatch of the cross field
// Handle_MMatch #F by 3 eigen Matrix containing the integer mismatch of the cross field
// across all face edges
//)igl_Qu8mg5v7";
const char *__doc_igl_cut_mesh_from_singularities = R"igl_Qu8mg5v7(// Given a mesh (V,F) and the integer mismatch of a cross field per edge
@@ -618,7 +618,7 @@ const char *__doc_igl_exact_geodesic = R"igl_Qu8mg5v7(
const char *__doc_igl_find_cross_field_singularities = R"igl_Qu8mg5v7(// Inputs:
// V #V by 3 eigen Matrix of mesh vertex 3D positions
// F #F by 3 eigen Matrix of face (quad) indices
// Handle_MMatch #F by 3 eigen Matrix containing the integer missmatch of the cross field
// Handle_MMatch #F by 3 eigen Matrix containing the integer mismatch of the cross field
// across all face edges
// Output:
// isSingularity #V by 1 boolean eigen Vector indicating the presence of a singularity on a vertex