minor doc fixes, typos, misc.

Author: skramm

README.md

@@ -57,7 +57,7 @@ will print:
 [7,8]
 ```
 
-(Depending on your GCC version, you might need to add `--std::c++17` to the compiler call above.)
+(Depending on your GCC version, you might need to add `--std=c++17` to the compiler call above.)
 
 #### TRYME2:
 

docs/homog2d_manual.md

@@ -758,7 +758,8 @@ Circle c1( vpts);
 c1.set( vpts );
 ```
 See [showcase13](homog2d_showcase.md#sc13) for an example.
-It uses the Welzl algorithm, that require O(n) time and O(n) memory (recursive technique).
+It uses the [Welzl algorithm](https://en.wikipedia.org/wiki/Smallest-circle_problem),
+that require O(n) time and O(n) memory (recursive technique).
 The input container can be `std::vector`, `std::array`, or `std::list`.
 It requires a least 2 points in the container, and will throw if condition not met.
 
@@ -1101,11 +1102,14 @@ The minimum value for `nb` is 3 (will generate an equilateral triangle), the fun
 
 #### 3.4.12 - Offsetted polyline
 
-For closed Polyline objects, the member function `getOffsetPoly()` can compute a new polyline at a given distance.
+For closed Polyline objects, the member function `getOffsetPoly()` can compute a new polyline at a given distance, by using
+[parallel curves](https://en.wikipedia.org/wiki/Parallel_curve).
 Its argument is a distance (numerical value).
-If positive, the returned polyline will be "outside", if negative, il will be inside.
+If positive, the returned polyline will be "outside" the original one, if negative, il will be inside.
 
-An optional second argument of type `OffsetPolyParams` holds a boolean value `_angleSplit` that can be set to `true` to "smoothen" the return polyline, by adding some points on sharp angles
+The source polyline must be "simple" (closed, and no intersections).
+
+An optional second argument of type `OffsetPolyParams` holds a boolean value `_angleSplit` that can be set to `true` to "smoothen" the return polyline, by adding two points on sharp angles
 (applies only to "outside" computation).
 
 See [showcase 22](homog2d_showcase.md#sc22)
@@ -1197,7 +1201,8 @@ bool b2 = isCircle( ell, 1E-15 );
 ### 3.6 - Common functions
 <a name="p_commonf"></a>
 
-All the types above share some common functions, that are also declared as virtual in the root class `Root`.
+All the types above share some common member functions.
+These are also declared as virtual in the root class `Root`.
 Thus, this enables classical pointer-based runtime polymorphism, [see here](#section_rtp).
 
 All of these are `const`.
@@ -1213,7 +1218,7 @@ The names of these functions are:
 
 
 The `type()` function will return an enum value of type `Type` having one of these values:
-`Point2d`, `Line2d`, `Segment`, `FRect`, `Circle`, `Ellipse`, `OPolyline`, `CPolyline`.
+`Point2d`, `Line2d`, `Segment`, `OSegment`, `FRect`, `Circle`, `Ellipse`, `OPolyline`, `CPolyline`.
 You can get a human-readable value ot the object type with `getString(Type)`:
 ```C++
 	Point2d pt;
@@ -1228,7 +1233,7 @@ They are declared as `constexpr`, except of course for the last two.
 | Type         | Return Value |
 |--------------|--------------|
 | `Point2d`    |  1  |
-| `Line2d`     |  1  |
+| `Line2d`     |  0  |
 | `Segment`    |  2  |
 | `OSegment`   |  2  |
 | `FRect`      |  4  |

docs/index.csv

@@ -8,7 +8,7 @@ SVG import;manual;svg_import
 Showcase;showcase;
 Numerical data types;manual;numdt
 Segment;manual;p_segment
-Minimum Enclosing Circle;manual;minenccir
+Minimum Enclosing Circle (MEC);manual;minenccir
 Polygon Extremum points;manual;poly_extremum_points
 Convex Hull;manual;convex-hull-ff
 Polygon Rotation/mirroring;manual;polyline_rotate
@@ -26,3 +26,4 @@ Boost Geometry library;manual;boost_geom_1
 Opencv;manual;drawing
 SVG drawing;manual;drawing
 Rectangle union/intersection;manual;frect_union
+Welzl;manual;minenccir

docs/index.md

@@ -8,14 +8,15 @@
 * [Ellipse](homog2d_manual.md#p_ellipse)
 * [Homographies](homog2d_manual.md#matrix)
 * [Lines and Points](homog2d_manual.md#basic)
-* [Minimum Enclosing Circle](homog2d_manual.md#minenccir)
+* [Minimum Enclosing Circle (MEC)](homog2d_manual.md#minenccir)
 * [Numerical data types](homog2d_manual.md#numdt)
 * [Opencv](homog2d_manual.md#drawing)
 * [Parallelogram](homog2d_manual.md#build_parallelo)
 * [Polygon Extremum points](homog2d_manual.md#poly_extremum_points)
-* [Polygon](homog2d_manual.md#p_polyline)
 * [Polygon Rotation/mirroring](homog2d_manual.md#polyline_rotate)
+* [Polyline](homog2d_manual.md#p_polyline)
 * [Rectangle](homog2d_manual.md#p_frect)
+* [Rectangle union/intersection](homog2d_manual.md#frect_union)
 * [Regular Convex Polygon (RCP)](homog2d_manual.md#set_RCP)
 * [Runtime polymorphism](homog2d_manual.md#section_rtp)
 * [Segment](homog2d_manual.md#p_segment)
@@ -24,5 +25,6 @@
 * [SVG import](homog2d_manual.md#svg_import)
 * [Thresholds](homog2d_thresholds.md#)
 * [ttmath library](homog2d_manual.md#bignum)
+* [Welzl](homog2d_manual.md#minenccir)
 <hr>
-Page generated on 2024-04-21
+Page generated on 2025-02-24

misc/plot_line_count.plt

@@ -7,7 +7,7 @@
 # that is generated with the script: generate_line_count_graph.sh
 
 set datafile separator " "
-set terminal pngcairo size 900,600
+set terminal pngcairo size 1200,600
 set output "BUILD/line_count.png"
 
 #set terminal qt

misc/scripts/plot_tags_linecount.plt

@@ -19,6 +19,12 @@ set output "linecount.png"
 plot "/tmp/homog2d/tags_linecount.csv" using (column(2)/1000):xtic(1) with histogram ti "Library file", \
 	"" using (column(3)/1000):xtic(1) with histogram ti "Test file"
 
+set title "homog2d: Unit testing"
+set output "tests.png"
+plot "/tmp/homog2d/tags_linecount.csv" \
+	using (column(6)):xtic(1) with histogram ti "Nb test cases", \
+	"" using (column(7)/10):xtic(1) with histogram ti "Nb tests x10"
+
 set title "homog2d: KBytes per release"
 set output "bytecount.png"
 plot "/tmp/homog2d/tags_linecount.csv" using (column(4)/1000):xtic(1) with histogram ti "Library file", \

misc/scripts/tags_linecount.sh

@@ -26,7 +26,9 @@ do
 	c2=$(cat ${p}homog2d_test.cpp|wc -l)
 	c3=$(du --bytes homog2d.hpp | cut -f1)
 	c4=$(du --bytes ${p}homog2d_test.cpp | cut -f1)
-	echo "$t;$c1;$c2;$c3;$c4">>tags_linecount1.csv
+	c5=$(grep TEST_CASE ${p}homog2d_test.cpp | wc -l)
+	c6=$(grep CHECK ${p}homog2d_test.cpp | wc -l)
+	echo "$t;$c1;$c2;$c3;$c4;$c5;$c6">>tags_linecount1.csv
 done
 
 # -V: enables sorting by version number (i.e. v2.10 if AFTER v2.9)