py_doc.cpp 43 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931
  1. const char *__doc_igl_principal_curvature = R"igl_Qu8mg5v7(// Compute the principal curvature directions and magnitude of the given triangle mesh
  2. // DerivedV derived from vertex positions matrix type: i.e. MatrixXd
  3. // DerivedF derived from face indices matrix type: i.e. MatrixXi
  4. // Inputs:
  5. // V eigen matrix #V by 3
  6. // F #F by 3 list of mesh faces (must be triangles)
  7. // radius controls the size of the neighbourhood used, 1 = average edge lenght
  8. //
  9. // Outputs:
  10. // PD1 #V by 3 maximal curvature direction for each vertex.
  11. // PD2 #V by 3 minimal curvature direction for each vertex.
  12. // PV1 #V by 1 maximal curvature value for each vertex.
  13. // PV2 #V by 1 minimal curvature value for each vertex.
  14. //
  15. // See also: average_onto_faces, average_onto_vertices
  16. //
  17. // This function has been developed by: Nikolas De Giorgis, Luigi Rocca and Enrico Puppo.
  18. // The algorithm is based on:
  19. // Efficient Multi-scale Curvature and Crease Estimation
  20. // Daniele Panozzo, Enrico Puppo, Luigi Rocca
  21. // GraVisMa, 2010)igl_Qu8mg5v7";
  22. const char *__doc_igl_local_basis = R"igl_Qu8mg5v7(// Compute a local orthogonal reference system for each triangle in the given mesh
  23. // Templates:
  24. // DerivedV derived from vertex positions matrix type: i.e. MatrixXd
  25. // DerivedF derived from face indices matrix type: i.e. MatrixXi
  26. // Inputs:
  27. // V eigen matrix #V by 3
  28. // F #F by 3 list of mesh faces (must be triangles)
  29. // Outputs:
  30. // B1 eigen matrix #F by 3, each vector is tangent to the triangle
  31. // B2 eigen matrix #F by 3, each vector is tangent to the triangle and perpendicular to B1
  32. // B3 eigen matrix #F by 3, normal of the triangle
  33. //
  34. // See also: adjacency_matrix)igl_Qu8mg5v7";
  35. const char *__doc_igl_signed_distance = R"igl_Qu8mg5v7(// Computes signed distance to a mesh
  36. //
  37. // Inputs:
  38. // P #P by 3 list of query point positions
  39. // V #V by 3 list of vertex positions
  40. // F #F by ss list of triangle indices, ss should be 3 unless sign_type ==
  41. // SIGNED_DISTANCE_TYPE_UNSIGNED
  42. // sign_type method for computing distance _sign_ S
  43. // Outputs:
  44. // S #P list of smallest signed distances
  45. // I #P list of facet indices corresponding to smallest distances
  46. // C #P by 3 list of closest points
  47. // N #P by 3 list of closest normals (only set if
  48. // sign_type=SIGNED_DISTANCE_TYPE_PSEUDONORMAL)
  49. //
  50. // Known bugs: This only computes distances to triangles. So unreferenced
  51. // vertices and degenerate triangles are ignored.)igl_Qu8mg5v7";
  52. const char *__doc_igl_signed_distance_pseudonormal = R"igl_Qu8mg5v7(// Computes signed distance to mesh
  53. //
  54. // Inputs:
  55. // tree AABB acceleration tree (see AABB.h)
  56. // F #F by 3 list of triangle indices
  57. // FN #F by 3 list of triangle normals
  58. // VN #V by 3 list of vertex normals (ANGLE WEIGHTING)
  59. // EN #E by 3 list of edge normals (UNIFORM WEIGHTING)
  60. // EMAP #F*3 mapping edges in F to E
  61. // q Query point
  62. // Returns signed distance to mesh
  63. //)igl_Qu8mg5v7";
  64. const char *__doc_igl_signed_distance_winding_number = R"igl_Qu8mg5v7(// Inputs:
  65. // tree AABB acceleration tree (see cgal/point_mesh_squared_distance.h)
  66. // hier Winding number evaluation hierarchy
  67. // q Query point
  68. // Returns signed distance to mesh)igl_Qu8mg5v7";
  69. const char *__doc_igl_triangle_triangulate = R"igl_Qu8mg5v7(// Triangulate the interior of a polygon using the triangle library.
  70. //
  71. // Inputs:
  72. // V #V by 2 list of 2D vertex positions
  73. // E #E by 2 list of vertex ids forming unoriented edges of the boundary of the polygon
  74. // H #H by 2 coordinates of points contained inside holes of the polygon
  75. // flags string of options pass to triangle (see triangle documentation)
  76. // Outputs:
  77. // V2 #V2 by 2 coordinates of the vertives of the generated triangulation
  78. // F2 #F2 by 3 list of indices forming the faces of the generated triangulation
  79. //
  80. // TODO: expose the option to prevent Steiner points on the boundary
  81. //)igl_Qu8mg5v7";
  82. const char *__doc_igl_embree_ambient_occlusion = R"igl_Qu8mg5v7(// Compute ambient occlusion per given point
  83. //
  84. // Inputs:
  85. // ei EmbreeIntersector containing (V,F)
  86. // P #P by 3 list of origin points
  87. // N #P by 3 list of origin normals
  88. // Outputs:
  89. // S #P list of ambient occlusion values between 1 (fully occluded) and
  90. // 0 (not occluded)
  91. //)igl_Qu8mg5v7";
  92. const char *__doc_igl_cotmatrix = R"igl_Qu8mg5v7(// Constructs the cotangent stiffness matrix (discrete laplacian) for a given
  93. // mesh (V,F).
  94. //
  95. // Templates:
  96. // DerivedV derived type of eigen matrix for V (e.g. derived from
  97. // MatrixXd)
  98. // DerivedF derived type of eigen matrix for F (e.g. derived from
  99. // MatrixXi)
  100. // Scalar scalar type for eigen sparse matrix (e.g. double)
  101. // Inputs:
  102. // V #V by dim list of mesh vertex positions
  103. // F #F by simplex_size list of mesh faces (must be triangles)
  104. // Outputs:
  105. // L #V by #V cotangent matrix, each row i corresponding to V(i,:)
  106. //
  107. // See also: adjacency_matrix
  108. //
  109. // Note: This Laplacian uses the convention that diagonal entries are
  110. // **minus** the sum of off-diagonal entries. The diagonal entries are
  111. // therefore in general negative and the matrix is **negative** semi-definite
  112. // (immediately, -L is **positive** semi-definite)
  113. //
  114. // Known bugs: off by 1e-16 on regular grid. I think its a problem of
  115. // arithmetic order in cotmatrix_entries.h: C(i,e) = (arithmetic)/dblA/4)igl_Qu8mg5v7";
  116. const char *__doc_igl_floor = R"igl_Qu8mg5v7(// Floor a given matrix to nearest integers
  117. //
  118. // Inputs:
  119. // X m by n matrix of scalars
  120. // Outputs:
  121. // Y m by n matrix of floored integers)igl_Qu8mg5v7";
  122. const char *__doc_igl_slice = R"igl_Qu8mg5v7(// Act like the matlab X(row_indices,col_indices) operator, where
  123. // row_indices, col_indices are non-negative integer indices.
  124. //
  125. // Inputs:
  126. // X m by n matrix
  127. // R list of row indices
  128. // C list of column indices
  129. // Output:
  130. // Y #R by #C matrix
  131. //
  132. // See also: slice_mask)igl_Qu8mg5v7";
  133. const char *__doc_igl_per_face_normals = R"igl_Qu8mg5v7(// Compute face normals via vertex position list, face list
  134. // Inputs:
  135. // V #V by 3 eigen Matrix of mesh vertex 3D positions
  136. // F #F by 3 eigen Matrix of face (triangle) indices
  137. // Z 3 vector normal given to faces with degenerate normal.
  138. // Output:
  139. // N #F by 3 eigen Matrix of mesh face (triangle) 3D normals
  140. //
  141. // Example:
  142. // // Give degenerate faces (1/3,1/3,1/3)^0.5
  143. // per_face_normals(V,F,Vector3d(1,1,1).normalized(),N);)igl_Qu8mg5v7";
  144. const char *__doc_igl_per_face_normals_stable = R"igl_Qu8mg5v7(// Special version where order of face indices is guaranteed not to effect
  145. // output.)igl_Qu8mg5v7";
  146. const char *__doc_igl_quad_planarity = R"igl_Qu8mg5v7(// Compute planarity of the faces of a quad mesh
  147. // Inputs:
  148. // V #V by 3 eigen Matrix of mesh vertex 3D positions
  149. // F #F by 4 eigen Matrix of face (quad) indices
  150. // Output:
  151. // P #F by 1 eigen Matrix of mesh face (quad) planarities
  152. //)igl_Qu8mg5v7";
  153. const char *__doc_igl_readOFF = R"igl_Qu8mg5v7(// Read a mesh from an ascii obj file, filling in vertex positions, normals
  154. // and texture coordinates. Mesh may have faces of any number of degree
  155. //
  156. // Templates:
  157. // Scalar type for positions and vectors (will be read as double and cast
  158. // to Scalar)
  159. // Index type for indices (will be read as int and cast to Index)
  160. // Inputs:
  161. // str path to .obj file
  162. // Outputs:
  163. // V double matrix of vertex positions #V by 3
  164. // F #F list of face indices into vertex positions
  165. // TC double matrix of texture coordinats #TC by 2
  166. // FTC #F list of face indices into vertex texture coordinates
  167. // N double matrix of corner normals #N by 3
  168. // FN #F list of face indices into vertex normals
  169. // Returns true on success, false on errors)igl_Qu8mg5v7";
  170. const char *__doc_igl_per_vertex_normals = R"igl_Qu8mg5v7(// Compute vertex normals via vertex position list, face list
  171. // Inputs:
  172. // V #V by 3 eigen Matrix of mesh vertex 3D positions
  173. // F #F by 3 eigne Matrix of face (triangle) indices
  174. // weighting Weighting type
  175. // Output:
  176. // N #V by 3 eigen Matrix of mesh vertex 3D normals)igl_Qu8mg5v7";
  177. const char *__doc_igl_sortrows = R"igl_Qu8mg5v7(// Act like matlab's [Y,I] = sortrows(X)
  178. //
  179. // Templates:
  180. // DerivedX derived scalar type, e.g. MatrixXi or MatrixXd
  181. // DerivedI derived integer type, e.g. MatrixXi
  182. // Inputs:
  183. // X m by n matrix whose entries are to be sorted
  184. // ascending sort ascending (true, matlab default) or descending (false)
  185. // Outputs:
  186. // Y m by n matrix whose entries are sorted (**should not** be same
  187. // reference as X)
  188. // I m list of indices so that
  189. // Y = X(I,:);)igl_Qu8mg5v7";
  190. const char *__doc_igl_barycenter = R"igl_Qu8mg5v7(// Computes the barycenter of every simplex
  191. //
  192. // Inputs:
  193. // V #V x dim matrix of vertex coordinates
  194. // F #F x simplex_size matrix of indices of simplex corners into V
  195. // Output:
  196. // BC #F x dim matrix of 3d vertices
  197. //)igl_Qu8mg5v7";
  198. const char *__doc_igl_jet = R"igl_Qu8mg5v7(// JET like MATLAB's jet
  199. //
  200. // Inputs:
  201. // m number of colors
  202. // Outputs:
  203. // J m by list of RGB colors between 0 and 1
  204. //
  205. //#ifndef IGL_NO_EIGEN
  206. // void jet(const int m, Eigen::MatrixXd & J);
  207. //#endif
  208. // Wrapper for directly computing [r,g,b] values for a given factor f between
  209. // 0 and 1
  210. //
  211. // Inputs:
  212. // f factor determining color value as if 0 was min and 1 was max
  213. // Outputs:
  214. // r red value
  215. // g green value
  216. // b blue value)igl_Qu8mg5v7";
  217. const char *__doc_igl_cat = R"igl_Qu8mg5v7(// Perform concatenation of a two matrices along a single dimension
  218. // If dim == 1, then C = [A;B]. If dim == 2 then C = [A B]
  219. //
  220. // Template:
  221. // Scalar scalar data type for sparse matrices like double or int
  222. // Mat matrix type for all matrices (e.g. MatrixXd, SparseMatrix)
  223. // MatC matrix type for ouput matrix (e.g. MatrixXd) needs to support
  224. // resize
  225. // Inputs:
  226. // A first input matrix
  227. // B second input matrix
  228. // dim dimension along which to concatenate, 0 or 1
  229. // Outputs:
  230. // C output matrix
  231. // )igl_Qu8mg5v7";
  232. const char *__doc_igl_eigs = R"igl_Qu8mg5v7(See eigs for the documentation.)igl_Qu8mg5v7";
  233. const char *__doc_igl_per_corner_normals = R"igl_Qu8mg5v7(// Compute vertex normals via vertex position list, face list
  234. // Inputs:
  235. // V #V by 3 eigen Matrix of mesh vertex 3D positions
  236. // F #F by 3 eigne Matrix of face (triangle) indices
  237. // corner_threshold threshold in degrees on sharp angles
  238. // Output:
  239. // CN #F*3 by 3 eigen Matrix of mesh vertex 3D normals, where the normal
  240. // for corner F(i,j) is at CN(i*3+j,:) )igl_Qu8mg5v7";
  241. const char *__doc_igl_massmatrix = R"igl_Qu8mg5v7(// Constructs the mass (area) matrix for a given mesh (V,F).
  242. //
  243. // Templates:
  244. // DerivedV derived type of eigen matrix for V (e.g. derived from
  245. // MatrixXd)
  246. // DerivedF derived type of eigen matrix for F (e.g. derived from
  247. // MatrixXi)
  248. // Scalar scalar type for eigen sparse matrix (e.g. double)
  249. // Inputs:
  250. // V #V by dim list of mesh vertex positions
  251. // F #F by simplex_size list of mesh faces (must be triangles)
  252. // type one of the following ints:
  253. // MASSMATRIX_TYPE_BARYCENTRIC barycentric
  254. // MASSMATRIX_TYPE_VORONOI voronoi-hybrid {default}
  255. // MASSMATRIX_TYPE_FULL full {not implemented}
  256. // Outputs:
  257. // M #V by #V mass matrix
  258. //
  259. // See also: adjacency_matrix
  260. //)igl_Qu8mg5v7";
  261. const char *__doc_igl_unproject_onto_mesh = R"igl_Qu8mg5v7(// Unproject a screen location (using current opengl viewport, projection, and
  262. // model view) to a 3D position _onto_ a given mesh, if the ray through the
  263. // given screen location (x,y) _hits_ the mesh.
  264. //
  265. // Inputs:
  266. // pos screen space coordinates
  267. // model model matrix
  268. // proj projection matrix
  269. // viewport vieweport vector
  270. // V #V by 3 list of mesh vertex positions
  271. // F #F by 3 list of mesh triangle indices into V
  272. // Outputs:
  273. // fid id of the first face hit
  274. // bc barycentric coordinates of hit
  275. // Returns true if there's a hit)igl_Qu8mg5v7";
  276. const char *__doc_igl_colon = R"igl_Qu8mg5v7(// Colon operator like matlab's colon operator. Enumerats values between low
  277. // and hi with step step.
  278. // Templates:
  279. // L should be a eigen matrix primitive type like int or double
  280. // S should be a eigen matrix primitive type like int or double
  281. // H should be a eigen matrix primitive type like int or double
  282. // T should be a eigen matrix primitive type like int or double
  283. // Inputs:
  284. // low starting value if step is valid then this is *always* the first
  285. // element of I
  286. // step step difference between sequential elements returned in I,
  287. // remember this will be cast to template T at compile time. If low<hi
  288. // then step must be positive. If low>hi then step must be negative.
  289. // Otherwise I will be set to empty.
  290. // hi ending value, if (hi-low)%step is zero then this will be the last
  291. // element in I. If step is positive there will be no elements greater
  292. // than hi, vice versa if hi<low
  293. // Output:
  294. // I list of values from low to hi with step size step)igl_Qu8mg5v7";
  295. const char *__doc_igl_fit_rotations = R"igl_Qu8mg5v7(// Known issues: This seems to be implemented in Eigen/Geometry:
  296. // Eigen::umeyama
  297. //
  298. // FIT_ROTATIONS Given an input mesh and new positions find rotations for
  299. // every covariance matrix in a stack of covariance matrices
  300. //
  301. // Inputs:
  302. // S nr*dim by dim stack of covariance matrices
  303. // single_precision whether to use single precision (faster)
  304. // Outputs:
  305. // R dim by dim * nr list of rotations
  306. //)igl_Qu8mg5v7";
  307. const char *__doc_igl_fit_rotations_planar = R"igl_Qu8mg5v7(// FIT_ROTATIONS Given an input mesh and new positions find 2D rotations for
  308. // every vertex that best maps its one ring to the new one ring
  309. //
  310. // Inputs:
  311. // S nr*dim by dim stack of covariance matrices, third column and every
  312. // third row will be ignored
  313. // Outputs:
  314. // R dim by dim * nr list of rotations, third row and third column of each
  315. // rotation will just be identity
  316. //)igl_Qu8mg5v7";
  317. const char *__doc_igl_fit_rotations_SSE = R"igl_Qu8mg5v7(See fit_rotations_SSE for the documentation.)igl_Qu8mg5v7";
  318. const char *__doc_igl_rotate_vectors = R"igl_Qu8mg5v7(// Rotate the vectors V by A radiants on the tangent plane spanned by B1 and
  319. // B2
  320. //
  321. // Inputs:
  322. // V #V by 3 eigen Matrix of vectors
  323. // A #V eigen vector of rotation angles or a single angle to be applied
  324. // to all vectors
  325. // B1 #V by 3 eigen Matrix of base vector 1
  326. // B2 #V by 3 eigen Matrix of base vector 2
  327. //
  328. // Output:
  329. // Returns the rotated vectors
  330. //)igl_Qu8mg5v7";
  331. const char *__doc_igl_read_triangle_mesh = R"igl_Qu8mg5v7(// read mesh from an ascii file with automatic detection of file format.
  332. // supported: obj, off, stl, wrl, ply, mesh)
  333. //
  334. // Templates:
  335. // Scalar type for positions and vectors (will be read as double and cast
  336. // to Scalar)
  337. // Index type for indices (will be read as int and cast to Index)
  338. // Inputs:
  339. // str path to file
  340. // Outputs:
  341. // V eigen double matrix #V by 3
  342. // F eigen int matrix #F by 3
  343. // Returns true iff success)igl_Qu8mg5v7";
  344. const char *__doc_igl_gaussian_curvature = R"igl_Qu8mg5v7(// Compute discrete local integral gaussian curvature (angle deficit, without
  345. // averaging by local area).
  346. //
  347. // Inputs:
  348. // V #V by 3 eigen Matrix of mesh vertex 3D positions
  349. // F #F by 3 eigen Matrix of face (triangle) indices
  350. // Output:
  351. // K #V by 1 eigen Matrix of discrete gaussian curvature values
  352. //)igl_Qu8mg5v7";
  353. const char *__doc_igl_planarize_quad_mesh = R"igl_Qu8mg5v7(// Inputs:
  354. // Vin #V by 3 eigen Matrix of mesh vertex 3D positions
  355. // F #F by 4 eigen Matrix of face (quad) indices
  356. // maxIter maximum numbers of iterations
  357. // threshold minimum allowed threshold for non-planarity
  358. // Output:
  359. // Vout #V by 3 eigen Matrix of planar mesh vertex 3D positions
  360. //)igl_Qu8mg5v7";
  361. const char *__doc_igl_avg_edge_length = R"igl_Qu8mg5v7(// Compute the average edge length for the given triangle mesh
  362. // Templates:
  363. // DerivedV derived from vertex positions matrix type: i.e. MatrixXd
  364. // DerivedF derived from face indices matrix type: i.e. MatrixXi
  365. // DerivedL derived from edge lengths matrix type: i.e. MatrixXd
  366. // Inputs:
  367. // V eigen matrix #V by 3
  368. // F #F by simplex-size list of mesh faces (must be simplex)
  369. // Outputs:
  370. // l average edge length
  371. //
  372. // See also: adjacency_matrix)igl_Qu8mg5v7";
  373. const char *__doc_igl_barycentric_coordinates = R"igl_Qu8mg5v7(// Compute barycentric coordinates in a tet
  374. //
  375. // Inputs:
  376. // P #P by 3 Query points in 3d
  377. // A #P by 3 Tet corners in 3d
  378. // B #P by 3 Tet corners in 3d
  379. // C #P by 3 Tet corners in 3d
  380. // D #P by 3 Tet corners in 3d
  381. // Outputs:
  382. // L #P by 4 list of barycentric coordinates
  383. // )igl_Qu8mg5v7";
  384. const char *__doc_igl_lscm = R"igl_Qu8mg5v7(// Compute a Least-squares conformal map parametrization (equivalently
  385. // derived in "Intrinsic Parameterizations of Surface Meshes" [Desbrun et al.
  386. // 2002] and "Least Squares Conformal Maps for Automatic Texture Atlas
  387. // Generation" [Lévy et al. 2002]), though this implementation follows the
  388. // derivation in: "Spectral Conformal Parameterization" [Mullen et al. 2008]
  389. // (note, this does **not** implement the Eigen-decomposition based method in
  390. // [Mullen et al. 2008], which is not equivalent). Input should be a manifold
  391. // mesh (also no unreferenced vertices) and "boundary" (fixed vertices) `b`
  392. // should contain at least two vertices per connected component.
  393. //
  394. // Inputs:
  395. // V #V by 3 list of mesh vertex positions
  396. // F #F by 3 list of mesh faces (must be triangles)
  397. // b #b boundary indices into V
  398. // bc #b by 3 list of boundary values
  399. // Outputs:
  400. // UV #V by 2 list of 2D mesh vertex positions in UV space
  401. // Returns true only on solver success.
  402. //)igl_Qu8mg5v7";
  403. const char *__doc_igl_find_cross_field_singularities = R"igl_Qu8mg5v7(// Inputs:
  404. // V #V by 3 eigen Matrix of mesh vertex 3D positions
  405. // F #F by 3 eigen Matrix of face (quad) indices
  406. // Handle_MMatch #F by 3 eigen Matrix containing the integer missmatch of the cross field
  407. // across all face edges
  408. // Output:
  409. // isSingularity #V by 1 boolean eigen Vector indicating the presence of a singularity on a vertex
  410. // singularityIndex #V by 1 integer eigen Vector containing the singularity indices
  411. //)igl_Qu8mg5v7";
  412. const char *__doc_igl_upsample = R"igl_Qu8mg5v7(// Subdivide a mesh without moving vertices: loop subdivision but odd
  413. // vertices stay put and even vertices are just edge midpoints
  414. //
  415. // Templates:
  416. // MatV matrix for vertex positions, e.g. MatrixXd
  417. // MatF matrix for vertex positions, e.g. MatrixXi
  418. // Inputs:
  419. // V #V by dim mesh vertices
  420. // F #F by 3 mesh triangles
  421. // Outputs:
  422. // NV new vertex positions, V is guaranteed to be at top
  423. // NF new list of face indices
  424. //
  425. // NOTE: V should not be the same as NV,
  426. // NOTE: F should not be the same as NF, use other proto
  427. //
  428. // Known issues:
  429. // - assumes (V,F) is edge-manifold.)igl_Qu8mg5v7";
  430. const char *__doc_igl_slice_mask = R"igl_Qu8mg5v7(// Act like the matlab X(row_mask,col_mask) operator, where
  431. // row_mask, col_mask are non-negative integer indices.
  432. //
  433. // Inputs:
  434. // X m by n matrix
  435. // R m list of row bools
  436. // C n list of column bools
  437. // Output:
  438. // Y #trues-in-R by #trues-in-C matrix
  439. //
  440. // See also: slice_mask)igl_Qu8mg5v7";
  441. const char *__doc_igl_point_mesh_squared_distance = R"igl_Qu8mg5v7(// Compute distances from a set of points P to a triangle mesh (V,F)
  442. //
  443. // Inputs:
  444. // P #P by 3 list of query point positions
  445. // V #V by 3 list of vertex positions
  446. // Ele #Ele by (3|2|1) list of (triangle|edge|point) indices
  447. // Outputs:
  448. // sqrD #P list of smallest squared distances
  449. // I #P list of primitive indices corresponding to smallest distances
  450. // C #P by 3 list of closest points
  451. //
  452. // Known bugs: This only computes distances to given primitivess. So
  453. // unreferenced vertices are ignored. However, degenerate primitives are
  454. // handled correctly: triangle [1 2 2] is treated as a segment [1 2], and
  455. // triangle [1 1 1] is treated as a point. So one _could_ add extra
  456. // combinatorially degenerate rows to Ele for all unreferenced vertices to
  457. // also get distances to points.)igl_Qu8mg5v7";
  458. const char *__doc_igl_parula = R"igl_Qu8mg5v7(// PARULA like MATLAB's parula
  459. //
  460. // Inputs:
  461. // m number of colors
  462. // Outputs:
  463. // J m by list of RGB colors between 0 and 1
  464. //
  465. // Wrapper for directly computing [r,g,b] values for a given factor f between
  466. // 0 and 1
  467. //
  468. // Inputs:
  469. // f factor determining color value as if 0 was min and 1 was max
  470. // Outputs:
  471. // r red value
  472. // g green value
  473. // b blue value)igl_Qu8mg5v7";
  474. const char *__doc_igl_setdiff = R"igl_Qu8mg5v7(// Set difference of elements of matrices
  475. //
  476. // Inputs:
  477. // A m-long vector of indices
  478. // B n-long vector of indices
  479. // Outputs:
  480. // C (k<=m)-long vector of unique elements appearing in A but not in B
  481. // IA (k<=m)-long list of indices into A so that C = A(IA)
  482. //)igl_Qu8mg5v7";
  483. const char *__doc_igl_copyleft_tetgen_tetrahedralize = R"igl_Qu8mg5v7(// Mesh the interior of a surface mesh (V,F) using tetgen
  484. //
  485. // Inputs:
  486. // V #V by 3 vertex position list
  487. // F #F list of polygon face indices into V (0-indexed)
  488. // switches string of tetgen options (See tetgen documentation) e.g.
  489. // "pq1.414a0.01" tries to mesh the interior of a given surface with
  490. // quality and area constraints
  491. // "" will mesh the convex hull constrained to pass through V (ignores F)
  492. // Outputs:
  493. // TV #V by 3 vertex position list
  494. // TT #T by 4 list of tet face indices
  495. // TF #F by 3 list of triangle face indices
  496. // Returns status:
  497. // 0 success
  498. // 1 tetgen threw exception
  499. // 2 tetgen did not crash but could not create any tets (probably there are
  500. // holes, duplicate faces etc.)
  501. // -1 other error)igl_Qu8mg5v7";
  502. const char *__doc_igl_comb_frame_field = R"igl_Qu8mg5v7(// Inputs:
  503. // V #V by 3 eigen Matrix of mesh vertex 3D positions
  504. // F #F by 4 eigen Matrix of face (quad) indices
  505. // PD1 #F by 3 eigen Matrix of the first per face cross field vector
  506. // PD2 #F by 3 eigen Matrix of the second per face cross field vector
  507. // BIS1_combed #F by 3 eigen Matrix of the first combed bisector field vector
  508. // BIS2_combed #F by 3 eigen Matrix of the second combed bisector field vector
  509. // Output:
  510. // PD1_combed #F by 3 eigen Matrix of the first combed cross field vector
  511. // PD2_combed #F by 3 eigen Matrix of the second combed cross field vector
  512. //)igl_Qu8mg5v7";
  513. const char *__doc_igl_map_vertices_to_circle = R"igl_Qu8mg5v7(// Map the vertices whose indices are in a given boundary loop (bnd) on the
  514. // unit circle with spacing proportional to the original boundary edge
  515. // lengths.
  516. //
  517. // Inputs:
  518. // V #V by dim list of mesh vertex positions
  519. // b #W list of vertex ids
  520. // Outputs:
  521. // UV #W by 2 list of 2D position on the unit circle for the vertices in b)igl_Qu8mg5v7";
  522. const char *__doc_igl_writeOBJ = R"igl_Qu8mg5v7(// Write a mesh in an ascii obj file
  523. // Inputs:
  524. // str path to outputfile
  525. // V #V by 3 mesh vertex positions
  526. // F #F by 3|4 mesh indices into V
  527. // CN #CN by 3 normal vectors
  528. // FN #F by 3|4 corner normal indices into CN
  529. // TC #TC by 2|3 texture coordinates
  530. // FTC #F by 3|4 corner texture coord indices into TC
  531. // Returns true on success, false on error)igl_Qu8mg5v7";
  532. const char *__doc_igl_active_set = R"igl_Qu8mg5v7(// Known Bugs: rows of [Aeq;Aieq] **must** be linearly independent. Should be
  533. // using QR decomposition otherwise:
  534. // http://www.okstate.edu/sas/v8/sashtml/ormp/chap5/sect32.htm
  535. //
  536. // ACTIVE_SET Minimize quadratic energy
  537. //
  538. // 0.5*Z'*A*Z + Z'*B + C with constraints
  539. //
  540. // that Z(known) = Y, optionally also subject to the constraints Aeq*Z = Beq,
  541. // and further optionally subject to the linear inequality constraints that
  542. // Aieq*Z <= Bieq and constant inequality constraints lx <= x <= ux
  543. //
  544. // Inputs:
  545. // A n by n matrix of quadratic coefficients
  546. // B n by 1 column of linear coefficients
  547. // known list of indices to known rows in Z
  548. // Y list of fixed values corresponding to known rows in Z
  549. // Aeq meq by n list of linear equality constraint coefficients
  550. // Beq meq by 1 list of linear equality constraint constant values
  551. // Aieq mieq by n list of linear inequality constraint coefficients
  552. // Bieq mieq by 1 list of linear inequality constraint constant values
  553. // lx n by 1 list of lower bounds [] implies -Inf
  554. // ux n by 1 list of upper bounds [] implies Inf
  555. // params struct of additional parameters (see below)
  556. // Z if not empty, is taken to be an n by 1 list of initial guess values
  557. // (see output)
  558. // Outputs:
  559. // Z n by 1 list of solution values
  560. // Returns true on success, false on error
  561. //
  562. // Benchmark: For a harmonic solve on a mesh with 325K facets, matlab 2.2
  563. // secs, igl/min_quad_with_fixed.h 7.1 secs
  564. //)igl_Qu8mg5v7";
  565. const char *__doc_igl_per_edge_normals = R"igl_Qu8mg5v7(// Compute face normals via vertex position list, face list
  566. // Inputs:
  567. // V #V by 3 eigen Matrix of mesh vertex 3D positions
  568. // F #F by 3 eigen Matrix of face (triangle) indices
  569. // weight weighting type
  570. // FN #F by 3 matrix of 3D face normals per face
  571. // Output:
  572. // N #2 by 3 matrix of mesh edge 3D normals per row
  573. // E #E by 2 matrix of edge indices per row
  574. // EMAP #E by 1 matrix of indices from all edges to E
  575. //)igl_Qu8mg5v7";
  576. const char *__doc_igl_covariance_scatter_matrix = R"igl_Qu8mg5v7(// Construct the covariance scatter matrix for a given arap energy
  577. // Inputs:
  578. // V #V by Vdim list of initial domain positions
  579. // F #F by 3 list of triangle indices into V
  580. // energy ARAPEnergyType enum value defining which energy is being used.
  581. // See ARAPEnergyType.h for valid options and explanations.
  582. // Outputs:
  583. // CSM dim*#V/#F by dim*#V sparse matrix containing special laplacians along
  584. // the diagonal so that when multiplied by V gives covariance matrix
  585. // elements, can be used to speed up covariance matrix computation)igl_Qu8mg5v7";
  586. const char *__doc_igl_boundary_facets = R"igl_Qu8mg5v7(// BOUNDARY_FACETS Determine boundary faces (edges) of tetrahedra (triangles)
  587. // stored in T (analogous to qptoolbox's `outline` and `boundary_faces`).
  588. //
  589. // Templates:
  590. // IntegerT integer-value: e.g. int
  591. // IntegerF integer-value: e.g. int
  592. // Input:
  593. // T tetrahedron (triangle) index list, m by 4 (3), where m is the number of tetrahedra
  594. // Output:
  595. // F list of boundary faces, n by 3 (2), where n is the number of boundary faces
  596. //
  597. //)igl_Qu8mg5v7";
  598. const char *__doc_igl_compute_frame_field_bisectors = R"igl_Qu8mg5v7(// Compute bisectors of a frame field defined on mesh faces
  599. // Inputs:
  600. // V #V by 3 eigen Matrix of mesh vertex 3D positions
  601. // F #F by 3 eigen Matrix of face (triangle) indices
  602. // B1 #F by 3 eigen Matrix of face (triangle) base vector 1
  603. // B2 #F by 3 eigen Matrix of face (triangle) base vector 2
  604. // PD1 #F by 3 eigen Matrix of the first per face frame field vector
  605. // PD2 #F by 3 eigen Matrix of the second per face frame field vector
  606. // Output:
  607. // BIS1 #F by 3 eigen Matrix of the first per face frame field bisector
  608. // BIS2 #F by 3 eigen Matrix of the second per face frame field bisector
  609. //)igl_Qu8mg5v7";
  610. const char *__doc_igl_edge_lengths = R"igl_Qu8mg5v7(// Constructs a list of lengths of edges opposite each index in a face
  611. // (triangle/tet) list
  612. //
  613. // Templates:
  614. // DerivedV derived from vertex positions matrix type: i.e. MatrixXd
  615. // DerivedF derived from face indices matrix type: i.e. MatrixXi
  616. // DerivedL derived from edge lengths matrix type: i.e. MatrixXd
  617. // Inputs:
  618. // V eigen matrix #V by 3
  619. // F #F by 2 list of mesh edges
  620. // or
  621. // F #F by 3 list of mesh faces (must be triangles)
  622. // or
  623. // T #T by 4 list of mesh elements (must be tets)
  624. // Outputs:
  625. // L #F by {1|3|6} list of edge lengths
  626. // for edges, column of lengths
  627. // for triangles, columns correspond to edges [1,2],[2,0],[0,1]
  628. // for tets, columns correspond to edges
  629. // [3 0],[3 1],[3 2],[1 2],[2 0],[0 1]
  630. //)igl_Qu8mg5v7";
  631. const char *__doc_igl_readOBJ = R"igl_Qu8mg5v7(// Read a mesh from an ascii obj file, filling in vertex positions, normals
  632. // and texture coordinates. Mesh may have faces of any number of degree
  633. //
  634. // Templates:
  635. // Scalar type for positions and vectors (will be read as double and cast
  636. // to Scalar)
  637. // Index type for indices (will be read as int and cast to Index)
  638. // Inputs:
  639. // str path to .obj file
  640. // Outputs:
  641. // V double matrix of vertex positions #V by 3
  642. // TC double matrix of texture coordinats #TC by 2
  643. // N double matrix of corner normals #N by 3
  644. // F #F list of face indices into vertex positions
  645. // FTC #F list of face indices into vertex texture coordinates
  646. // FN #F list of face indices into vertex normals
  647. // Returns true on success, false on errors)igl_Qu8mg5v7";
  648. 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
  649. // (MMatch), finds the cut_graph connecting the singularities (seams) and the
  650. // degree of the singularities singularity_index
  651. //
  652. // Input:
  653. // V #V by 3 list of mesh vertex positions
  654. // F #F by 3 list of faces
  655. // MMatch #F by 3 list of per corner integer mismatch
  656. // Outputs:
  657. // seams #F by 3 list of per corner booleans that denotes if an edge is a
  658. // seam or not
  659. //)igl_Qu8mg5v7";
  660. const char *__doc_igl_readDMAT = R"igl_Qu8mg5v7(See readDMAT for the documentation.)igl_Qu8mg5v7";
  661. const char *__doc_igl_doublearea = R"igl_Qu8mg5v7(// DOUBLEAREA computes twice the area for each input triangle[quad]
  662. //
  663. // Templates:
  664. // DerivedV derived type of eigen matrix for V (e.g. derived from
  665. // MatrixXd)
  666. // DerivedF derived type of eigen matrix for F (e.g. derived from
  667. // MatrixXi)
  668. // DeriveddblA derived type of eigen matrix for dblA (e.g. derived from
  669. // MatrixXd)
  670. // Inputs:
  671. // V #V by dim list of mesh vertex positions
  672. // F #F by simplex_size list of mesh faces (must be triangles or quads)
  673. // Outputs:
  674. // dblA #F list of triangle[quad] double areas (SIGNED only for 2D input)
  675. //
  676. // Known bug: For dim==3 complexity is O(#V + #F)!! Not just O(#F). This is a big deal
  677. // if you have 1million unreferenced vertices and 1 face)igl_Qu8mg5v7";
  678. const char *__doc_igl_doublearea_single = R"igl_Qu8mg5v7(// Single triangle in 2D!
  679. //
  680. // This should handle streams of corners not just single corners)igl_Qu8mg5v7";
  681. const char *__doc_igl_doublearea_quad = R"igl_Qu8mg5v7(// DOUBLEAREA_QUAD computes twice the area for each input quadrilateral
  682. //
  683. // Inputs:
  684. // V #V by dim list of mesh vertex positions
  685. // F #F by simplex_size list of mesh faces (must be quadrilaterals)
  686. // Outputs:
  687. // dblA #F list of quadrilateral double areas
  688. //)igl_Qu8mg5v7";
  689. const char *__doc_igl_min_quad_with_fixed_precompute = R"igl_Qu8mg5v7(// Known Bugs: rows of Aeq **should probably** be linearly independent.
  690. // During precomputation, the rows of a Aeq are checked via QR. But in case
  691. // they're not then resulting probably will no longer be sparse: it will be
  692. // slow.
  693. //
  694. // MIN_QUAD_WITH_FIXED Minimize quadratic energy
  695. //
  696. // 0.5*Z'*A*Z + Z'*B + C with
  697. //
  698. // constraints that Z(known) = Y, optionally also subject to the constraints
  699. // Aeq*Z = Beq
  700. //
  701. // Templates:
  702. // T should be a eigen matrix primitive type like int or double
  703. // Inputs:
  704. // A n by n matrix of quadratic coefficients
  705. // known list of indices to known rows in Z
  706. // Y list of fixed values corresponding to known rows in Z
  707. // Aeq m by n list of linear equality constraint coefficients
  708. // pd flag specifying whether A(unknown,unknown) is positive definite
  709. // Outputs:
  710. // data factorization struct with all necessary information to solve
  711. // using min_quad_with_fixed_solve
  712. // Returns true on success, false on error
  713. //
  714. // Benchmark: For a harmonic solve on a mesh with 325K facets, matlab 2.2
  715. // secs, igl/min_quad_with_fixed.h 7.1 secs
  716. //)igl_Qu8mg5v7";
  717. const char *__doc_igl_min_quad_with_fixed_solve = R"igl_Qu8mg5v7(// Solves a system previously factored using min_quad_with_fixed_precompute
  718. //
  719. // Template:
  720. // T type of sparse matrix (e.g. double)
  721. // DerivedY type of Y (e.g. derived from VectorXd or MatrixXd)
  722. // DerivedZ type of Z (e.g. derived from VectorXd or MatrixXd)
  723. // Inputs:
  724. // data factorization struct with all necessary precomputation to solve
  725. // B n by 1 column of linear coefficients
  726. // Y b by 1 list of constant fixed values
  727. // Beq m by 1 list of linear equality constraint constant values
  728. // Outputs:
  729. // Z n by cols solution
  730. // sol #unknowns+#lagrange by cols solution to linear system
  731. // Returns true on success, false on error)igl_Qu8mg5v7";
  732. const char *__doc_igl_min_quad_with_fixed = R"igl_Qu8mg5v7(See min_quad_with_fixed for the documentation.)igl_Qu8mg5v7";
  733. const char *__doc_igl_writeMESH = R"igl_Qu8mg5v7(// save a tetrahedral volume mesh to a .mesh file
  734. //
  735. // Templates:
  736. // Scalar type for positions and vectors (will be cast as double)
  737. // Index type for indices (will be cast to int)
  738. // Input:
  739. // mesh_file_name path of .mesh file
  740. // V double matrix of vertex positions #V by 3
  741. // T #T list of tet indices into vertex positions
  742. // F #F list of face indices into vertex positions
  743. //
  744. // Known bugs: Holes and regions are not supported)igl_Qu8mg5v7";
  745. const char *__doc_igl_unique = R"igl_Qu8mg5v7(// Act like matlab's [C,IA,IC] = unique(X)
  746. //
  747. // Templates:
  748. // T comparable type T
  749. // Inputs:
  750. // A #A vector of type T
  751. // Outputs:
  752. // C #C vector of unique entries in A
  753. // IA #C index vector so that C = A(IA);
  754. // IC #A index vector so that A = C(IC);)igl_Qu8mg5v7";
  755. const char *__doc_igl_unique_rows = R"igl_Qu8mg5v7(// Act like matlab's [C,IA,IC] = unique(X,'rows')
  756. //
  757. // Templates:
  758. // DerivedA derived scalar type, e.g. MatrixXi or MatrixXd
  759. // DerivedIA derived integer type, e.g. MatrixXi
  760. // DerivedIC derived integer type, e.g. MatrixXi
  761. // Inputs:
  762. // A m by n matrix whose entries are to unique'd according to rows
  763. // Outputs:
  764. // C #C vector of unique rows in A
  765. // IA #C index vector so that C = A(IA,:);
  766. // IC #A index vector so that A = C(IC,:);)igl_Qu8mg5v7";
  767. const char *__doc_igl_arap_precomputation = R"igl_Qu8mg5v7(// Compute necessary information to start using an ARAP deformation
  768. //
  769. // Inputs:
  770. // V #V by dim list of mesh positions
  771. // F #F by simplex-size list of triangle|tet indices into V
  772. // dim dimension being used at solve time. For deformation usually dim =
  773. // V.cols(), for surface parameterization V.cols() = 3 and dim = 2
  774. // b #b list of "boundary" fixed vertex indices into V
  775. // Outputs:
  776. // data struct containing necessary precomputation)igl_Qu8mg5v7";
  777. const char *__doc_igl_arap_solve = R"igl_Qu8mg5v7(// Inputs:
  778. // bc #b by dim list of boundary conditions
  779. // data struct containing necessary precomputation and parameters
  780. // U #V by dim initial guess)igl_Qu8mg5v7";
  781. const char *__doc_igl_cross_field_missmatch = R"igl_Qu8mg5v7(// Inputs:
  782. // V #V by 3 eigen Matrix of mesh vertex 3D positions
  783. // F #F by 3 eigen Matrix of face (quad) indices
  784. // PD1 #F by 3 eigen Matrix of the first per face cross field vector
  785. // PD2 #F by 3 eigen Matrix of the second per face cross field vector
  786. // isCombed boolean, specifying whether the field is combed (i.e. matching has been precomputed.
  787. // If not, the field is combed first.
  788. // Output:
  789. // Handle_MMatch #F by 3 eigen Matrix containing the integer missmatch of the cross field
  790. // across all face edges
  791. //)igl_Qu8mg5v7";
  792. const char *__doc_igl_grad = R"igl_Qu8mg5v7(// Gradient of a scalar function defined on piecewise linear elements (mesh)
  793. // is constant on each triangle i,j,k:
  794. // grad(Xijk) = (Xj-Xi) * (Vi - Vk)^R90 / 2A + (Xk-Xi) * (Vj - Vi)^R90 / 2A
  795. // where Xi is the scalar value at vertex i, Vi is the 3D position of vertex
  796. // i, and A is the area of triangle (i,j,k). ^R90 represent a rotation of
  797. // 90 degrees
  798. //)igl_Qu8mg5v7";
  799. const char *__doc_igl_slice_into = R"igl_Qu8mg5v7(// Act like the matlab Y(row_indices,col_indices) = X
  800. //
  801. // Inputs:
  802. // X xm by xn rhs matrix
  803. // R list of row indices
  804. // C list of column indices
  805. // Y ym by yn lhs matrix
  806. // Output:
  807. // Y ym by yn lhs matrix, same as input but Y(R,C) = X)igl_Qu8mg5v7";
  808. const char *__doc_igl_slice_tets = R"igl_Qu8mg5v7(// SLICE_TETS Slice through a tet mesh (V,T) along a given plane (via its
  809. // implicit equation).
  810. //
  811. // Inputs:
  812. // V #V by 3 list of tet mesh vertices
  813. // T #T by 4 list of tet indices into V
  814. // plane list of 4 coefficients in the plane equation: [x y z 1]'*plane = 0
  815. // Optional:
  816. // 'Manifold' followed by whether to stitch together triangles into a
  817. // manifold mesh {true}: results in more compact U but slightly slower.
  818. // Outputs:
  819. // U #U by 3 list of triangle mesh vertices along slice
  820. // G #G by 3 list of triangles indices into U
  821. // J #G list of indices into T revealing from which tet each faces comes
  822. // BC #U by #V list of barycentric coordinates (or more generally: linear
  823. // interpolation coordinates) so that U = BC*V
  824. // )igl_Qu8mg5v7";
  825. const char *__doc_igl_n_polyvector = R"igl_Qu8mg5v7(// Inputs:
  826. // v0, v1 the two #3 by 1 vectors
  827. // normalized boolean, if false, then the vectors are normalized prior to the calculation
  828. // Output:
  829. // 3 by 3 rotation matrix that takes v0 to v1
  830. //)igl_Qu8mg5v7";
  831. const char *__doc_igl_harmonic = R"igl_Qu8mg5v7(// Compute k-harmonic weight functions "coordinates".
  832. //
  833. //
  834. // Inputs:
  835. // V #V by dim vertex positions
  836. // F #F by simplex-size list of element indices
  837. // b #b boundary indices into V
  838. // bc #b by #W list of boundary values
  839. // k power of harmonic operation (1: harmonic, 2: biharmonic, etc)
  840. // Outputs:
  841. // W #V by #W list of weights
  842. //)igl_Qu8mg5v7";
  843. const char *__doc_igl_boundary_loop = R"igl_Qu8mg5v7(// Compute list of ordered boundary loops for a manifold mesh.
  844. //
  845. // Templates:
  846. // Index index type
  847. // Inputs:
  848. // F #V by dim list of mesh faces
  849. // Outputs:
  850. // L list of loops where L[i] = ordered list of boundary vertices in loop i
  851. //)igl_Qu8mg5v7";
  852. const char *__doc_igl_polar_svd = R"igl_Qu8mg5v7(// Computes the polar decomposition (R,T) of a matrix A using SVD singular
  853. // value decomposition
  854. //
  855. // Inputs:
  856. // A 3 by 3 matrix to be decomposed
  857. // Outputs:
  858. // R 3 by 3 rotation matrix part of decomposition (**always rotataion**)
  859. // T 3 by 3 stretch matrix part of decomposition
  860. // U 3 by 3 left-singular vectors
  861. // S 3 by 1 singular values
  862. // V 3 by 3 right-singular vectors
  863. //
  864. //)igl_Qu8mg5v7";
  865. const char *__doc_igl_comb_cross_field = R"igl_Qu8mg5v7(// Inputs:
  866. // V #V by 3 eigen Matrix of mesh vertex 3D positions
  867. // F #F by 4 eigen Matrix of face (quad) indices
  868. // PD1in #F by 3 eigen Matrix of the first per face cross field vector
  869. // PD2in #F by 3 eigen Matrix of the second per face cross field vector
  870. // Output:
  871. // PD1out #F by 3 eigen Matrix of the first combed cross field vector
  872. // PD2out #F by 3 eigen Matrix of the second combed cross field vector
  873. //)igl_Qu8mg5v7";
  874. const char *__doc_igl_invert_diag = R"igl_Qu8mg5v7(// Templates:
  875. // T should be a eigen sparse matrix primitive type like int or double
  876. // Inputs:
  877. // X an m by n sparse matrix
  878. // Outputs:
  879. // Y an m by n sparse matrix)igl_Qu8mg5v7";
  880. const char *__doc_igl_readMESH = R"igl_Qu8mg5v7(// load a tetrahedral volume mesh from a .mesh file
  881. //
  882. // Templates:
  883. // Scalar type for positions and vectors (will be read as double and cast
  884. // to Scalar)
  885. // Index type for indices (will be read as int and cast to Index)
  886. // Input:
  887. // mesh_file_name path of .mesh file
  888. // Outputs:
  889. // V double matrix of vertex positions #V by 3
  890. // T #T list of tet indices into vertex positions
  891. // F #F list of face indices into vertex positions
  892. //
  893. // Known bugs: Holes and regions are not supported)igl_Qu8mg5v7";
  894. const char *__doc_igl_copyleft_comiso_miq = R"igl_Qu8mg5v7(// Inputs:
  895. // V #V by 3 list of mesh vertex 3D positions
  896. // F #F by 3 list of faces indices in V
  897. // PD1 #V by 3 first line of the Jacobian per triangle
  898. // PD2 #V by 3 second line of the Jacobian per triangle
  899. // (optional, if empty it will be a vector in the tangent plane orthogonal to PD1)
  900. // scale global scaling for the gradient (controls the quads resolution)
  901. // stiffness weight for the stiffness iterations
  902. // direct_round greedily round all integer variables at once (greatly improves optimization speed but lowers quality)
  903. // iter stiffness iterations (0 = no stiffness)
  904. // local_iter number of local iterations for the integer rounding
  905. // do_round enables the integer rounding (disabling it could be useful for debugging)
  906. // round_vertices id of additional vertices that should be snapped to integer coordinates
  907. // hard_features #H by 2 list of pairs of vertices that belongs to edges that should be snapped to integer coordinates
  908. //
  909. // Output:
  910. // UV #UV by 2 list of vertices in 2D
  911. // FUV #FUV by 3 list of face indices in UV
  912. //
  913. // TODO: rename the parameters name in the cpp consistenly
  914. // improve the handling of hard_features, right now it might fail in difficult cases)igl_Qu8mg5v7";
  915. const char *__doc_igl_copyleft_comiso_nrosy = R"igl_Qu8mg5v7(// Generate a N-RoSy field from a sparse set of constraints
  916. //
  917. // Inputs:
  918. // V #V by 3 list of mesh vertex coordinates
  919. // F #F by 3 list of mesh faces (must be triangles)
  920. // b #B by 1 list of constrained face indices
  921. // bc #B by 3 list of representative vectors for the constrained
  922. // faces
  923. // b_soft #S by 1 b for soft constraints
  924. // w_soft #S by 1 weight for the soft constraints (0-1)
  925. // bc_soft #S by 3 bc for soft constraints
  926. // N the degree of the N-RoSy vector field
  927. // soft the strenght of the soft contraints w.r.t. smoothness
  928. // (0 -> smoothness only, 1->constraints only)
  929. // Outputs:
  930. // R #F by 3 the representative vectors of the interpolated field
  931. // S #V by 1 the singularity index for each vertex (0 = regular))igl_Qu8mg5v7";