Skip to content

Commit cbab259

Browse files
author
Teseo Schneider
committed
updated doc
1 parent 70a8ea7 commit cbab259

3 files changed

Lines changed: 36 additions & 2 deletions

File tree

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ markdown_extensions:
4545
- pymdownx.tasklist:
4646
custom_checkbox: true
4747
- pymdownx.tilde
48-
plugins1:
48+
plugins:
4949
- mknotebooks:
5050
execute: true
5151
preamble: "tutorial/plot_to_md.py"

tutorial/exporter.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@
2323
"d(A, B) = max(",
2424
"d(A,B)",
2525
"per_face_normals(V,F,Vector3d(1,1,1)",
26-
"the number of positively"
26+
"the number of positively",
27+
"trace(",
28+
"Z(known,:)"
2729
]
2830

2931
def format_data(data):

tutorial/igl_docs.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1027,6 +1027,21 @@ Constructs the mass (area) matrix for a given mesh (V,F).
10271027
|See also| adjacency_matrix, cotmatrix, grad |
10281028

10291029

1030+
### min_quad_with_fixed
1031+
**`min_quad_with_fixed(A: sparse_matrix, B: array, known: array, Y: array, Aeq: sparse_matrix, Beq: array, is_A_pd: bool)`**
1032+
1033+
MIN_QUAD_WITH_FIXED Minimize a quadratic energy of the form
1034+
trace( 0.5*Z'*A*Z + Z'*B + constant )
1035+
subject to
1036+
Z(known,:) = Y, and
1037+
Aeq*Z = Beq
1038+
1039+
| | |
1040+
|-|-|
1041+
|Parameters| A n by n matrix of quadratic coefficients</br>B n by 1 column of linear coefficients</br>known list of indices to known rows in Z</br>Y list of fixed values corresponding to known rows in Z</br>Aeq m by n list of linear equality constraint coefficients</br>Beq m by 1 list of linear equality constraint constant values</br>is_A_pd flag specifying whether A(unknown,unknown) is positive definite |
1042+
|Returns| Z n by k solution |
1043+
1044+
10301045
### orientable_patches
10311046
**`orientable_patches(f: array)`**
10321047

@@ -1375,6 +1390,23 @@ cone and a _uniform_ average (_not_ a average weighted by inverse angles).
13751390
|Returns| S \#P list of shape diamater function values between bounding box</br>diagonal (perfect sphere) and 0 (perfect needle hook) |
13761391

13771392

1393+
### signed_distance
1394+
**`signed_distance(p: array, v: array, f: array, return_normals: bool = False) -> tuple`**
1395+
1396+
SIGNED_DISTANCE computes signed distance to a mesh
1397+
1398+
| | |
1399+
|-|-|
1400+
|Parameters| P \#P by 3 list of query point positions</br>V \#V by 3 list of vertex positions</br>F \#F by ss list of triangle indices, ss should be 3 unless sign_type</br>return_normals (Optional, defaults to False) If set to True, will return pseudonormals of</br>closest points to each query point in P |
1401+
|Returns| S \#P list of smallest signed distances</br>I \#P list of facet indices corresponding to smallest distances</br>C \#P by 3 list of closest points |
1402+
|Notes| Known issue: This only computes distances to triangles. So unreferenced</br>vertices and degenerate triangles are ignored. |
1403+
1404+
**Examples**
1405+
```python
1406+
S, I, C = signed_distance(P, V, F, return_normals=False)
1407+
```
1408+
1409+
13781410
### sort_angles
13791411
**`sort_angles(m: array)`**
13801412

0 commit comments

Comments
 (0)