Переглянути джерело

typos in comments

Former-commit-id: 34a0b6119df687a26705df4ecfac6ff85bf919ef
Alec Jacobson 8 роки тому
батько
коміт
0eda832958

+ 1 - 1
include/igl/collapse_edge.h

@@ -13,7 +13,7 @@
 #include <set>
 namespace igl
 {
-  // Assumes (V,F) is a closed manifold mesh (except for previouslly collapsed
+  // Assumes (V,F) is a closed manifold mesh (except for previously collapsed
   // faces which should be set to: 
   // [IGL_COLLAPSE_EDGE_NULL IGL_COLLAPSE_EDGE_NULL IGL_COLLAPSE_EDGE_NULL].
   // Collapses exactly two faces and exactly 3 edges from E (e and one side of

+ 10 - 6
include/igl/edge_topology.h

@@ -18,18 +18,22 @@ namespace igl
   // Initialize Edges and their topological relations (assumes an edge-manifold
   // mesh)
   //
-  // Output:
-  // EV  : #Ex2, Stores the edge description as pair of indices to vertices
-  // FE : #Fx3, Stores the Triangle-Edge relation
-  // EF : #Ex2: Stores the Edge-Triangle relation
+  // Inputs:
+  //   V  #V by dim list of mesh vertex positions (unused)
+  //   F  #F by 3 list of triangle indices into V
+  // Outputs:
+  //   EV  #Ex2 matrix storing the edge description as pair of indices to
+  //       vertices
+  //   FE  #Fx3 matrix storing the Triangle-Edge relation
+  //   EF  #Ex2 matrix storing the Edge-Triangle relation
   //
   // TODO: This seems to be a inferior duplicate of edge_flaps.h:
   //   - unused input parameter V
   //   - roughly 2x slower than edge_flaps
   //   - outputs less information: edge_flaps reveals corner opposite edge
   //   - FE uses non-standard and ambiguous order: FE(f,c) is merely an edge
-  //     incident on corner c of face f. In contrast, edge_flaps's EMAP(f,c) reveals
-  //     the edge _opposite_ corner c of face f
+  //     incident on corner c of face f. In contrast, edge_flaps's EMAP(f,c)
+  //     reveals the edge _opposite_ corner c of face f
 template <typename DerivedV, typename DerivedF>
   IGL_INLINE void edge_topology(
     const Eigen::PlainObjectBase<DerivedV>& V,

+ 7 - 10
include/igl/triangle_triangle_adjacency.h

@@ -16,19 +16,16 @@ namespace igl
   // Constructs the triangle-triangle adjacency matrix for a given
   // mesh (V,F).
   //
-  // Templates:
-  //   Scalar derived type of eigen matrix for V (e.g. derived from
-  //     MatrixXd)
-  //   Index  derived type of eigen matrix for F (e.g. derived from
-  //     MatrixXi)
   // Inputs:
   //   F  #F by simplex_size list of mesh faces (must be triangles)
   // Outputs:
-  //   TT   #F by #3 adjacent matrix, the element i,j is the id of the triangle adjacent to the j edge of triangle i
-  //   TTi  #F by #3 adjacent matrix, the element i,j is the id of edge of the triangle TT(i,j) that is adjacent with triangle i
-  // NOTE: the first edge of a triangle is [0,1] the second [1,2] and the third [2,3].
-  //       this convention is DIFFERENT from cotmatrix_entries.h
-  // Known bug: this should not need to take V as input.
+  //   TT   #F by #3 adjacent matrix, the element i,j is the id of the triangle
+  //        adjacent to the j edge of triangle i
+  //   TTi  #F by #3 adjacent matrix, the element i,j is the id of edge of the
+  //        triangle TT(i,j) that is adjacent with triangle i
+  //
+  // NOTE: the first edge of a triangle is [0,1] the second [1,2] and the third
+  //       [2,3].  this convention is DIFFERENT from cotmatrix_entries.h
   template <typename DerivedF, typename DerivedTT, typename DerivedTTi>
   IGL_INLINE void triangle_triangle_adjacency(
     const Eigen::PlainObjectBase<DerivedF>& F,

+ 1 - 1
include/igl/unique_edge_map.h

@@ -12,7 +12,7 @@
 #include <vector>
 namespace igl
 {
-  // Constuct relationships between facet "half"-(or rather "viewed")-edges E
+  // Construct relationships between facet "half"-(or rather "viewed")-edges E
   // to unique edges of the mesh seen as a graph.
   //
   // Inputs:

+ 1 - 1
include/igl/vertex_triangle_adjacency.h

@@ -29,7 +29,7 @@ namespace igl
   //
   // Known bugs: this should not take V as an input parameter.
   // Known bugs/features: if a facet is combinatorially degenerate then faces
-  // will appear multiple times in VF and correpondingly in VFI (j appears
+  // will appear multiple times in VF and correspondingly in VFI (j appears
   // twice in F.row(i) then i will appear twice in VF[j])
   template <typename DerivedF, typename VFType, typename VFiType>
   IGL_INLINE void vertex_triangle_adjacency(