songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Doc fixes

This commit is contained in:
Mael Rouxel-Labbé 2023-04-11 09:57:36 +02:00
parent 70ac415808
commit 0f9983b036
2 changed files with 10 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/PolygonOffsetBuilderTraits_2.h
View File

@ -20,7 +20,10 @@ public:
/*! /*!
A predicate object type. A predicate object type.
Must provide `Comparison_result operator()( FT d, const Trisegment_2_ptr& et) const`, Must provide
`Comparison_result operator()( FT d, const Trisegment_2_ptr& et) const`,
which compares the Euclidean distance `d` with the event time for `et`. Such event time which compares the Euclidean distance `d` with the event time for `et`. Such event time
is the Euclidean distance at which the <I>offset lines</I> intersect in a single point. is the Euclidean distance at which the <I>offset lines</I> intersect in a single point.
The source of such offset lines is given by the three <I>oriented</I> lines defined by the edge-triple `et`. The source of such offset lines is given by the three <I>oriented</I> lines defined by the edge-triple `et`.
@ -33,7 +36,10 @@ typedef unspecified_type Compare_offset_against_event_time_2;
/*! /*!
A construction object type. A construction object type.
Must provide `boost::optional<Point_2> operator()(const FT& t, const Segment_2& e0, const Segment_2& e1, const Trisegment_2_ptr& et) const`, Must provide
`boost::optional<Point_2> operator()(const FT& t, const Segment_2& e0, const Segment_2& e1, const Trisegment_2_ptr& et) const`,
which constructs the point of intersection of the lines obtained by offsetting which constructs the point of intersection of the lines obtained by offsetting
the oriented lines given by `e0` and `e0` an Euclidean distance `t`. the oriented lines given by `e0` and `e0` an Euclidean distance `t`.

12
Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonBuilderTraits_2.h
View File

@ -123,12 +123,7 @@ typedef unspecified_type Construct_ss_event_time_and_point_2;
/*! /*!
A construction object type. A construction object type.
Must provide `Trisegment_2_ptr operator()( const Segment_2& e0, Must provide `Trisegment_2_ptr operator()( const Segment_2& e0, const FT& w0, const Segment_2& e1, const FT& w1, const Segment_2& e2, const FT& w2 ) const`,
const FT& w0,
const Segment_2& e1,
const FT& w1,
const Segment_2& e2,
const FT& w2 ) const`,
which returns an intrusive pointer to an object containing the three <I>oriented</I> lines which returns an intrusive pointer to an object containing the three <I>oriented</I> lines
defined by the three input edges. defined by the three input edges.
@ -160,10 +155,7 @@ A predicate object type.
Must provide Must provide
`CGAL::Oriented_side operator()( const Trisegment_2_ptr& e, `CGAL::Oriented_side operator()( const Trisegment_2_ptr& e, const Segment_2& e0, const FT& w0, const Segment_2& e1, const FT& w1, const Trisegment_2_ptr& e01_event, bool e0_is_primary) const`,
const Segment_2& e0, const FT& w0,
const Segment_2& e1, const FT& w1,
const Trisegment_2_ptr& e01_event, bool e0_is_primary) const`,
which returns the oriented side of the event point described by the edge triple `e` which returns the oriented side of the event point described by the edge triple `e`
w.r.t. the (positive) bisector `[e0,e1]`. w.r.t. the (positive) bisector `[e0,e1]`.