Skip to content

Commit 3a9b1ce

Browse files
committed
user manual: update some definitions
1 parent a32a18f commit 3a9b1ce

File tree

6 files changed

+100
-21
lines changed

6 files changed

+100
-21
lines changed
-11.6 KB
Binary file not shown.
Binary file not shown.
Loading
Binary file not shown.
Loading

docs/matGeom-manual/matGeom-manual.lyx

Lines changed: 100 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -611,17 +611,22 @@ The MatGeom library tries to follow standard conventions and practices both
611611
\end_layout
612612

613613
\begin_layout Standard
614-
Function names follow the (lower) came case
614+
Function names follow the (lower)
615+
\begin_inset Quotes eld
616+
\end_inset
617+
618+
came case
615619
\begin_inset Quotes erd
616620
\end_inset
617621

618-
convention, example:
622+
convention.
623+
Example:
619624
\family typewriter
620-
intersectLineCircle
625+
drawLine
621626
\family default
622627
.
623628
Functions start either by a verb at the infinitive, or by a noun (when
624-
returning the corresponding measure).
629+
working on a specific data structure).
625630
Examples:
626631
\family typewriter
627632
clipPolygon
@@ -4459,14 +4464,31 @@ open
44594464
\series default
44604465
, depending on whether the last vertex is connected to the first one or
44614466
not.
4462-
This can be given as an option is some functions in the module.
4467+
Open polylines are also called
4468+
\begin_inset Quotes eld
4469+
\end_inset
4470+
4471+
line strings
4472+
\begin_inset Quotes erd
4473+
\end_inset
4474+
4475+
, and closed polylines may be called
4476+
\begin_inset Quotes eld
4477+
\end_inset
4478+
4479+
linear rings
4480+
\begin_inset Quotes erd
4481+
\end_inset
4482+
4483+
.
4484+
The openness can be given as an option is some functions in the module.
44634485
\end_layout
44644486

44654487
\begin_layout Standard
44664488
\begin_inset Float figure
44674489
wide false
44684490
sideways false
4469-
status collapsed
4491+
status open
44704492

44714493
\begin_layout Plain Layout
44724494
\align center
@@ -4545,7 +4567,7 @@ name "fig:Polyline-and-Polygon"
45454567
\end_inset
45464568

45474569
Example of polyline and polygon.
4548-
(a) A polyline defined by a series of vertices.
4570+
(a) An open polyline defined by a series of vertices.
45494571
(b) The corresponding (counter-clockwise oriented) polygon, with interior
45504572
coloured in light blue.
45514573
\end_layout
@@ -4585,25 +4607,22 @@ noprefix "false"
45854607
complex polygons
45864608
\series default
45874609
', whose boundary is composed of several disjoint domains.
4588-
The domain enclosed by a single closed polyline is called '
4610+
The domain enclosed by a single closed polyline (or linear ring) is called
4611+
'
45894612
\series bold
45904613
simple polygon
45914614
\series default
45924615
'.
4593-
Its boundary is called a '
4594-
\series bold
4595-
linear ring
4596-
\series default
4597-
'.
4616+
45984617
\end_layout
45994618

46004619
\begin_layout Standard
4601-
We call
4620+
Within MatGeom, a
46024621
\series bold
46034622
curve
46044623
\series default
4605-
a polyline with many vertices, such that the polyline can be considered
4606-
as a discrete approximation of a "real" curve.
4624+
has to be understood as a polyline with many vertices, such that the polyline
4625+
can be considered as a discrete approximation of a smooth curve.
46074626
\end_layout
46084627

46094628
\begin_layout Subsection
@@ -5874,8 +5893,8 @@ name "fig:Smooth-Simplify-Polygon"
58745893
\end_inset
58755894

58765895
Smoothing and simplification of a polygon.
5877-
After simplification by a distance equal to 5, the number if vertices drops
5878-
from 2235 to 60.
5896+
After simplification by a distance equal to 5 (arbitrary unit), the number
5897+
of vertices drops from 2235 (blue curve) to 60 (red line and squares).
58795898
\end_layout
58805899

58815900
\end_inset
@@ -6361,16 +6380,73 @@ wide false
63616380
sideways false
63626381
status open
63636382

6383+
\begin_layout Plain Layout
6384+
\align center
6385+
\begin_inset Float figure
6386+
wide false
6387+
sideways false
6388+
status open
6389+
63646390
\begin_layout Plain Layout
63656391
\align center
63666392
\begin_inset Graphics
6367-
filename images/graphs/graph_def.png
6393+
filename images/graphs/graph_def/graph_adj_list.png
63686394
lyxscale 50
6369-
width 33text%
6395+
width 15text%
63706396

63716397
\end_inset
63726398

63736399

6400+
\end_layout
6401+
6402+
\begin_layout Plain Layout
6403+
\begin_inset Caption Standard
6404+
6405+
\begin_layout Plain Layout
6406+
Adjacency list.
6407+
\end_layout
6408+
6409+
\end_inset
6410+
6411+
6412+
\end_layout
6413+
6414+
\end_inset
6415+
6416+
6417+
\begin_inset Float figure
6418+
wide false
6419+
sideways false
6420+
status open
6421+
6422+
\begin_layout Plain Layout
6423+
\align center
6424+
\begin_inset Graphics
6425+
filename images/graphs/graph_def/graph_def.png
6426+
lyxscale 50
6427+
width 35text%
6428+
rotateOrigin centerTop
6429+
6430+
\end_inset
6431+
6432+
6433+
\end_layout
6434+
6435+
\begin_layout Plain Layout
6436+
\begin_inset Caption Standard
6437+
6438+
\begin_layout Plain Layout
6439+
Graphical representation.
6440+
\end_layout
6441+
6442+
\end_inset
6443+
6444+
6445+
\end_layout
6446+
6447+
\end_inset
6448+
6449+
63746450
\end_layout
63756451

63766452
\begin_layout Plain Layout
@@ -6384,6 +6460,9 @@ name "fig:Sample-Graph"
63846460
\end_inset
63856461

63866462
Sample graph containing six vertices and seven edges.
6463+
(a) Representation of the graph through an adjacency list.
6464+
(b) Graphical representation by associating vertices to positions on the
6465+
plane.
63876466
\end_layout
63886467

63896468
\end_inset
@@ -6397,7 +6476,7 @@ Sample graph containing six vertices and seven edges.
63976476
\end_layout
63986477

63996478
\begin_layout Standard
6400-
Within MatGeom, graphs are represented by two variables:
6479+
Within MatGeom, graphs are represented with two variables:
64016480
\end_layout
64026481

64036482
\begin_layout Description

0 commit comments

Comments
 (0)