Browse Source

comments on vector output

Former-commit-id: aec0c505748a3ac0d7a9d16c14dc69d3e95e6502
Alec Jacobson 8 years ago
parent
commit
4f644e3eac
1 changed files with 10 additions and 3 deletions
  1. 10 3
      include/igl/matrix_to_list.h

+ 10 - 3
include/igl/matrix_to_list.h

@@ -14,22 +14,29 @@
 namespace igl
 {
   // Convert a matrix to a list (std::vector) of row vectors of the same size
+  //
   // Template: 
   //   Mat  Matrix type, must implement:
   //     .resize(m,n)
   //     .row(i) = Row
   //   T  type that can be safely cast to type in Mat via '='
   // Inputs:
-  //   V  a m-long list of vectors of size n
-  // Outputs:
   //   M  an m by n matrix
+  // Outputs:
+  //   V  a m-long list of vectors of size n
   //
   // See also: list_to_matrix
   template <typename DerivedM>
   IGL_INLINE void matrix_to_list(
     const Eigen::MatrixBase<DerivedM> & M, 
     std::vector<std::vector<typename DerivedM::Scalar > > & V);
-  // For vector input
+  // Convert a matrix to a list (std::vector) of elements in column-major
+  // ordering.
+  //
+  // Inputs:
+  //    M  an m by n matrix
+  // Outputs:
+  //    V  an m*n list of elements
   template <typename DerivedM>
   IGL_INLINE void matrix_to_list(
     const Eigen::MatrixBase<DerivedM> & M,