CGAL 5.6.3 - 2D Arrangements

Loading...
Searching...
No Matches
List of all members
ArrTraits::CompareYOnBoundary_2 Concept Reference
2D Arrangement Reference » Concepts » Function Object Concepts

## Definition

Refines
  `AdaptableBinaryFunction`

Has Models:

  ArrangementClosedLeftTraits_2::Compare_y_on_boundary_2

  ArrangementClosedRightTraits_2::Compare_y_on_boundary_2

  ArrangementIdentifiedVerticalTraits_2::Compare_y_on_boundary_2

  ArrangementSphericalBoundaryTraits_2::Compare_y_on_boundary_2

## Operations
A model of this concept must provide:
Comparison_result | operator() (const ArrTraits::Point_2 &p1, const ArrTraits::Point_2 &p2)
| Given two points `p1` and `p2`, such that either `p1` or `p2` (or both) lie on the bottom or top boundary of the parameter space, compares the \( y\)-coordinate of `p1` and the \(y\)-coordinate of `p2`.

## Member Function Documentation

## ◆ operator()()

Comparison_result ArrTraits::CompareYOnBoundary_2::operator() | ( | const ArrTraits::Point_2 & | p1,
|  | const ArrTraits::Point_2 & | p2
| ) |  |

Given two points `p1` and `p2`, such that either `p1` or `p2` (or both) lie on the bottom or top boundary of the parameter space, compares the \( y\)-coordinate of `p1` and the \(y\)-coordinate of `p2`.

Returns `CGAL::SMALLER`, `CGAL::EQUAL`, or `CGAL::LARGER` accordingly.

Precondition
  `Parameter_space_in_x_2` (`p1`) \(\neq\) `CGAL::ARR_INTERIOR` or `Parameter_space_in_x_2` (`p2`) \(\neq\) `CGAL::ARR_INTERIOR`.