CGAL 6.1 - 2D Arrangements

Loading...
Searching...
No Matches
List of all members
AosTraits::CompareYOnBoundary_2 Concept Reference
Reference Manual » Concepts » Function Object Concepts

## Definition

Refines
  `AdaptableBinaryFunction`

Has models
  `AosClosedLeftTraits_2::Compare_y_on_boundary_2`
  `AosClosedRightTraits_2::Compare_y_on_boundary_2`
  `AosIdentifiedVerticalTraits_2::Compare_y_on_boundary_2`
  `AosSphericalBoundaryTraits_2::Compare_y_on_boundary_2`

## Operations
A model of this concept must provide:
Comparison_result | operator() (const AosTraits::Point_2 &p1, const AosTraits::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 AosTraits::CompareYOnBoundary_2::operator() | ( | const AosTraits::Point_2 & | p1,
|  | const AosTraits::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`.