Added libigl-style function description.

Former-commit-id: 807b0e55f5fe13bbfe501076912deed94980aaf0

include/igl/shapeup_local_projections.h

@@ -15,19 +15,28 @@
 #include <vector>
 
 
-//This file implements several basic lcaol projection functions for the shapeup algorithm in shapeup.h
+
 
 namespace igl
 {
+
+	//Every function here defines a local projection for ShapeUp, and must have the following structure to qualify:
+	//Input:
+	//	P		#P by 3				the set of points, either the initial solution, or from previous iteration.
+	//  SC		#Set by 1           cardinalities of sets in S
+	//  S		#Sets by max(SC)    independent sets where the local projection applies. Values beyond column SC(i)-1 in row S(i,:) are "don't care"
+	//Output:
+	//	projP	#S by 3*max(SC) in format xyzxyzxyz,  where the projected points correspond to each set in S in the same order.
+	typedef std::function<bool(const Eigen::PlainObjectBase<Eigen::MatrixXd>&, const Eigen::PlainObjectBase<Eigen::VectorXi>&, const Eigen::PlainObjectBase<Eigen::MatrixXi>&, Eigen::PlainObjectBase<Eigen::MatrixXd>&)> shapeup_projection_function;
+
   
   //This projection does nothing but render points into projP. Mostly used for "echoing" the global step
   IGL_INLINE bool shapeup_identity_projection(const Eigen::PlainObjectBase<Eigen::MatrixXd>& P, const Eigen::PlainObjectBase<Eigen::VectorXi>& SC, const Eigen::PlainObjectBase<Eigen::MatrixXi>& S,  Eigen::PlainObjectBase<Eigen::MatrixXd>& projP);
   
-  //the projection assumes that the sets are vertices of polygons in order
+  //the projection assumes that the sets are vertices of polygons in cyclic order
   IGL_INLINE bool shapeup_regular_face_projection(const Eigen::PlainObjectBase<Eigen::MatrixXd>& P, const Eigen::PlainObjectBase<Eigen::VectorXi>& SC, const Eigen::PlainObjectBase<Eigen::MatrixXi>& S,  Eigen::PlainObjectBase<Eigen::MatrixXd>& projP);
   
-  typedef std::function<bool(const Eigen::PlainObjectBase<Eigen::MatrixXd>&, const Eigen::PlainObjectBase<Eigen::VectorXi>&, const Eigen::PlainObjectBase<Eigen::MatrixXi>&, Eigen::PlainObjectBase<Eigen::MatrixXd>&)> shapeup_projection_function;
-  
+ 
 }
 
 #ifndef IGL_STATIC_LIBRARY