remove trailing whitespaces

This commit is contained in:
Sébastien Loriot 2020-04-10 18:15:32 +02:00
parent e2df1a83aa
commit 2876ad9af1
11 changed files with 1109 additions and 1109 deletions

View File

@ -65,40 +65,40 @@ struct Incrementer {
// provides an iterator over the cells intersected by a line segment. // provides an iterator over the cells intersected by a line segment.
/* /*
* The `Triangulation_segment_traverser_3` iterates over the cells * The `Triangulation_segment_traverser_3` iterates over the cells
* of a `Triangulation_3` by following a straight line segment \f$ st \f$. * of a `Triangulation_3` by following a straight line segment \f$ st \f$.
* *
* This class is closely related to `Triangulation_3::locate(...)`. * This class is closely related to `Triangulation_3::locate(...)`.
* However, unlike this `locate(...)` method, all the cells traversed * However, unlike this `locate(...)` method, all the cells traversed
* by the `Triangulation_segment_traverser_3` intersect the interior of the line * by the `Triangulation_segment_traverser_3` intersect the interior of the line
* segment \f$ st \f$. * segment \f$ st \f$.
* *
* Traversal starts from a cell containing \f$ s \f$ and it ends in a cell containing * Traversal starts from a cell containing \f$ s \f$ and it ends in a cell containing
* \f$ t \f$. * \f$ t \f$.
* If \f$ st \f$ is coplanar with a facet or collinear with an edge, at most one of the * If \f$ st \f$ is coplanar with a facet or collinear with an edge, at most one of the
* incident cells is traversed. * incident cells is traversed.
* If \f$ st \f$ intersects an edge or vertex, at most two incident cells are traversed: * If \f$ st \f$ intersects an edge or vertex, at most two incident cells are traversed:
* the cells intersected by \f$ st \f$ strictly in their interior. * the cells intersected by \f$ st \f$ strictly in their interior.
* *
* If \f$ s \f$ lies on the convex hull, traversal starts in an incident cell inside * If \f$ s \f$ lies on the convex hull, traversal starts in an incident cell inside
* the convex hull. Similarly, if \f$ t \f$ lies on the convex hull, traversal ends in * the convex hull. Similarly, if \f$ t \f$ lies on the convex hull, traversal ends in
* an adjacent cell inside the convex hull. * an adjacent cell inside the convex hull.
* *
* Both \f$ s \f$ and \f$ t \f$ may lie outside the convex hull of the triangulation, * Both \f$ s \f$ and \f$ t \f$ may lie outside the convex hull of the triangulation,
* but they must lie within the affine hull of the triangulation. In either case, the * but they must lie within the affine hull of the triangulation. In either case, the
* finite facet of any infinite cells traversed must intersect \f$ st \f$. * finite facet of any infinite cells traversed must intersect \f$ st \f$.
* *
* The traverser may be applied to any triangulation of dimension > 0. * The traverser may be applied to any triangulation of dimension > 0.
* However, for triangulations of dimension 1, the functionality is somewhat trivial. * However, for triangulations of dimension 1, the functionality is somewhat trivial.
* *
* The traverser becomes invalid whenever the triangulation is changed. * The traverser becomes invalid whenever the triangulation is changed.
* *
* \tparam Tr_ is the triangulation type to traverse. * \tparam Tr_ is the triangulation type to traverse.
* *
* \cgalModels{ForwardIterator} * \cgalModels{ForwardIterator}
* *
* \sa `Triangulation_3` * \sa `Triangulation_3`
* \sa `Forward_circulator_base` * \sa `Forward_circulator_base`
*/ */
template < class Tr_, class Inc = internal::Incrementer<Tr_> > template < class Tr_, class Inc = internal::Incrementer<Tr_> >
class Triangulation_segment_cell_iterator_3 class Triangulation_segment_cell_iterator_3
@ -172,44 +172,44 @@ public:
// \{ // \{
// constructs an iterator. // constructs an iterator.
/* \param tr the triangulation to iterate though. This triangulation must have dimension > 0. /* \param tr the triangulation to iterate though. This triangulation must have dimension > 0.
* \param s the source vertex. This vertex must be initialized and cannot be the infinite vertex. * \param s the source vertex. This vertex must be initialized and cannot be the infinite vertex.
* \param t the target vertex. This vertex must be initialized and cannot be the infinite vertex. * \param t the target vertex. This vertex must be initialized and cannot be the infinite vertex.
* It cannot equal `s`. * It cannot equal `s`.
*/ */
Triangulation_segment_cell_iterator_3( const Tr* tr, Vertex_handle s, Vertex_handle t ); Triangulation_segment_cell_iterator_3( const Tr* tr, Vertex_handle s, Vertex_handle t );
// constructs an iterator. // constructs an iterator.
/* \param tr the triangulation to iterate though. This triangulation must have dimension > 0. /* \param tr the triangulation to iterate though. This triangulation must have dimension > 0.
* \param s the source vertex. This vertex must be initialized and cannot be the infinite vertex. * \param s the source vertex. This vertex must be initialized and cannot be the infinite vertex.
* \param t the target point. This point must be initialized and it cannot be be at the same location as `s`. * \param t the target point. This point must be initialized and it cannot be be at the same location as `s`.
* If `tr` has dimension < 3, `t` must lie inside the affine hull of `tr`. * If `tr` has dimension < 3, `t` must lie inside the affine hull of `tr`.
*/ */
Triangulation_segment_cell_iterator_3( const Tr* tr, Vertex_handle s, const Point& t ); Triangulation_segment_cell_iterator_3( const Tr* tr, Vertex_handle s, const Point& t );
// constructs an iterator. // constructs an iterator.
/* \param tr the triangulation to iterate though. This triangulation must have dimension > 0. /* \param tr the triangulation to iterate though. This triangulation must have dimension > 0.
* \param s the source point. This point must be initialized and it cannot be be at the same location as `t`. * \param s the source point. This point must be initialized and it cannot be be at the same location as `t`.
* \param t the target vertex. This vertex must be initialized and cannot be the infinite vertex. * \param t the target vertex. This vertex must be initialized and cannot be the infinite vertex.
* If `tr` has dimension < 3, `s` must lie inside the affine hull of `tr`. * If `tr` has dimension < 3, `s` must lie inside the affine hull of `tr`.
* \param hint the starting point to search for `s`. * \param hint the starting point to search for `s`.
*/ */
Triangulation_segment_cell_iterator_3( const Tr* tr, const Point& s, Vertex_handle t, Cell_handle hint = Cell_handle() ); Triangulation_segment_cell_iterator_3( const Tr* tr, const Point& s, Vertex_handle t, Cell_handle hint = Cell_handle() );
// constructs an iterator. // constructs an iterator.
/* \param tr the triangulation to iterate though. This triangulation must have dimension > 0. /* \param tr the triangulation to iterate though. This triangulation must have dimension > 0.
* \param s the source point. This point must be initialized. If `tr` has dimension < 3, `s` must lie inside * \param s the source point. This point must be initialized. If `tr` has dimension < 3, `s` must lie inside
* the affine hull of `tr`. * the affine hull of `tr`.
* \param t the target point. This point must be initialized and it cannot be be at the same location as `s`. * \param t the target point. This point must be initialized and it cannot be be at the same location as `s`.
* If `tr` has dimension < 3, `t` must lie inside the affine hull of `tr`. * If `tr` has dimension < 3, `t` must lie inside the affine hull of `tr`.
* \param hint the starting point to search for `s`. * \param hint the starting point to search for `s`.
*/ */
Triangulation_segment_cell_iterator_3( const Tr* tr, const Point& s, const Point& t, Cell_handle hint = Cell_handle() ); Triangulation_segment_cell_iterator_3( const Tr* tr, const Point& s, const Point& t, Cell_handle hint = Cell_handle() );
// constructs an iterator. // constructs an iterator.
/* \param tr the triangulation to iterate though. This triangulation must have dimension > 0. /* \param tr the triangulation to iterate though. This triangulation must have dimension > 0.
* \param S the segment to be traversed. If `tr` has dimension < 3, `S` must lie inside * \param S the segment to be traversed. If `tr` has dimension < 3, `S` must lie inside
* the affine hull of `tr`. `S` must not be degenerate, i.e. its source and target must not be equal. * the affine hull of `tr`. `S` must not be degenerate, i.e. its source and target must not be equal.
* \param hint the starting point to search for `S`. * \param hint the starting point to search for `S`.
*/ */
Triangulation_segment_cell_iterator_3( const Tr* tr, const Segment& S, Cell_handle hint = Cell_handle() ); Triangulation_segment_cell_iterator_3( const Tr* tr, const Segment& S, Cell_handle hint = Cell_handle() );
// \} // \}
@ -239,15 +239,15 @@ public:
// gives the target point of the segment follwoed. // gives the target point of the segment follwoed.
/* \return the target point. /* \return the target point.
*/ */
const Point& target() const { return _target; } const Point& target() const { return _target; }
// gives a handle to the current cell. // gives a handle to the current cell.
/* By invariance, this cell is intersected by the segment /* By invariance, this cell is intersected by the segment
* between `source()` and `target()`. * between `source()` and `target()`.
* \return a handle to the current cell. * \return a handle to the current cell.
* \sa `cell()`. * \sa `cell()`.
*/ */
Cell_handle handle() Cell_handle handle()
{ {
return std::get<0>(_cur); return std::get<0>(_cur);
@ -255,20 +255,20 @@ public:
// gives the previous cell. // gives the previous cell.
/* This cell is uninitialized until the iterator leaves the initial /* This cell is uninitialized until the iterator leaves the initial
* cell. * cell.
* By invariance, once initialized, this cell must be intersected by the segment * By invariance, once initialized, this cell must be intersected by the segment
* between `source()` and `target()`. * between `source()` and `target()`.
* \return the previous cell. * \return the previous cell.
* \sa `handle()`. * \sa `handle()`.
*/ */
Cell_handle previous() const Cell_handle previous() const
{ {
return prev_cell(); return prev_cell();
} }
// provides a dereference operator. // provides a dereference operator.
/* \return a pointer to the current cell. /* \return a pointer to the current cell.
*/ */
Cell* operator->() Cell* operator->()
{ {
return &*std::get<0>(_cur); return &*std::get<0>(_cur);
@ -276,46 +276,46 @@ public:
// provides an indirection operator. // provides an indirection operator.
/* \return the current cell. /* \return the current cell.
*/ */
Cell& operator*() Cell& operator*()
{ {
return *std::get<0>(_cur); return *std::get<0>(_cur);
} }
// provides a conversion operator. // provides a conversion operator.
/* \return a handle to the current cell. /* \return a handle to the current cell.
*/ */
operator const Cell_handle() const operator const Cell_handle() const
{ {
return std::get<0>(_cur); return std::get<0>(_cur);
} }
// provides a conversion operator. // provides a conversion operator.
/* \return the simplex through wich the current cell was entered. /* \return the simplex through wich the current cell was entered.
*/ */
operator const Simplex() const { return _cur; } operator const Simplex() const { return _cur; }
// checks whether the iterator has reached the final cell, which contains the `target()`. // checks whether the iterator has reached the final cell, which contains the `target()`.
/* If the `target()` lies on a facet, edge, or vertex, the final cell is the cell containing /* If the `target()` lies on a facet, edge, or vertex, the final cell is the cell containing
* the interior of the segment between `source()` and `target()`. * the interior of the segment between `source()` and `target()`.
* \return true iff the current cell contains the `target()`. * \return true iff the current cell contains the `target()`.
*/ */
bool has_next() const bool has_next() const
{ {
return this->cell() != Cell_handle(); return this->cell() != Cell_handle();
} }
// gives the simplex through which the current cell was entered. // gives the simplex through which the current cell was entered.
/* For the first cell, containing the `source()` \f$ s \f$, /* For the first cell, containing the `source()` \f$ s \f$,
* this indicates the location of \f$ s \f$ in this cell. * this indicates the location of \f$ s \f$ in this cell.
*/ */
void entry( Locate_type& lt, int& li, int& lj ) const void entry( Locate_type& lt, int& li, int& lj ) const
{ {
lt = this->lt(); li = this->li(); lj = this->lj(); lt = this->lt(); li = this->li(); lj = this->lj();
} }
// gives the simplex through which the previous cell was exited. // gives the simplex through which the previous cell was exited.
/* \pre the current cell is not the initial cell. /* \pre the current cell is not the initial cell.
*/ */
void exit( Locate_type& lt, int& li, int& lj ) const void exit( Locate_type& lt, int& li, int& lj ) const
{ {
lt = prev_lt(); li = prev_li(); lj = prev_lj(); lt = prev_lt(); li = prev_li(); lj = prev_lj();
@ -329,24 +329,24 @@ public:
// \name Mutators // \name Mutators
// \{ // \{
// provides the increment postfix operator. // provides the increment postfix operator.
/* After incrementing the iterator, the current cell intersects the segment /* After incrementing the iterator, the current cell intersects the segment
* between `source()` and `target()` closer to the `target()` than the previous cell. * between `source()` and `target()` closer to the `target()` than the previous cell.
* \sa `operator++(int)`. * \sa `operator++(int)`.
* \pre The current cell does not contain the `target()`. * \pre The current cell does not contain the `target()`.
*/ */
SCI& operator++(); SCI& operator++();
// provides the increment prefix operator. // provides the increment prefix operator.
/* After incrementing the iterator, the current cell intersects the segment /* After incrementing the iterator, the current cell intersects the segment
* between `source()` and `target()` closer to the `target()` than the previous cell. * between `source()` and `target()` closer to the `target()` than the previous cell.
* than the previous cell. * than the previous cell.
* \sa `operator++()`. * \sa `operator++()`.
* \pre The current cell does not contain the `target()`. * \pre The current cell does not contain the `target()`.
*/ */
SCI operator++( int ); SCI operator++( int );
// iterates to the final cell, which contains the `target()`. // iterates to the final cell, which contains the `target()`.
/* \return the final cell. /* \return the final cell.
*/ */
Cell_handle complete(); Cell_handle complete();
// \} // \}
@ -356,25 +356,25 @@ public:
// \{ // \{
// compares this iterator with `sci`. // compares this iterator with `sci`.
/* \param sci the other iterator. /* \param sci the other iterator.
* \return true iff the other iterator iterates the same triangulation along the same line segment * \return true iff the other iterator iterates the same triangulation along the same line segment
* and has the same current cell. * and has the same current cell.
* \sa `operator!=( const SCI& t )`. * \sa `operator!=( const SCI& t )`.
*/ */
bool operator==( const SCI& sci ) const; bool operator==( const SCI& sci ) const;
// compares this iterator with `sci`. // compares this iterator with `sci`.
/* \param sci the other iterator. /* \param sci the other iterator.
* \return `false` iff the other iterator iterates the same triangulation along the same line segment * \return `false` iff the other iterator iterates the same triangulation along the same line segment
* and has the same current cell. * and has the same current cell.
* \sa `operator==( const SCI& t ) const`. * \sa `operator==( const SCI& t ) const`.
*/ */
bool operator!=( const SCI& sci ) const; bool operator!=( const SCI& sci ) const;
// compares the current cell with `ch`. // compares the current cell with `ch`.
/* \param ch a handle to the other cell. /* \param ch a handle to the other cell.
* \return true iff the current cell is the same as the one pointed to by `ch`. * \return true iff the current cell is the same as the one pointed to by `ch`.
* \sa `operator!=( const Cell_handle& ch ) const`. * \sa `operator!=( const Cell_handle& ch ) const`.
* \sa `operator==( typename TriangulationTraits_3::Cell_handle ch, Triangulation_segment_cell_iterator_3<TriangulationTraits_3> t )`. * \sa `operator==( typename TriangulationTraits_3::Cell_handle ch, Triangulation_segment_cell_iterator_3<TriangulationTraits_3> t )`.
*/ */
bool operator==( const Cell_handle& ch ) const bool operator==( const Cell_handle& ch ) const
{ {
@ -383,9 +383,9 @@ public:
// compares the current cell with `ch`. // compares the current cell with `ch`.
/* \param ch a handle to the other cell. /* \param ch a handle to the other cell.
* \return `false` iff the current cell is the same as the one pointed to by `ch`. * \return `false` iff the current cell is the same as the one pointed to by `ch`.
* \sa `operator==( const Cell_handle& ch )`. * \sa `operator==( const Cell_handle& ch )`.
* \sa `operator!=( typename TriangulationTraits_3::Cell_handle ch, Triangulation_segment_cell_iterator_3<TriangulationTraits_3> t )`. * \sa `operator!=( typename TriangulationTraits_3::Cell_handle ch, Triangulation_segment_cell_iterator_3<TriangulationTraits_3> t )`.
*/ */
bool operator!=( const Cell_handle& ch ) const bool operator!=( const Cell_handle& ch ) const
{ {
@ -393,21 +393,21 @@ public:
} }
// \} // \}
bool operator==( Nullptr_t CGAL_triangulation_assertion_code(n) ) const; bool operator==( Nullptr_t CGAL_triangulation_assertion_code(n) ) const;
bool operator!=( Nullptr_t n ) const; bool operator!=( Nullptr_t n ) const;
protected: protected:
// \internal \name Protected Member Functions // \internal \name Protected Member Functions
// \{ // \{
// walks to the next cell. // walks to the next cell.
/* \sa `complete()`. /* \sa `complete()`.
*/ */
void walk_to_next(); void walk_to_next();
// increments the iterator. // increments the iterator.
/* This method may perform more actions based on the superclass. /* This method may perform more actions based on the superclass.
* \sa `complete()`. * \sa `complete()`.
*/ */
void increment() { void increment() {
typedef typename Incrementer::SCI Expected; typedef typename Incrementer::SCI Expected;
#ifdef CGAL_TST_ASSUME_CORRECT_TYPES #ifdef CGAL_TST_ASSUME_CORRECT_TYPES
@ -484,20 +484,20 @@ private:
// compares a handle to a cell to a traverser. // compares a handle to a cell to a traverser.
/* \param ch the handle to a cell. /* \param ch the handle to a cell.
* \param t the traverser. * \param t the traverser.
* \return true iff the cell currently traversed by `t` is the same as the one pointed to by `ch`. * \return true iff the cell currently traversed by `t` is the same as the one pointed to by `ch`.
* \sa `operator!=( typename TriangulationTraits_3::Cell_handle ch, Triangulation_segment_cell_iterator_3<TriangulationTraits_3> t )`. * \sa `operator!=( typename TriangulationTraits_3::Cell_handle ch, Triangulation_segment_cell_iterator_3<TriangulationTraits_3> t )`.
* \sa `Triangulation_segment_cell_iterator_3::operator==( const Cell_handle& ch )`. * \sa `Triangulation_segment_cell_iterator_3::operator==( const Cell_handle& ch )`.
*/ */
template < class Tr, class Inc > template < class Tr, class Inc >
inline bool operator==( typename Tr::Cell_handle ch, Triangulation_segment_cell_iterator_3<Tr,Inc> tci ) { return tci == ch; } inline bool operator==( typename Tr::Cell_handle ch, Triangulation_segment_cell_iterator_3<Tr,Inc> tci ) { return tci == ch; }
// compares a handle to a cell to a traverser. // compares a handle to a cell to a traverser.
/* \param ch the handle to a cell. /* \param ch the handle to a cell.
* \param t the traverser. * \param t the traverser.
* \return `false` iff the cell currently traversed by `t` is the same as the one pointed to by `ch`. * \return `false` iff the cell currently traversed by `t` is the same as the one pointed to by `ch`.
* \sa `operator==( typename TriangulationTraits_3::Cell_handle ch, Triangulation_segment_cell_iterator_3<TriangulationTraits_3> t )`. * \sa `operator==( typename TriangulationTraits_3::Cell_handle ch, Triangulation_segment_cell_iterator_3<TriangulationTraits_3> t )`.
* \sa `Triangulation_segment_cell_iterator_3::operator!=( const Cell_handle& ch )`. * \sa `Triangulation_segment_cell_iterator_3::operator!=( const Cell_handle& ch )`.
*/ */
template < class Tr, class Inc > template < class Tr, class Inc >
inline bool operator!=( typename Tr::Cell_handle ch, Triangulation_segment_cell_iterator_3<Tr,Inc> tci ) { return tci != ch; } inline bool operator!=( typename Tr::Cell_handle ch, Triangulation_segment_cell_iterator_3<Tr,Inc> tci ) { return tci != ch; }
@ -885,7 +885,7 @@ public:
} }
// provides a dereference operator. // provides a dereference operator.
/* \return a pointer to the current cell. /* \return a pointer to the current cell.
*/ */
const Simplex_3* operator->() { return &_curr_simplex; } const Simplex_3* operator->() { return &_curr_simplex; }