Pangolin
Header-only C++20 plane computational geometry library
Loading...
Searching...
No Matches
pgl::Line< PointType_, TLabel > Struct Template Reference

Unoriented infinite line. More...

#include <line.hpp>

Inheritance diagram for pgl::Line< PointType_, TLabel >:
[legend]

Public Types

using PointType = PointType_
using NumberType = PointType::NumberType
using LabelType = TLabel
using CoordinateType = detail::promoted_number_t<NumberType>

Public Member Functions

constexpr Line ()=default
 Creates the degenerate line (0,0)--(0,0).
constexpr Line (PointType first, PointType second)
 Creates a line from two defining points.
constexpr Line (NumberType x1, NumberType y1, NumberType x2, NumberType y2)
 Creates a line from four coordinates.
template<class A>
requires (detail::has_label_v<LabelType> && std::constructible_from<LabelType, A&&>)
constexpr Line (PointType first, PointType second, A &&label)
 Creates a line from two defining points and stores a label.
template<class A>
requires (detail::has_label_v<LabelType> && std::constructible_from<LabelType, A&&>)
constexpr Line (NumberType x1, NumberType y1, NumberType x2, NumberType y2, A &&label)
 Same as the four-coordinate constructor, and stores a label.
template<PointConcept OtherPointType, class OtherLabelType>
requires (std::constructible_from<PointType, const OtherPointType&>)
constexpr Line (const Line< OtherPointType, OtherLabelType > &other)
 Converts a line with a different point and/or label type.
template<PointConcept OtherPointType, class OtherLabelType>
requires (std::constructible_from<PointType, const OtherPointType&>)
constexpr Lineoperator= (const Line< OtherPointType, OtherLabelType > &other)
 Assigns from a line with compatible point and label types.
constexpr const PointTypeoperator[] (std::size_t index) const
 Returns defining point 0 or 1.
constexpr const PointTypeget (std::ptrdiff_t index) const
 Cyclic access: same as operator[] but index is taken modulo size(); negative indices wrap from the end.
constexpr std::ptrdiff_t index (const PointType &point) const
 Returns the smallest index i with (*this)[i] == point, or -1 if no defining point equals point.
constexpr const PointTypemin () const
 Returns the smallest stored defining point.
constexpr const PointTypemax () const
 Returns the largest stored defining point.
constexpr auto begin () const
 Returns an iterator to the first defining point.
constexpr auto cbegin () const
 Returns an iterator to the first defining point.
constexpr auto end () const
 Returns an iterator past the last defining point.
constexpr auto cend () const
 Returns an iterator past the last defining point.
constexpr bool operator== (const Line &other) const
 Tests geometric equality of two lines.
template<AnyShapeConcept OtherShape>
constexpr bool samePointSet (const OtherShape &other) const
 Tests whether another shape defines exactly the same point set.
constexpr auto operator<=> (const Line &other) const
 Provides an ordering compatible with geometric equality.
template<class A = LabelType>
requires (detail::has_label_v<A>)
constexpr A & label () const
 Returns the line label.
template<PointConcept OtherPoint>
constexpr Segment< PointTypeasSegmentFor (const Rectangle< OtherPoint > &rect) const
 Returns the segment that intersects r the same way as this line.
constexpr HalfplaneIntersection< PointTypeasHalfplaneIntersection () const
 Returns the line as a (degenerate) half-plane intersection.
template<class ResultNumber = division_result_t<NumberType>>
constexpr Point< ResultNumber, typename PointType::LabelType > dual () const
 Returns the dual point.
template<class ResultNumber = division_result_t<NumberType>>
constexpr Point< ResultNumber, typename PointType::LabelType > polar () const
 Returns the polar point.
template<class ResultNumber = NumberType>
constexpr ResultNumber area () const
 Returns the area of the line.
constexpr NumberType twiceArea () const
 Returns twice the area of the line.
constexpr Line rotated90 (int k=1) const
 Returns the line rotated by 90k degrees around the origin.
constexpr void rotate90 (int k=1)
 Rotates the line by 90k degrees around the origin in place.
template<class OtherNumber>
constexpr Line scaledUpX (const OtherNumber scalar) const
 Returns the line with its x-coordinates multiplied by a factor.
template<class OtherNumber>
constexpr void scaleUpX (const OtherNumber scalar)
 Multiplies the line's x-coordinates by a factor in place.
template<class OtherNumber>
constexpr Line scaledUpY (const OtherNumber scalar) const
 Returns the line with its y-coordinates multiplied by a factor.
template<class OtherNumber>
constexpr void scaleUpY (const OtherNumber scalar)
 Multiplies the line's y-coordinates by a factor in place.
template<class OtherNumber>
constexpr Line scaledDownX (const OtherNumber scalar) const
 Returns the line with its x-coordinates divided by a divisor.
template<class OtherNumber>
constexpr void scaleDownX (const OtherNumber scalar)
 Divides the line's x-coordinates by a divisor in place.
template<class OtherNumber>
constexpr Line scaledDownY (const OtherNumber scalar) const
 Returns the line with its y-coordinates divided by a divisor.
template<class OtherNumber>
constexpr void scaleDownY (const OtherNumber scalar)
 Divides the line's y-coordinates by a divisor in place.
constexpr bool isDegenerate () const
 Returns whether the defining points coincide.
constexpr bool isUndefined () const
 Returns whether the line is degenerate without collapsing to a point or to a segment.
constexpr bool isVertical () const
 Returns whether the line is vertical.
constexpr bool isHorizontal () const
 Returns whether the line is horizontal.
template<PointConcept OtherPoint>
constexpr bool verticesContain (const OtherPoint &point) const
 Returns whether the given point is one of the stored defining points.
template<PointConcept OtherPoint>
constexpr bool boundaryContains (const OtherPoint &point) const
 Tests whether this shape's boundary contains the other shape (∂A ⊇ B).
template<SegmentConcept OtherSegment>
constexpr bool boundaryContains (const OtherSegment &) const
 Tests whether this shape's boundary contains the other shape (∂A ⊇ B).
template<OrientedSegmentConcept OtherOrientedSegment>
constexpr bool boundaryContains (const OtherOrientedSegment &) const
 Tests whether this shape's boundary contains the other shape (∂A ⊇ B).
template<LineConcept OtherLine>
constexpr bool boundaryContains (const OtherLine &) const
 Tests whether this shape's boundary contains the other shape (∂A ⊇ B).
template<OrientedLineConcept OtherOrientedLine>
constexpr bool boundaryContains (const OtherOrientedLine &) const
 Tests whether this shape's boundary contains the other shape (∂A ⊇ B).
template<RayConcept OtherRay>
constexpr bool boundaryContains (const OtherRay &) const
 Tests whether this shape's boundary contains the other shape (∂A ⊇ B).
template<HalfplaneConcept OtherHalfplane>
constexpr bool boundaryContains (const OtherHalfplane &) const
 Tests whether this shape's boundary contains the other shape (∂A ⊇ B).
template<RectangleConcept OtherRectangle>
constexpr bool boundaryContains (const OtherRectangle &) const
 Tests whether this shape's boundary contains the other shape (∂A ⊇ B).
template<TriangleConcept OtherTriangle>
constexpr bool boundaryContains (const OtherTriangle &) const
 Tests whether this shape's boundary contains the other shape (∂A ⊇ B).
template<ConvexConcept OtherConvex>
constexpr bool boundaryContains (const OtherConvex &) const
 Tests whether this shape's boundary contains the other shape (∂A ⊇ B).
template<PolygonConcept OtherPolygon>
constexpr bool boundaryContains (const OtherPolygon &) const
 Tests whether this shape's boundary contains the other shape (∂A ⊇ B).
template<DiskConcept OtherDisk>
constexpr bool boundaryContains (const OtherDisk &) const
 Tests whether this shape's boundary contains the other shape (∂A ⊇ B).
template<PointConcept OtherPoint>
constexpr bool contains (const OtherPoint &point) const
 Tests whether this shape contains the other shape (A ⊇ B).
template<LineConcept OtherLine>
constexpr bool contains (const OtherLine &other) const
 Tests whether this shape contains the other shape (A ⊇ B).
template<SegmentConcept OtherSegment>
constexpr bool contains (const OtherSegment &other) const
 Tests whether this shape contains the other shape (A ⊇ B).
template<OrientedSegmentConcept OtherOrientedSegment>
constexpr bool contains (const OtherOrientedSegment &other) const
 Tests whether this shape contains the other shape (A ⊇ B).
template<OrientedLineConcept OtherOrientedLine>
constexpr bool contains (const OtherOrientedLine &other) const
 Tests whether this shape contains the other shape (A ⊇ B).
template<RayConcept OtherRay>
constexpr bool contains (const OtherRay &other) const
 Tests whether this shape contains the other shape (A ⊇ B).
template<HalfplaneConcept OtherHalfplane>
constexpr bool contains (const OtherHalfplane &other) const
 Tests whether this shape contains the other shape (A ⊇ B).
template<RectangleConcept OtherRectangle>
constexpr bool contains (const OtherRectangle &other) const
 Tests whether this shape contains the other shape (A ⊇ B).
template<TriangleConcept OtherTriangle>
constexpr bool contains (const OtherTriangle &other) const
 Tests whether this shape contains the other shape (A ⊇ B).
template<ConvexConcept OtherConvex>
constexpr bool contains (const OtherConvex &other) const
 Tests whether this shape contains the other shape (A ⊇ B).
template<PolygonConcept OtherPolygon>
constexpr bool contains (const OtherPolygon &other) const
 Tests whether this shape contains the other shape (A ⊇ B).
template<DiskConcept OtherDisk>
constexpr bool contains (const OtherDisk &other) const
 Tests whether this shape contains the other shape (A ⊇ B).
constexpr bool contains (const Shape< PointType > &other) const
 Tests whether this shape contains the other shape (A ⊇ B).
constexpr bool boundaryContains (const Shape< PointType > &other) const
 Tests whether this shape's boundary contains the other shape (∂A ⊇ B).
template<class EmptyPoint>
constexpr bool contains (const EmptyShape< EmptyPoint > &) const
 Tests whether this shape contains the other shape (A ⊇ B).
template<class EmptyPoint>
constexpr bool boundaryContains (const EmptyShape< EmptyPoint > &) const
 Tests whether this shape's boundary contains the other shape (∂A ⊇ B).
template<class EmptyPoint>
constexpr bool interiorContains (const EmptyShape< EmptyPoint > &) const
 Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).
template<class EmptyPoint>
constexpr bool separates (const EmptyShape< EmptyPoint > &) const
 Tests whether removing this shape disconnects the other shape (B∖A is disconnected).
template<PointConcept OtherPoint>
constexpr bool interiorContains (const OtherPoint &point) const
 Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).
template<LineConcept OtherLine>
constexpr bool interiorContains (const OtherLine &other) const
 Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).
template<SegmentConcept OtherSegment>
constexpr bool interiorContains (const OtherSegment &other) const
 Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).
template<OrientedSegmentConcept OtherOrientedSegment>
constexpr bool interiorContains (const OtherOrientedSegment &other) const
 Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).
template<OrientedLineConcept OtherOrientedLine>
constexpr bool interiorContains (const OtherOrientedLine &other) const
 Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).
template<RayConcept OtherRay>
constexpr bool interiorContains (const OtherRay &other) const
 Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).
template<HalfplaneConcept OtherHalfplane>
constexpr bool interiorContains (const OtherHalfplane &other) const
 Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).
template<RectangleConcept OtherRectangle>
constexpr bool interiorContains (const OtherRectangle &other) const
 Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).
template<TriangleConcept OtherTriangle>
constexpr bool interiorContains (const OtherTriangle &other) const
 Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).
template<PointConcept OtherPoint>
constexpr bool collinear (const OtherPoint &point) const
 Returns whether the line interior contains the given point.
template<SegmentConcept OtherSegment>
constexpr bool collinear (const OtherSegment &other) const
 Returns whether the given segment is collinear with the line.
template<OrientedSegmentConcept OtherOrientedSegment>
constexpr bool collinear (const OtherOrientedSegment &other) const
 Returns whether the given oriented segment is collinear with the line.
template<LineConcept OtherLine>
constexpr bool collinear (const OtherLine &other) const
 Returns whether another line is collinear with this line.
template<OrientedLineConcept OtherOrientedLine>
constexpr bool collinear (const OtherOrientedLine &other) const
 Returns whether an oriented line is collinear with this line.
template<RayConcept OtherRay>
constexpr bool collinear (const OtherRay &other) const
 Returns whether a ray is collinear with this line.
template<class ResultNumber = division_result_t<NumberType>>
constexpr ResultNumber slope () const
 Returns the slope of the line.
template<class ResultNumber = division_result_t<NumberType>, class OtherNumber>
constexpr std::optional< ResultNumber > yAtX (const OtherNumber &x) const
 Returns the y-coordinate of the line at a given x-coordinate, if defined.
template<class ResultNumber = division_result_t<NumberType>, class OtherNumber>
constexpr std::optional< ResultNumber > xAtY (const OtherNumber &y) const
 Returns the x-coordinate of the line at a given y-coordinate, if defined.
constexpr Halfplane< PointTypehalfplaneAbove () const
 Returns the half-plane geometrically above this line.
constexpr Halfplane< PointTypehalfplaneBelow () const
 Returns the half-plane geometrically below this line.
template<LineConcept OtherLine>
constexpr bool parallel (const OtherLine &other) const
 Returns whether another line is parallel to this line.
template<SegmentConcept OtherSegment>
constexpr bool parallel (const OtherSegment &other) const
 Returns whether a segment is parallel to this line.
template<OrientedSegmentConcept OtherOrientedSegment>
constexpr bool parallel (const OtherOrientedSegment &other) const
 Returns whether an oriented segment is parallel to this line.
template<OrientedLineConcept OtherOrientedLine>
constexpr bool parallel (const OtherOrientedLine &other) const
 Returns whether an oriented line is parallel to this line.
template<RayConcept OtherRay>
constexpr bool parallel (const OtherRay &other) const
 Returns whether a ray is parallel to this line.
template<PointConcept OtherPoint>
constexpr bool intersects (const OtherPoint &other) const
 Tests whether this shape and the other shape intersect (A ∩ B ≠ ∅).
template<LineConcept OtherLine>
constexpr bool intersects (const OtherLine &other) const
 Tests whether this shape and the other shape intersect (A ∩ B ≠ ∅).
template<SegmentConcept OtherSegment>
constexpr bool intersects (const OtherSegment &other) const
 Tests whether this shape and the other shape intersect (A ∩ B ≠ ∅).
template<OrientedSegmentConcept OtherOrientedSegment>
constexpr bool intersects (const OtherOrientedSegment &other) const
 Tests whether this shape and the other shape intersect (A ∩ B ≠ ∅).
constexpr bool intersects (const Shape< PointType > &other) const
 Tests whether this shape and the other shape intersect (A ∩ B ≠ ∅).
template<typename OtherShape>
requires (!PointConcept<OtherShape> && detail::shapeRank<OtherShape> > detail::shapeRank<Line>)
constexpr bool intersects (const OtherShape &other) const
 Tests whether this shape and the other shape intersect (A ∩ B ≠ ∅).
template<class EmptyPoint>
constexpr bool intersects (const EmptyShape< EmptyPoint > &) const
 Tests whether this shape and the other shape intersect (A ∩ B ≠ ∅).
template<PointConcept OtherPoint>
constexpr bool interiorsIntersect (const OtherPoint &other) const
 Tests whether the interiors of the two shapes intersect ((A∖∂A) ∩ (B∖∂B) ≠ ∅).
template<LineConcept OtherLine>
constexpr bool interiorsIntersect (const OtherLine &other) const
 Tests whether the interiors of the two shapes intersect ((A∖∂A) ∩ (B∖∂B) ≠ ∅).
template<SegmentConcept OtherSegment>
constexpr bool interiorsIntersect (const OtherSegment &other) const
 Tests whether the interiors of the two shapes intersect ((A∖∂A) ∩ (B∖∂B) ≠ ∅).
template<OrientedSegmentConcept OtherOrientedSegment>
constexpr bool interiorsIntersect (const OtherOrientedSegment &other) const
 Tests whether the interiors of the two shapes intersect ((A∖∂A) ∩ (B∖∂B) ≠ ∅).
template<typename OtherShape>
requires (!PointConcept<OtherShape> && detail::shapeRank<OtherShape> > detail::shapeRank<Line>)
constexpr bool interiorsIntersect (const OtherShape &other) const
 Tests whether the interiors of the two shapes intersect ((A∖∂A) ∩ (B∖∂B) ≠ ∅).
template<class EmptyPoint>
constexpr bool interiorsIntersect (const EmptyShape< EmptyPoint > &) const
 Tests whether the interiors of the two shapes intersect ((A∖∂A) ∩ (B∖∂B) ≠ ∅).
constexpr bool interiorsIntersect (const Shape< PointType > &other) const
 Tests whether the interiors of the two shapes intersect ((A∖∂A) ∩ (B∖∂B) ≠ ∅).
template<LineConcept OtherLine>
constexpr bool crosses (const OtherLine &other) const
 Tests whether the two shapes mutually separate each other (each disconnects the other).
template<PointConcept OtherPoint>
constexpr bool crosses (const OtherPoint &other) const
 Tests whether the two shapes mutually separate each other (each disconnects the other).
template<SegmentConcept OtherSegment>
constexpr bool crosses (const OtherSegment &other) const
 Tests whether the two shapes mutually separate each other (each disconnects the other).
template<OrientedSegmentConcept OtherOrientedSegment>
constexpr bool crosses (const OtherOrientedSegment &other) const
 Tests whether the two shapes mutually separate each other (each disconnects the other).
template<typename OtherShape>
requires (!PointConcept<OtherShape> && detail::shapeRank<OtherShape> > detail::shapeRank<Line>)
constexpr bool crosses (const OtherShape &other) const
 Tests whether the two shapes mutually separate each other (each disconnects the other).
template<class EmptyPoint>
constexpr bool crosses (const EmptyShape< EmptyPoint > &) const
 Tests whether the two shapes mutually separate each other (each disconnects the other).
constexpr bool crosses (const Shape< PointType > &other) const
 Tests whether the two shapes mutually separate each other (each disconnects the other).
template<PointConcept OtherPoint>
constexpr bool separates (const OtherPoint &other) const
 Tests whether removing this shape disconnects the other shape (B∖A is disconnected).
template<SegmentConcept OtherSegment>
constexpr bool separates (const OtherSegment &other) const
 Tests whether removing this shape disconnects the other shape (B∖A is disconnected).
template<OrientedSegmentConcept OtherOrientedSegment>
constexpr bool separates (const OtherOrientedSegment &other) const
 Tests whether removing this shape disconnects the other shape (B∖A is disconnected).
template<LineConcept OtherLine>
constexpr bool separates (const OtherLine &other) const
 Tests whether removing this shape disconnects the other shape (B∖A is disconnected).
template<OrientedLineConcept OtherOrientedLine>
constexpr bool separates (const OtherOrientedLine &other) const
 Tests whether removing this shape disconnects the other shape (B∖A is disconnected).
template<RayConcept OtherRay>
constexpr bool separates (const OtherRay &other) const
 Tests whether removing this shape disconnects the other shape (B∖A is disconnected).
template<RectangleConcept OtherRectangle>
constexpr bool separates (const OtherRectangle &other) const
 Tests whether removing this shape disconnects the other shape (B∖A is disconnected).
template<TriangleConcept OtherTriangle>
constexpr bool separates (const OtherTriangle &other) const
 Tests whether removing this shape disconnects the other shape (B∖A is disconnected).
template<HalfplaneConcept OtherHalfplane>
constexpr bool separates (const OtherHalfplane &other) const
 Tests whether removing this shape disconnects the other shape (B∖A is disconnected).
template<ConvexConcept OtherConvex>
constexpr bool separates (const OtherConvex &other) const
 Tests whether removing this shape disconnects the other shape (B∖A is disconnected).
template<DiskConcept OtherDisk>
constexpr bool separates (const OtherDisk &other) const
 Tests whether removing this shape disconnects the other shape (B∖A is disconnected).
template<PolygonConcept OtherPolygon>
constexpr bool separates (const OtherPolygon &other) const
 Tests whether removing this shape disconnects the other shape (B∖A is disconnected).
template<MonotoneChainConcept OtherChain>
constexpr bool contains (const OtherChain &other) const
 Tests whether this shape contains the other shape (A ⊇ B).
template<MonotoneChainConcept OtherChain>
constexpr bool boundaryContains (const OtherChain &) const
 Tests whether this shape's boundary contains the other shape (∂A ⊇ B).
template<MonotoneChainConcept OtherChain>
constexpr bool interiorContains (const OtherChain &other) const
 Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).
template<MonotoneChainConcept OtherChain>
constexpr bool separates (const OtherChain &other) const
 Tests whether removing this shape disconnects the other shape (B∖A is disconnected).
template<PolylineConcept OtherPolyline>
constexpr bool contains (const OtherPolyline &other) const
 Tests whether this shape contains the other shape (A ⊇ B).
template<PolylineConcept OtherPolyline>
constexpr bool boundaryContains (const OtherPolyline &) const
 Tests whether this shape's boundary contains the other shape (∂A ⊇ B).
template<PolylineConcept OtherPolyline>
constexpr bool interiorContains (const OtherPolyline &other) const
 Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).
template<PolylineConcept OtherPolyline>
constexpr bool separates (const OtherPolyline &other) const
 Tests whether removing this shape disconnects the other shape (B∖A is disconnected).
template<HalfplaneIntersectionConcept OtherRegion>
constexpr bool contains (const OtherRegion &other) const
 Tests whether this shape contains the other shape (A ⊇ B).
template<HalfplaneIntersectionConcept OtherRegion>
constexpr bool boundaryContains (const OtherRegion &other) const
 Tests whether this shape's boundary contains the other shape (∂A ⊇ B).
template<HalfplaneIntersectionConcept OtherRegion>
constexpr bool interiorContains (const OtherRegion &other) const
 Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).
template<HalfplaneIntersectionConcept OtherRegion>
constexpr bool separates (const OtherRegion &other) const
 Tests whether removing this shape disconnects the other shape (B∖A is disconnected).
template<PolygonWithHolesConcept OtherRegion>
constexpr bool contains (const OtherRegion &other) const
 Tests whether this shape contains the other shape (A ⊇ B).
template<PolygonWithHolesConcept OtherRegion>
constexpr bool boundaryContains (const OtherRegion &other) const
 Tests whether this shape's boundary contains the other shape (∂A ⊇ B).
template<PolygonWithHolesConcept OtherRegion>
constexpr bool interiorContains (const OtherRegion &other) const
 Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).
template<PolygonWithHolesConcept OtherRegion>
bool separates (const OtherRegion &other) const
 Tests whether removing this shape disconnects the other shape (B∖A is disconnected).
template<PolygonSetConcept OtherSet>
constexpr bool contains (const OtherSet &other) const
 Tests whether this shape contains the other shape (A ⊇ B).
template<PolygonSetConcept OtherSet>
constexpr bool boundaryContains (const OtherSet &other) const
 Tests whether this shape's boundary contains the other shape (∂A ⊇ B).
template<PolygonSetConcept OtherSet>
constexpr bool interiorContains (const OtherSet &other) const
 Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).
template<PolygonSetConcept OtherSet>
bool separates (const OtherSet &other) const
 Tests whether removing this shape disconnects the other shape (B∖A is disconnected).
constexpr bool separates (const Shape< PointType > &other) const
 Tests whether removing this shape disconnects the other shape (B∖A is disconnected).
template<DiskConcept OtherDisk>
constexpr bool interiorContains (const OtherDisk &other) const
 Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).
template<ConvexConcept OtherConvex>
constexpr bool interiorContains (const OtherConvex &other) const
 Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).
template<PolygonConcept OtherPolygon>
constexpr bool interiorContains (const OtherPolygon &other) const
 Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).
template<class ResultNumber = NumberType, PointConcept OtherPoint>
constexpr std::optional< Point< ResultNumber, typename PointType::LabelType > > intersection (const OtherPoint &other) const
 Returns the intersection of the two shapes (A ∩ B), empty when they are disjoint.
template<class ResultNumber = division_result_t<NumberType>, LineConcept OtherLine>
constexpr std::optional< std::variant< Point< ResultNumber, typename PointType::LabelType >, Line< Point< ResultNumber, typename PointType::LabelType > > > > intersection (const OtherLine &other) const
 Returns the intersection of the two shapes (A ∩ B), empty when they are disjoint.
template<class ResultNumber = division_result_t<NumberType>, SegmentConcept OtherSegment>
constexpr auto intersection (const OtherSegment &other) const
 Returns the intersection of the two shapes (A ∩ B), empty when they are disjoint.
template<class ResultNumber = division_result_t<NumberType>, OrientedSegmentConcept OtherOrientedSegment>
constexpr auto intersection (const OtherOrientedSegment &other) const
 Returns the intersection of the two shapes (A ∩ B), empty when they are disjoint.
template<class ResultNumber = division_result_t<NumberType>, typename OtherShape>
requires (!PointConcept<OtherShape> && (detail::shapeRank<OtherShape> > detail::shapeRank<Line>) && requires(const OtherShape& o,
const Line& self) { o.template intersection<ResultNumber>(self); })
constexpr auto intersection (const OtherShape &other) const
 Returns the intersection of the two shapes (A ∩ B), empty when they are disjoint.
template<class ResultNumber = NumberType, class EmptyPoint>
constexpr EmptyShape< EmptyPoint > intersection (const EmptyShape< EmptyPoint > &) const
 Returns the intersection of the two shapes (A ∩ B), empty when they are disjoint.
template<class ResultNumber = division_result_t<NumberType>, PointConcept OtherPoint>
constexpr auto squaredDistance (const OtherPoint &point) const
 Returns the squared Euclidean distance to the given shape.
template<class ResultNumber = division_result_t<NumberType>, LineConcept OtherLine>
constexpr auto squaredDistance (const OtherLine &other) const
 Returns the squared Euclidean distance to the given shape.
template<class ResultNumber = division_result_t<NumberType>, SegmentConcept OtherSegment>
constexpr auto squaredDistance (const OtherSegment &other) const
 Returns the squared Euclidean distance to the given shape.
template<class ResultNumber = division_result_t<NumberType>, OrientedSegmentConcept OtherOrientedSegment>
constexpr auto squaredDistance (const OtherOrientedSegment &other) const
 Returns the squared Euclidean distance to the given shape.
template<class ResultNumber = division_result_t<NumberType>, typename OtherShape>
requires ((detail::shapeRank<OtherShape> > detail::shapeRank<Line>) && requires(const OtherShape& o, const Line& self)
{ o.template squaredDistance<ResultNumber>(self); })
constexpr auto squaredDistance (const OtherShape &other) const
 Returns the squared Euclidean distance to the given shape.
template<class ResultNumber = double, class DiskPointType, class DiskLabel>
detail::floating_result_t< ResultNumber > squaredDistance (const Disk< DiskPointType, DiskLabel > &disk) const
 Returns the squared Euclidean distance to a disk.
template<class ResultNumber = division_result_t<NumberType>, class OtherShape>
requires detail::ClosestPointsPairConcept<Line<PointType_, TLabel>, OtherShape>
constexpr auto closestPoints (const OtherShape &other) const
 Returns the pair of points realizing the distance, nothing when the shapes meet.
template<class ResultNumber = division_result_t<NumberType>, PointConcept OtherPoint>
constexpr auto distanceL1 (const OtherPoint &point) const
 Returns the Manhattan (L1) distance to the given shape.
template<class ResultNumber = division_result_t<NumberType>, LineConcept OtherLine>
constexpr auto distanceL1 (const OtherLine &other) const
 Returns the Manhattan (L1) distance to the given shape.
template<class ResultNumber = division_result_t<NumberType>, SegmentConcept OtherSegment>
constexpr auto distanceL1 (const OtherSegment &other) const
 Returns the Manhattan (L1) distance to the given shape.
template<class ResultNumber = division_result_t<NumberType>, OrientedSegmentConcept OtherOrientedSegment>
constexpr auto distanceL1 (const OtherOrientedSegment &other) const
 Returns the Manhattan (L1) distance to the given shape.
template<class ResultNumber = division_result_t<NumberType>, typename OtherShape>
requires ((detail::shapeRank<OtherShape> > detail::shapeRank<Line>) && requires(const OtherShape& o, const Line& self)
{ o.template distanceL1<ResultNumber>(self); })
constexpr auto distanceL1 (const OtherShape &other) const
 Returns the Manhattan (L1) distance to the given shape.
template<class ResultNumber = division_result_t<NumberType>, PointConcept OtherPoint>
constexpr auto intersection (const Shape< OtherPoint > &other) const
 Returns the intersection of the two shapes (A ∩ B), re-dispatching through the wrapper's own intersection.
template<class ResultNumber = double, PointConcept OtherPoint>
constexpr auto distanceL1 (const Shape< OtherPoint > &other) const
 Returns the distance to the given shape, using symmetry to re-dispatch through the wrapper's own distanceL1.
template<class ResultNumber = division_result_t<NumberType>, PointConcept OtherPoint>
constexpr auto distanceLInf (const OtherPoint &point) const
 Returns the Chebyshev (LInf) distance to the given shape.
template<class ResultNumber = division_result_t<NumberType>, LineConcept OtherLine>
constexpr auto distanceLInf (const OtherLine &other) const
 Returns the Chebyshev (LInf) distance to the given shape.
template<class ResultNumber = division_result_t<NumberType>, SegmentConcept OtherSegment>
constexpr auto distanceLInf (const OtherSegment &other) const
 Returns the Chebyshev (LInf) distance to the given shape.
template<class ResultNumber = division_result_t<NumberType>, OrientedSegmentConcept OtherOrientedSegment>
constexpr auto distanceLInf (const OtherOrientedSegment &other) const
 Returns the Chebyshev (LInf) distance to the given shape.
template<class ResultNumber = division_result_t<NumberType>, typename OtherShape>
requires ((detail::shapeRank<OtherShape> > detail::shapeRank<Line>) && requires(const OtherShape& o, const Line& self)
{ o.template distanceLInf<ResultNumber>(self); })
constexpr auto distanceLInf (const OtherShape &other) const
 Returns the Chebyshev (LInf) distance to the given shape.
template<class ResultNumber = double, PointConcept OtherPoint>
constexpr auto distanceLInf (const Shape< OtherPoint > &other) const
 Returns the distance to the given shape, using symmetry to re-dispatch through the wrapper's own distanceLInf.
template<class OtherShape>
requires MinkowskiSummableConcept<Line<PointType_, TLabel>, OtherShape>
constexpr auto minkowskiSum (const OtherShape &other) const
 Returns the Minkowski sum of this shape and another (A ⊕ B).
template<class OtherShape>
requires MinkowskiSummableConcept<Line<PointType_, TLabel>, OtherShape>
constexpr auto minkowskiErosion (const OtherShape &other) const
 Returns the Minkowski erosion of this shape by another (A ⊖ B).
template<PointConcept OtherPoint>
constexpr Lineoperator+= (const OtherPoint &translation)
 Translates both defining points in place.
template<PointConcept OtherPoint>
constexpr Lineoperator-= (const OtherPoint &translation)
 Translates both defining points by the opposite vector in place.
template<class Scalar>
requires (!detail::is_point_v<Scalar> && !TransformationConcept<Scalar>)
constexpr Lineoperator*= (const Scalar &scalar)
 Scales the line around the origin in place.
template<class Scalar>
requires (!detail::is_point_v<Scalar> && !TransformationConcept<Scalar>)
constexpr Lineoperator/= (const Scalar &scalar)
 Divides the line coordinates by a scalar in place.
template<class ResultNumber = NumberType>
constexpr Point< ResultNumber > pointInside () const
 Returns a point inside the line.
template<class OtherShape>
constexpr bool pointInsideInteriorContainedIn (const OtherShape &shape) const
 Tests whether some point in this shape's relative interior lies in the strict interior of shape.
template<class ResultNumber>
constexpr auto dualCoordinates () const
 Returns normalized dual-line coordinates for the supporting line.
template<PointConcept OtherPoint>
constexpr Line< PointType, LabelType > & operator+= (const OtherPoint &translation)
template<PointConcept OtherPoint>
constexpr Line< PointType, LabelType > & operator-= (const OtherPoint &translation)
template<class Scalar>
requires (!detail::is_point_v<Scalar> && !TransformationConcept<Scalar>)
constexpr Line< PointType, LabelType > & operator*= (const Scalar &scalar)
template<class Scalar>
requires (!detail::is_point_v<Scalar> && !TransformationConcept<Scalar>)
constexpr Line< PointType, LabelType > & operator/= (const Scalar &scalar)
template<class OtherNumber>
constexpr Line< PointType, LabelTypescaledUpX (const OtherNumber scalar) const
template<class OtherNumber>
constexpr Line< PointType, LabelTypescaledUpY (const OtherNumber scalar) const
template<class OtherNumber>
constexpr Line< PointType, LabelTypescaledDownX (const OtherNumber scalar) const
template<class OtherNumber>
constexpr Line< PointType, LabelTypescaledDownY (const OtherNumber scalar) const

Static Public Member Functions

static constexpr std::size_t size ()
 Returns the number of defining points (always 2).

Detailed Description

template<class PointType_, class TLabel>
struct pgl::Line< PointType_, TLabel >

Unoriented infinite line.

Infinite unoriented straight line.

Two non-degenerate lines compare equal whenever they contain exactly the same points, regardless of which two defining points were used to build them. The stored defining points are kept in increasing lexicographic order.

Template Parameters
PointTypeDefining point type.

Member Typedef Documentation

◆ CoordinateType

template<class PointType_, class TLabel>
using pgl::Line< PointType_, TLabel >::CoordinateType = detail::promoted_number_t<NumberType>

◆ LabelType

template<class PointType_, class TLabel>
using pgl::Line< PointType_, TLabel >::LabelType = TLabel

◆ NumberType

template<class PointType_, class TLabel>
using pgl::Line< PointType_, TLabel >::NumberType = PointType::NumberType

◆ PointType

template<class PointType_, class TLabel>
using pgl::Line< PointType_, TLabel >::PointType = PointType_

Constructor & Destructor Documentation

◆ Line() [1/6]

template<class PointType_, class TLabel>
pgl::Line< PointType_, TLabel >::Line ( )
constexprdefault

Creates the degenerate line (0,0)--(0,0).

◆ Line() [2/6]

template<class PointType_, class TLabel>
pgl::Line< PointType_, TLabel >::Line ( PointType first,
PointType second )
inlineconstexpr

Creates a line from two defining points.

The stored points are reordered so that min() <= max().

Parameters
firstFirst defining point.
secondSecond defining point.

◆ Line() [3/6]

template<class PointType_, class TLabel>
pgl::Line< PointType_, TLabel >::Line ( NumberType x1,
NumberType y1,
NumberType x2,
NumberType y2 )
inlineconstexpr

Creates a line from four coordinates.

Parameters
x1X coordinate of the first defining point.
y1Y coordinate of the first defining point.
x2X coordinate of the second defining point.
y2Y coordinate of the second defining point.

◆ Line() [4/6]

template<class PointType_, class TLabel>
template<class A>
requires (detail::has_label_v<LabelType> && std::constructible_from<LabelType, A&&>)
pgl::Line< PointType_, TLabel >::Line ( PointType first,
PointType second,
A && label )
inlineconstexpr

Creates a line from two defining points and stores a label.

The stored points are reordered so that min() <= max().

Template Parameters
AType convertible to LabelType.

◆ Line() [5/6]

template<class PointType_, class TLabel>
template<class A>
requires (detail::has_label_v<LabelType> && std::constructible_from<LabelType, A&&>)
pgl::Line< PointType_, TLabel >::Line ( NumberType x1,
NumberType y1,
NumberType x2,
NumberType y2,
A && label )
inlineconstexpr

Same as the four-coordinate constructor, and stores a label.

◆ Line() [6/6]

template<class PointType_, class TLabel>
template<PointConcept OtherPointType, class OtherLabelType>
requires (std::constructible_from<PointType, const OtherPointType&>)
pgl::Line< PointType_, TLabel >::Line ( const Line< OtherPointType, OtherLabelType > & other)
inlineconstexpr

Converts a line with a different point and/or label type.

The defining points are converted to PointType and re-sorted, and the label is copied when both sides carry one.

Member Function Documentation

◆ area()

template<class PointType, class LabelType>
template<class ResultNumber>
ResultNumber pgl::Line< PointType, LabelType >::area ( ) const
nodiscardconstexpr

Returns the area of the line.

A line is one-dimensional, so its area is always zero.

Template Parameters
ResultNumberResult type (default: NumberType).
Returns
Zero.

◆ asHalfplaneIntersection()

template<class PointType_, class TLabel>
HalfplaneIntersection< PointType > pgl::Line< PointType_, TLabel >::asHalfplaneIntersection ( ) const
inlinenodiscardconstexpr

Returns the line as a (degenerate) half-plane intersection.

A line is the intersection of the two opposite closed half-planes bounded by it, so the region has empty interior.

Returns
Half-plane intersection whose point set is this line.

◆ asSegmentFor()

template<class PointType_, class TLabel>
template<PointConcept OtherPoint>
Segment< PointType > pgl::Line< PointType_, TLabel >::asSegmentFor ( const Rectangle< OtherPoint > & rect) const
inlinenodiscardconstexpr

Returns the segment that intersects r the same way as this line.

Coordinates grow by at most 3 times the maximum coordinate of the defining points and no segment endpoint lies on the rectangle boundary. Complexity: O(1)

Returns
Segment that intersects the rectangle the same way as this line.
Parameters
rectRectangle to intersect with.
Template Parameters
OtherPointType of the rectangle's defining points.

◆ begin()

template<class PointType_, class TLabel>
auto pgl::Line< PointType_, TLabel >::begin ( ) const
inlineconstexpr

Returns an iterator to the first defining point.

Returns
Pointer to the first defining point.

◆ boundaryContains() [1/19]

template<class PointType_, class TLabel>
template<class EmptyPoint>
bool pgl::Line< PointType_, TLabel >::boundaryContains ( const EmptyShape< EmptyPoint > & ) const
inlinenodiscardconstexpr

Tests whether this shape's boundary contains the other shape (∂A ⊇ B).

◆ boundaryContains() [2/19]

template<class PointType_, class TLabel>
template<MonotoneChainConcept OtherChain>
bool pgl::Line< PointType_, TLabel >::boundaryContains ( const OtherChain & ) const
inlinenodiscardconstexpr

Tests whether this shape's boundary contains the other shape (∂A ⊇ B).

◆ boundaryContains() [3/19]

template<class PointType_, class TLabel>
template<ConvexConcept OtherConvex>
bool pgl::Line< PointType_, TLabel >::boundaryContains ( const OtherConvex & ) const
inlinenodiscardconstexpr

Tests whether this shape's boundary contains the other shape (∂A ⊇ B).

◆ boundaryContains() [4/19]

template<class PointType_, class TLabel>
template<DiskConcept OtherDisk>
bool pgl::Line< PointType_, TLabel >::boundaryContains ( const OtherDisk & ) const
inlinenodiscardconstexpr

Tests whether this shape's boundary contains the other shape (∂A ⊇ B).

◆ boundaryContains() [5/19]

template<class PointType_, class TLabel>
template<HalfplaneConcept OtherHalfplane>
bool pgl::Line< PointType_, TLabel >::boundaryContains ( const OtherHalfplane & ) const
inlinenodiscardconstexpr

Tests whether this shape's boundary contains the other shape (∂A ⊇ B).

◆ boundaryContains() [6/19]

template<class PointType_, class TLabel>
template<LineConcept OtherLine>
bool pgl::Line< PointType_, TLabel >::boundaryContains ( const OtherLine< PointType_, TLabel > & ) const
inlinenodiscardconstexpr

Tests whether this shape's boundary contains the other shape (∂A ⊇ B).

◆ boundaryContains() [7/19]

template<class PointType_, class TLabel>
template<OrientedLineConcept OtherOrientedLine>
bool pgl::Line< PointType_, TLabel >::boundaryContains ( const OtherOrientedLine< PointType_, TLabel > & ) const
inlinenodiscardconstexpr

Tests whether this shape's boundary contains the other shape (∂A ⊇ B).

◆ boundaryContains() [8/19]

template<class PointType_, class TLabel>
template<OrientedSegmentConcept OtherOrientedSegment>
bool pgl::Line< PointType_, TLabel >::boundaryContains ( const OtherOrientedSegment & ) const
inlinenodiscardconstexpr

Tests whether this shape's boundary contains the other shape (∂A ⊇ B).

◆ boundaryContains() [9/19]

template<class PointType, class LabelType>
template<PointConcept OtherPoint>
bool pgl::Line< PointType, LabelType >::boundaryContains ( const OtherPoint & point) const
nodiscardconstexpr

Tests whether this shape's boundary contains the other shape (∂A ⊇ B).

The interior of a line is the whole line, so its boundary is empty.

Template Parameters
OtherPointType of the point.
Parameters
pointPoint to test.
Returns
Always false.

Line

Geometric line predicates: geometric equality/order, containment, intersection against 1D and 2D shapes, and generic separation dispatch.

◆ boundaryContains() [10/19]

template<class PointType_, class TLabel>
template<PolygonConcept OtherPolygon>
bool pgl::Line< PointType_, TLabel >::boundaryContains ( const OtherPolygon & ) const
inlinenodiscardconstexpr

Tests whether this shape's boundary contains the other shape (∂A ⊇ B).

◆ boundaryContains() [11/19]

template<class PointType_, class TLabel>
template<PolylineConcept OtherPolyline>
bool pgl::Line< PointType_, TLabel >::boundaryContains ( const OtherPolyline & ) const
inlinenodiscardconstexpr

Tests whether this shape's boundary contains the other shape (∂A ⊇ B).

◆ boundaryContains() [12/19]

template<class PointType_, class TLabel>
template<RayConcept OtherRay>
bool pgl::Line< PointType_, TLabel >::boundaryContains ( const OtherRay & ) const
inlinenodiscardconstexpr

Tests whether this shape's boundary contains the other shape (∂A ⊇ B).

◆ boundaryContains() [13/19]

template<class PointType_, class TLabel>
template<RectangleConcept OtherRectangle>
bool pgl::Line< PointType_, TLabel >::boundaryContains ( const OtherRectangle & ) const
inlinenodiscardconstexpr

Tests whether this shape's boundary contains the other shape (∂A ⊇ B).

◆ boundaryContains() [14/19]

template<class PointType_, class TLabel>
template<PolygonWithHolesConcept OtherRegion>
bool pgl::Line< PointType_, TLabel >::boundaryContains ( const OtherRegion & other) const
nodiscardconstexpr

Tests whether this shape's boundary contains the other shape (∂A ⊇ B).

A boundary has no area, so it holds only a region with no area — which is exactly the union of that region's ring edges.

◆ boundaryContains() [15/19]

template<class PointType, class LabelType>
template<PolygonWithHolesConcept OtherRegion>
bool pgl::Line< PointType, LabelType >::boundaryContains ( const OtherRegion & other) const
nodiscardconstexpr

Tests whether this shape's boundary contains the other shape (∂A ⊇ B).

◆ boundaryContains() [16/19]

template<class PointType_, class TLabel>
template<SegmentConcept OtherSegment>
bool pgl::Line< PointType_, TLabel >::boundaryContains ( const OtherSegment & ) const
inlinenodiscardconstexpr

Tests whether this shape's boundary contains the other shape (∂A ⊇ B).

◆ boundaryContains() [17/19]

template<class PointType_, class TLabel>
template<PolygonSetConcept OtherSet>
bool pgl::Line< PointType_, TLabel >::boundaryContains ( const OtherSet & other) const
inlinenodiscardconstexpr

Tests whether this shape's boundary contains the other shape (∂A ⊇ B).

◆ boundaryContains() [18/19]

template<class PointType_, class TLabel>
template<TriangleConcept OtherTriangle>
bool pgl::Line< PointType_, TLabel >::boundaryContains ( const OtherTriangle & ) const
inlinenodiscardconstexpr

Tests whether this shape's boundary contains the other shape (∂A ⊇ B).

◆ boundaryContains() [19/19]

template<class PointType, class LabelType>
bool pgl::Line< PointType, LabelType >::boundaryContains ( const Shape< PointType > & other) const
nodiscardconstexpr

Tests whether this shape's boundary contains the other shape (∂A ⊇ B).

◆ cbegin()

template<class PointType_, class TLabel>
auto pgl::Line< PointType_, TLabel >::cbegin ( ) const
inlineconstexpr

Returns an iterator to the first defining point.

Returns
Pointer to the first defining point.

◆ cend()

template<class PointType_, class TLabel>
auto pgl::Line< PointType_, TLabel >::cend ( ) const
inlineconstexpr

Returns an iterator past the last defining point.

Returns
Pointer past the second defining point.

◆ closestPoints()

template<class PointType_, class TLabel>
requires detail::ClosestPointsPairConcept<Line<PointType_, TLabel>, OtherShape>
template<class ResultNumber, class OtherShape>
requires detail::ClosestPointsPairConcept<Line<PointType_, TLabel>, OtherShape>
auto pgl::Line< PointType_, TLabel >::closestPoints ( const OtherShape & other) const
nodiscardconstexpr

Returns the pair of points realizing the distance, nothing when the shapes meet.

The first point lies on this shape and the second on other, which must be bounded polygonal: two unbounded shapes may realize their distance along their whole length, with nothing to anchor a choice to. Empty exactly when squaredDistance is zero. There is no closestSegments counterpart — the point on this shape lies on no edge and at no vertex.

Template Parameters
ResultNumberCoordinate type of the returned points (default: division_result_t).
Warning
The point on this shape generally comes from a division, so with an integer ResultNumber it truncates. Request a floating-point or pgl::Rational result type for an accurate value.

◆ collinear() [1/6]

template<class PointType, class LabelType>
template<LineConcept OtherLine>
bool pgl::Line< PointType, LabelType >::collinear ( const OtherLine< PointType_, TLabel > & other) const
nodiscardconstexpr

Returns whether another line is collinear with this line.

Template Parameters
OtherNumberCoordinate type of the other line defining points.
OtherPoint::LabelTypeLabel type of the other line defining points.
Parameters
otherOther line.
Returns
true if the two lines coincide.

◆ collinear() [2/6]

template<class PointType, class LabelType>
template<OrientedLineConcept OtherOrientedLine>
bool pgl::Line< PointType, LabelType >::collinear ( const OtherOrientedLine< PointType_, TLabel > & other) const
nodiscardconstexpr

Returns whether an oriented line is collinear with this line.

Template Parameters
OtherPointDefining-point type of the other oriented line.
Parameters
otherOther oriented line.
Returns
true if both lines coincide as point sets.

◆ collinear() [3/6]

template<class PointType, class LabelType>
template<OrientedSegmentConcept OtherOrientedSegment>
bool pgl::Line< PointType, LabelType >::collinear ( const OtherOrientedSegment & other) const
nodiscardconstexpr

Returns whether the given oriented segment is collinear with the line.

Template Parameters
OtherNumberCoordinate type of the segment endpoints.
OtherPoint::LabelTypeLabel type of the segment endpoints.
Parameters
otherOther oriented segment.
Returns
true if the segment lies on the line.

◆ collinear() [4/6]

template<class PointType, class LabelType>
template<PointConcept OtherPoint>
bool pgl::Line< PointType, LabelType >::collinear ( const OtherPoint & point) const
nodiscardconstexpr

Returns whether the line interior contains the given point.

Returns whether the given point is collinear with the line.

Template Parameters
OtherPointType of the point.
Parameters
pointPoint to test.
Returns
true if the point lies on the supporting line.

◆ collinear() [5/6]

template<class PointType, class LabelType>
template<RayConcept OtherRay>
bool pgl::Line< PointType, LabelType >::collinear ( const OtherRay & other) const
nodiscardconstexpr

Returns whether a ray is collinear with this line.

Template Parameters
OtherPointDefining-point type of the ray.
Parameters
otherRay to test.
Returns
true if the ray lies on the supporting line.

◆ collinear() [6/6]

template<class PointType, class LabelType>
template<SegmentConcept OtherSegment>
bool pgl::Line< PointType, LabelType >::collinear ( const OtherSegment & other) const
nodiscardconstexpr

Returns whether the given segment is collinear with the line.

Template Parameters
OtherNumberCoordinate type of the segment endpoints.
OtherPoint::LabelTypeLabel type of the segment endpoints.
Parameters
otherOther segment.
Returns
true if the segment lies on the line.

◆ contains() [1/19]

template<class PointType_, class TLabel>
template<class EmptyPoint>
bool pgl::Line< PointType_, TLabel >::contains ( const EmptyShape< EmptyPoint > & ) const
inlinenodiscardconstexpr

Tests whether this shape contains the other shape (A ⊇ B).

◆ contains() [2/19]

template<class PointType, class LabelType>
template<MonotoneChainConcept OtherChain>
bool pgl::Line< PointType, LabelType >::contains ( const OtherChain & other) const
nodiscardconstexpr

Tests whether this shape contains the other shape (A ⊇ B).

◆ contains() [3/19]

template<class PointType, class LabelType>
template<ConvexConcept OtherConvex>
bool pgl::Line< PointType, LabelType >::contains ( const OtherConvex & other) const
nodiscardconstexpr

Tests whether this shape contains the other shape (A ⊇ B).

◆ contains() [4/19]

template<class PointType, class LabelType>
template<DiskConcept OtherDisk>
bool pgl::Line< PointType, LabelType >::contains ( const OtherDisk & other) const
nodiscardconstexpr

Tests whether this shape contains the other shape (A ⊇ B).

◆ contains() [5/19]

template<class PointType, class LabelType>
template<HalfplaneConcept OtherHalfplane>
bool pgl::Line< PointType, LabelType >::contains ( const OtherHalfplane & other) const
nodiscardconstexpr

Tests whether this shape contains the other shape (A ⊇ B).

◆ contains() [6/19]

template<class PointType, class LabelType>
template<LineConcept OtherLine>
bool pgl::Line< PointType, LabelType >::contains ( const OtherLine< PointType_, TLabel > & other) const
nodiscardconstexpr

Tests whether this shape contains the other shape (A ⊇ B).

Template Parameters
OtherNumberCoordinate type of the other line defining points.
OtherPoint::LabelTypeLabel type of the other line defining points.
Parameters
otherOther line.
Returns
true if both lines are equal.

◆ contains() [7/19]

template<class PointType, class LabelType>
template<OrientedLineConcept OtherOrientedLine>
bool pgl::Line< PointType, LabelType >::contains ( const OtherOrientedLine< PointType_, TLabel > & other) const
nodiscardconstexpr

Tests whether this shape contains the other shape (A ⊇ B).

◆ contains() [8/19]

template<class PointType, class LabelType>
template<OrientedSegmentConcept OtherOrientedSegment>
bool pgl::Line< PointType, LabelType >::contains ( const OtherOrientedSegment & other) const
nodiscardconstexpr

Tests whether this shape contains the other shape (A ⊇ B).

Template Parameters
OtherNumberCoordinate type of the segment endpoints.
OtherPoint::LabelTypeLabel type of the segment endpoints.
Parameters
otherOther oriented segment.
Returns
true if both endpoints of other lie on the line.

◆ contains() [9/19]

template<class PointType, class LabelType>
template<PointConcept OtherPoint>
bool pgl::Line< PointType, LabelType >::contains ( const OtherPoint & point) const
nodiscardconstexpr

Tests whether this shape contains the other shape (A ⊇ B).

For degenerate lines, this reduces to point equality with the stored defining point.

Template Parameters
OtherPointType of the point.
Parameters
pointPoint to test.
Returns
true if the point lies on the line.

Line

Geometric line predicates: geometric equality/order, containment, intersection against 1D and 2D shapes, and generic separation dispatch.

◆ contains() [10/19]

template<class PointType, class LabelType>
template<PolygonConcept OtherPolygon>
bool pgl::Line< PointType, LabelType >::contains ( const OtherPolygon & other) const
nodiscardconstexpr

Tests whether this shape contains the other shape (A ⊇ B).

◆ contains() [11/19]

template<class PointType, class LabelType>
template<PolylineConcept OtherPolyline>
bool pgl::Line< PointType, LabelType >::contains ( const OtherPolyline & other) const
nodiscardconstexpr

Tests whether this shape contains the other shape (A ⊇ B).

◆ contains() [12/19]

template<class PointType, class LabelType>
template<RayConcept OtherRay>
bool pgl::Line< PointType, LabelType >::contains ( const OtherRay & other) const
nodiscardconstexpr

Tests whether this shape contains the other shape (A ⊇ B).

◆ contains() [13/19]

template<class PointType, class LabelType>
template<RectangleConcept OtherRectangle>
bool pgl::Line< PointType, LabelType >::contains ( const OtherRectangle & other) const
nodiscardconstexpr

Tests whether this shape contains the other shape (A ⊇ B).

◆ contains() [14/19]

template<class PointType_, class TLabel>
template<PolygonWithHolesConcept OtherRegion>
bool pgl::Line< PointType_, TLabel >::contains ( const OtherRegion & other) const
nodiscardconstexpr

Tests whether this shape contains the other shape (A ⊇ B).

A region is contained exactly when its outer polygon is: the region holds the whole outer ring whatever its holes do, and this shape has a connected complement. See implementation/contains.hpp.

◆ contains() [15/19]

template<class PointType, class LabelType>
template<PolygonWithHolesConcept OtherRegion>
bool pgl::Line< PointType, LabelType >::contains ( const OtherRegion & other) const
nodiscardconstexpr

Tests whether this shape contains the other shape (A ⊇ B).

◆ contains() [16/19]

template<class PointType, class LabelType>
template<SegmentConcept OtherSegment>
bool pgl::Line< PointType, LabelType >::contains ( const OtherSegment & other) const
nodiscardconstexpr

Tests whether this shape contains the other shape (A ⊇ B).

Template Parameters
OtherNumberCoordinate type of the segment endpoints.
OtherPoint::LabelTypeLabel type of the segment endpoints.
Parameters
otherOther segment.
Returns
true if both endpoints of other lie on the line.

◆ contains() [17/19]

template<class PointType_, class TLabel>
template<PolygonSetConcept OtherSet>
bool pgl::Line< PointType_, TLabel >::contains ( const OtherSet & other) const
inlinenodiscardconstexpr

Tests whether this shape contains the other shape (A ⊇ B).

◆ contains() [18/19]

template<class PointType, class LabelType>
template<TriangleConcept OtherTriangle>
bool pgl::Line< PointType, LabelType >::contains ( const OtherTriangle & other) const
nodiscardconstexpr

Tests whether this shape contains the other shape (A ⊇ B).

◆ contains() [19/19]

template<class PointType, class LabelType>
bool pgl::Line< PointType, LabelType >::contains ( const Shape< PointType > & other) const
nodiscardconstexpr

Tests whether this shape contains the other shape (A ⊇ B).

◆ crosses() [1/7]

template<class PointType_, class TLabel>
template<class EmptyPoint>
bool pgl::Line< PointType_, TLabel >::crosses ( const EmptyShape< EmptyPoint > & ) const
inlinenodiscardconstexpr

Tests whether the two shapes mutually separate each other (each disconnects the other).

◆ crosses() [2/7]

template<class PointType, class LabelType>
template<LineConcept OtherLine>
bool pgl::Line< PointType, LabelType >::crosses ( const OtherLine< PointType_, TLabel > & other) const
nodiscardconstexpr

Tests whether the two shapes mutually separate each other (each disconnects the other).

Template Parameters
OtherNumberCoordinate type of the other line defining points.
OtherPoint::LabelTypeLabel type of the other line defining points.
Parameters
otherOther line.
Returns
true if the lines are distinct and not parallel.

Line

Geometric line predicates: geometric equality/order, containment, intersection against 1D and 2D shapes, and generic separation dispatch.

◆ crosses() [3/7]

template<class PointType, class LabelType>
template<OrientedSegmentConcept OtherOrientedSegment>
bool pgl::Line< PointType, LabelType >::crosses ( const OtherOrientedSegment & other) const
nodiscardconstexpr

Tests whether the two shapes mutually separate each other (each disconnects the other).

◆ crosses() [4/7]

template<class PointType, class LabelType>
template<PointConcept OtherPoint>
bool pgl::Line< PointType, LabelType >::crosses ( const OtherPoint & other) const
nodiscardconstexpr

Tests whether the two shapes mutually separate each other (each disconnects the other).

◆ crosses() [5/7]

template<class PointType, class LabelType>
template<SegmentConcept OtherSegment>
bool pgl::Line< PointType, LabelType >::crosses ( const OtherSegment & other) const
nodiscardconstexpr

Tests whether the two shapes mutually separate each other (each disconnects the other).

◆ crosses() [6/7]

template<class PointType_, class TLabel>
template<typename OtherShape>
requires (!PointConcept<OtherShape> && detail::shapeRank<OtherShape> > detail::shapeRank<Line>)
bool pgl::Line< PointType_, TLabel >::crosses ( const OtherShape & other) const
inlinenodiscardconstexpr

Tests whether the two shapes mutually separate each other (each disconnects the other).

◆ crosses() [7/7]

template<class PointType, class LabelType>
bool pgl::Line< PointType, LabelType >::crosses ( const Shape< PointType > & other) const
nodiscardconstexpr

Tests whether the two shapes mutually separate each other (each disconnects the other).

◆ distanceL1() [1/6]

template<class PointType, class LabelType>
template<class ResultNumber, LineConcept OtherLine>
auto pgl::Line< PointType, LabelType >::distanceL1 ( const OtherLine< PointType_, TLabel > & other) const
nodiscardconstexpr

Returns the Manhattan (L1) distance to the given shape.

◆ distanceL1() [2/6]

template<class PointType, class LabelType>
template<class ResultNumber, OrientedSegmentConcept OtherOrientedSegment>
auto pgl::Line< PointType, LabelType >::distanceL1 ( const OtherOrientedSegment & other) const
nodiscardconstexpr

Returns the Manhattan (L1) distance to the given shape.

◆ distanceL1() [3/6]

template<class PointType, class LabelType>
template<class ResultNumber, PointConcept OtherPoint>
auto pgl::Line< PointType, LabelType >::distanceL1 ( const OtherPoint & point) const
nodiscardconstexpr

Returns the Manhattan (L1) distance to the given shape.

◆ distanceL1() [4/6]

template<class PointType, class LabelType>
template<class ResultNumber, SegmentConcept OtherSegment>
auto pgl::Line< PointType, LabelType >::distanceL1 ( const OtherSegment & other) const
nodiscardconstexpr

Returns the Manhattan (L1) distance to the given shape.

◆ distanceL1() [5/6]

template<class PointType_, class TLabel>
template<class ResultNumber = division_result_t<NumberType>, typename OtherShape>
requires ((detail::shapeRank<OtherShape> > detail::shapeRank<Line>) && requires(const OtherShape& o, const Line& self)
{ o.template distanceL1<ResultNumber>(self); })
auto pgl::Line< PointType_, TLabel >::distanceL1 ( const OtherShape & other) const
inlinenodiscardconstexpr

Returns the Manhattan (L1) distance to the given shape.

Forwards to the other shape's implementation so that each unordered pair needs distanceL1 defined only once, on the higher-ranked shape.

◆ distanceL1() [6/6]

template<class PointType_, class TLabel>
template<class ResultNumber = double, PointConcept OtherPoint>
auto pgl::Line< PointType_, TLabel >::distanceL1 ( const Shape< OtherPoint > & other) const
inlinenodiscardconstexpr

Returns the distance to the given shape, using symmetry to re-dispatch through the wrapper's own distanceL1.

Distance is symmetric, so this just calls other's own distanceL1, which visits its wrapped alternative and throws if the pair is unsupported.

◆ distanceLInf() [1/6]

template<class PointType, class LabelType>
template<class ResultNumber, LineConcept OtherLine>
auto pgl::Line< PointType, LabelType >::distanceLInf ( const OtherLine< PointType_, TLabel > & other) const
nodiscardconstexpr

Returns the Chebyshev (LInf) distance to the given shape.

◆ distanceLInf() [2/6]

template<class PointType, class LabelType>
template<class ResultNumber, OrientedSegmentConcept OtherOrientedSegment>
auto pgl::Line< PointType, LabelType >::distanceLInf ( const OtherOrientedSegment & other) const
nodiscardconstexpr

Returns the Chebyshev (LInf) distance to the given shape.

◆ distanceLInf() [3/6]

template<class PointType, class LabelType>
template<class ResultNumber, PointConcept OtherPoint>
auto pgl::Line< PointType, LabelType >::distanceLInf ( const OtherPoint & point) const
nodiscardconstexpr

Returns the Chebyshev (LInf) distance to the given shape.

◆ distanceLInf() [4/6]

template<class PointType, class LabelType>
template<class ResultNumber, SegmentConcept OtherSegment>
auto pgl::Line< PointType, LabelType >::distanceLInf ( const OtherSegment & other) const
nodiscardconstexpr

Returns the Chebyshev (LInf) distance to the given shape.

◆ distanceLInf() [5/6]

template<class PointType_, class TLabel>
template<class ResultNumber = division_result_t<NumberType>, typename OtherShape>
requires ((detail::shapeRank<OtherShape> > detail::shapeRank<Line>) && requires(const OtherShape& o, const Line& self)
{ o.template distanceLInf<ResultNumber>(self); })
auto pgl::Line< PointType_, TLabel >::distanceLInf ( const OtherShape & other) const
inlinenodiscardconstexpr

Returns the Chebyshev (LInf) distance to the given shape.

Forwards to the other shape's implementation so that each unordered pair needs distanceLInf defined only once, on the higher-ranked shape.

◆ distanceLInf() [6/6]

template<class PointType_, class TLabel>
template<class ResultNumber = double, PointConcept OtherPoint>
auto pgl::Line< PointType_, TLabel >::distanceLInf ( const Shape< OtherPoint > & other) const
inlinenodiscardconstexpr

Returns the distance to the given shape, using symmetry to re-dispatch through the wrapper's own distanceLInf.

Distance is symmetric, so this just calls other's own distanceLInf, which visits its wrapped alternative and throws if the pair is unsupported.

◆ dual()

template<class PointType, class LabelType>
template<class ResultNumber>
Point< ResultNumber, typename PointType::LabelType > pgl::Line< PointType, LabelType >::dual ( ) const
nodiscardconstexpr

Returns the dual point.

Returns the projective dual point of a non-vertical line.

Template Parameters
ResultNumberCoordinate type of the returned point.
Returns
Point (a,b) such that the line is y = ax - b.
Warning
Uses division.
Template Parameters
ResultNumberCoordinate type of the dual point.
Returns
Dual point of this line.

◆ dualCoordinates()

template<class PointType, class LabelType>
template<class ResultNumber>
auto pgl::Line< PointType, LabelType >::dualCoordinates ( ) const
nodiscardconstexpr

Returns normalized dual-line coordinates for the supporting line.

Template Parameters
ResultNumberCoordinate type of the returned coordinates.
Returns
Normalized (a, b, denominator) of the line's dual.
Template Parameters
ResultNumberNumeric type of the returned tuple.
Returns
Tuple (a_num, b_num, den) representing y = (a_num/den)x - b_num/den.

◆ end()

template<class PointType_, class TLabel>
auto pgl::Line< PointType_, TLabel >::end ( ) const
inlineconstexpr

Returns an iterator past the last defining point.

Returns
Pointer past the second defining point.

◆ get()

template<class PointType_, class TLabel>
const PointType & pgl::Line< PointType_, TLabel >::get ( std::ptrdiff_t index) const
inlineconstexpr

Cyclic access: same as operator[] but index is taken modulo size(); negative indices wrap from the end.

◆ halfplaneAbove()

template<class PointType, class LabelType>
Halfplane< PointType > pgl::Line< PointType, LabelType >::halfplaneAbove ( ) const
nodiscardconstexpr

Returns the half-plane geometrically above this line.

For vertical lines, this is the half-plane with smaller x-coordinate.

Returns
Closed half-plane above the line.

◆ halfplaneBelow()

template<class PointType, class LabelType>
Halfplane< PointType > pgl::Line< PointType, LabelType >::halfplaneBelow ( ) const
nodiscardconstexpr

Returns the half-plane geometrically below this line.

For vertical lines, this is the half-plane with larger x-coordinate.

Returns
Closed half-plane below the line.

◆ index()

template<class PointType_, class TLabel>
std::ptrdiff_t pgl::Line< PointType_, TLabel >::index ( const PointType & point) const
inlineconstexpr

Returns the smallest index i with (*this)[i] == point, or -1 if no defining point equals point.

◆ interiorContains() [1/18]

template<class PointType_, class TLabel>
template<class EmptyPoint>
bool pgl::Line< PointType_, TLabel >::interiorContains ( const EmptyShape< EmptyPoint > & ) const
inlinenodiscardconstexpr

Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).

◆ interiorContains() [2/18]

template<class PointType, class LabelType>
template<MonotoneChainConcept OtherChain>
bool pgl::Line< PointType, LabelType >::interiorContains ( const OtherChain & other) const
nodiscardconstexpr

Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).

◆ interiorContains() [3/18]

template<class PointType, class LabelType>
template<ConvexConcept OtherConvex>
bool pgl::Line< PointType, LabelType >::interiorContains ( const OtherConvex & other) const
nodiscardconstexpr

Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).

◆ interiorContains() [4/18]

template<class PointType, class LabelType>
template<DiskConcept OtherDisk>
bool pgl::Line< PointType, LabelType >::interiorContains ( const OtherDisk & other) const
nodiscardconstexpr

Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).

◆ interiorContains() [5/18]

template<class PointType, class LabelType>
template<HalfplaneConcept OtherHalfplane>
bool pgl::Line< PointType, LabelType >::interiorContains ( const OtherHalfplane & other) const
nodiscardconstexpr

Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).

◆ interiorContains() [6/18]

template<class PointType, class LabelType>
template<LineConcept OtherLine>
bool pgl::Line< PointType, LabelType >::interiorContains ( const OtherLine< PointType_, TLabel > & other) const
nodiscardconstexpr

Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).

◆ interiorContains() [7/18]

template<class PointType, class LabelType>
template<OrientedLineConcept OtherOrientedLine>
bool pgl::Line< PointType, LabelType >::interiorContains ( const OtherOrientedLine< PointType_, TLabel > & other) const
nodiscardconstexpr

Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).

◆ interiorContains() [8/18]

template<class PointType, class LabelType>
template<OrientedSegmentConcept OtherOrientedSegment>
bool pgl::Line< PointType, LabelType >::interiorContains ( const OtherOrientedSegment & other) const
nodiscardconstexpr

Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).

◆ interiorContains() [9/18]

template<class PointType, class LabelType>
template<PointConcept OtherPoint>
bool pgl::Line< PointType, LabelType >::interiorContains ( const OtherPoint & point) const
nodiscardconstexpr

Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).

Line

Geometric line predicates: geometric equality/order, containment, intersection against 1D and 2D shapes, and generic separation dispatch.

◆ interiorContains() [10/18]

template<class PointType, class LabelType>
template<PolygonConcept OtherPolygon>
bool pgl::Line< PointType, LabelType >::interiorContains ( const OtherPolygon & other) const
nodiscardconstexpr

Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).

◆ interiorContains() [11/18]

template<class PointType, class LabelType>
template<PolylineConcept OtherPolyline>
bool pgl::Line< PointType, LabelType >::interiorContains ( const OtherPolyline & other) const
nodiscardconstexpr

Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).

◆ interiorContains() [12/18]

template<class PointType, class LabelType>
template<RayConcept OtherRay>
bool pgl::Line< PointType, LabelType >::interiorContains ( const OtherRay & other) const
nodiscardconstexpr

Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).

◆ interiorContains() [13/18]

template<class PointType, class LabelType>
template<RectangleConcept OtherRectangle>
bool pgl::Line< PointType, LabelType >::interiorContains ( const OtherRectangle & other) const
nodiscardconstexpr

Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).

◆ interiorContains() [14/18]

template<class PointType_, class TLabel>
template<PolygonWithHolesConcept OtherRegion>
bool pgl::Line< PointType_, TLabel >::interiorContains ( const OtherRegion & other) const
nodiscardconstexpr

Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).

◆ interiorContains() [15/18]

template<class PointType, class LabelType>
template<PolygonWithHolesConcept OtherRegion>
bool pgl::Line< PointType, LabelType >::interiorContains ( const OtherRegion & other) const
nodiscardconstexpr

Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).

◆ interiorContains() [16/18]

template<class PointType, class LabelType>
template<SegmentConcept OtherSegment>
bool pgl::Line< PointType, LabelType >::interiorContains ( const OtherSegment & other) const
nodiscardconstexpr

Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).

◆ interiorContains() [17/18]

template<class PointType_, class TLabel>
template<PolygonSetConcept OtherSet>
bool pgl::Line< PointType_, TLabel >::interiorContains ( const OtherSet & other) const
inlinenodiscardconstexpr

Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).

◆ interiorContains() [18/18]

template<class PointType, class LabelType>
template<TriangleConcept OtherTriangle>
bool pgl::Line< PointType, LabelType >::interiorContains ( const OtherTriangle & other) const
nodiscardconstexpr

Tests whether this shape's interior contains the other shape (A∖∂A ⊇ B).

◆ interiorsIntersect() [1/7]

template<class PointType_, class TLabel>
template<class EmptyPoint>
bool pgl::Line< PointType_, TLabel >::interiorsIntersect ( const EmptyShape< EmptyPoint > & ) const
inlinenodiscardconstexpr

Tests whether the interiors of the two shapes intersect ((A∖∂A) ∩ (B∖∂B) ≠ ∅).

◆ interiorsIntersect() [2/7]

template<class PointType, class LabelType>
template<LineConcept OtherLine>
bool pgl::Line< PointType, LabelType >::interiorsIntersect ( const OtherLine< PointType_, TLabel > & other) const
nodiscardconstexpr

Tests whether the interiors of the two shapes intersect ((A∖∂A) ∩ (B∖∂B) ≠ ∅).

◆ interiorsIntersect() [3/7]

template<class PointType, class LabelType>
template<OrientedSegmentConcept OtherOrientedSegment>
bool pgl::Line< PointType, LabelType >::interiorsIntersect ( const OtherOrientedSegment & other) const
nodiscardconstexpr

Tests whether the interiors of the two shapes intersect ((A∖∂A) ∩ (B∖∂B) ≠ ∅).

◆ interiorsIntersect() [4/7]

template<class PointType, class LabelType>
template<PointConcept OtherPoint>
bool pgl::Line< PointType, LabelType >::interiorsIntersect ( const OtherPoint & other) const
nodiscardconstexpr

Tests whether the interiors of the two shapes intersect ((A∖∂A) ∩ (B∖∂B) ≠ ∅).

For lines, this is the same as intersects.

Template Parameters
OtherNumberCoordinate type of the other line defining points.
OtherPoint::LabelTypeLabel type of the other line defining points.
Parameters
otherOther line.
Returns
true if the lines share at least one point.

Line

Geometric line predicates: geometric equality/order, containment, intersection against 1D and 2D shapes, and generic separation dispatch.

◆ interiorsIntersect() [5/7]

template<class PointType, class LabelType>
template<SegmentConcept OtherSegment>
bool pgl::Line< PointType, LabelType >::interiorsIntersect ( const OtherSegment & other) const
nodiscardconstexpr

Tests whether the interiors of the two shapes intersect ((A∖∂A) ∩ (B∖∂B) ≠ ∅).

◆ interiorsIntersect() [6/7]

template<class PointType_, class TLabel>
template<typename OtherShape>
requires (!PointConcept<OtherShape> && detail::shapeRank<OtherShape> > detail::shapeRank<Line>)
bool pgl::Line< PointType_, TLabel >::interiorsIntersect ( const OtherShape & other) const
inlinenodiscardconstexpr

Tests whether the interiors of the two shapes intersect ((A∖∂A) ∩ (B∖∂B) ≠ ∅).

◆ interiorsIntersect() [7/7]

template<class PointType, class LabelType>
bool pgl::Line< PointType, LabelType >::interiorsIntersect ( const Shape< PointType > & other) const
nodiscardconstexpr

Tests whether the interiors of the two shapes intersect ((A∖∂A) ∩ (B∖∂B) ≠ ∅).

◆ intersection() [1/7]

template<class PointType_, class TLabel>
template<class ResultNumber = NumberType, class EmptyPoint>
EmptyShape< EmptyPoint > pgl::Line< PointType_, TLabel >::intersection ( const EmptyShape< EmptyPoint > & ) const
inlinenodiscardconstexpr

Returns the intersection of the two shapes (A ∩ B), empty when they are disjoint.

◆ intersection() [2/7]

template<class PointType, class LabelType>
template<class ResultNumber, LineConcept OtherLine>
std::optional< std::variant< Point< ResultNumber, typename PointType::LabelType >, Line< Point< ResultNumber, typename PointType::LabelType > > > > pgl::Line< PointType, LabelType >::intersection ( const OtherLine< PointType_, TLabel > & other) const
nodiscardconstexpr

Returns the intersection of the two shapes (A ∩ B), empty when they are disjoint.

Warning
Divides coordinates after casting to ResultNumber.

◆ intersection() [3/7]

template<class PointType, class LabelType>
template<class ResultNumber, OrientedSegmentConcept OtherOrientedSegment>
auto pgl::Line< PointType, LabelType >::intersection ( const OtherOrientedSegment & other) const
nodiscardconstexpr

Returns the intersection of the two shapes (A ∩ B), empty when they are disjoint.

Warning
Divides coordinates after casting to ResultNumber.

◆ intersection() [4/7]

template<class PointType, class LabelType>
template<class ResultNumber, PointConcept OtherPoint>
std::optional< Point< ResultNumber, typename PointType::LabelType > > pgl::Line< PointType, LabelType >::intersection ( const OtherPoint & other) const
nodiscardconstexpr

Returns the intersection of the two shapes (A ∩ B), empty when they are disjoint.

The intersection may be empty, a point, or the entire line.

Template Parameters
ResultNumberCoordinate type of the returned point or line.
OtherNumberCoordinate type of the other line defining points.
OtherPoint::LabelTypeLabel type of the other line defining points.
Parameters
otherOther line.
Returns
Empty if disjoint, otherwise a point or a line.

◆ intersection() [5/7]

template<class PointType, class LabelType>
template<class ResultNumber, SegmentConcept OtherSegment>
auto pgl::Line< PointType, LabelType >::intersection ( const OtherSegment & other) const
nodiscardconstexpr

Returns the intersection of the two shapes (A ∩ B), empty when they are disjoint.

Warning
Divides coordinates after casting to ResultNumber.

◆ intersection() [6/7]

template<class PointType_, class TLabel>
template<class ResultNumber = division_result_t<NumberType>, typename OtherShape>
requires (!PointConcept<OtherShape> && (detail::shapeRank<OtherShape> > detail::shapeRank<Line>) && requires(const OtherShape& o,
const Line& self) { o.template intersection<ResultNumber>(self); })
auto pgl::Line< PointType_, TLabel >::intersection ( const OtherShape & other) const
inlinenodiscardconstexpr

Returns the intersection of the two shapes (A ∩ B), empty when they are disjoint.

Warning
Divides coordinates after casting to ResultNumber.

◆ intersection() [7/7]

template<class PointType_, class TLabel>
template<class ResultNumber = division_result_t<NumberType>, PointConcept OtherPoint>
auto pgl::Line< PointType_, TLabel >::intersection ( const Shape< OtherPoint > & other) const
inlinenodiscardconstexpr

Returns the intersection of the two shapes (A ∩ B), re-dispatching through the wrapper's own intersection.

An intersection is symmetric, so this just calls other's own intersection, which visits its wrapped alternative and throws if the pair is unsupported.

The point type is deduced from other so a plain concrete shape cannot reach this overload through an implicit conversion to Shape.

Returns
The intersection wrapped in a Shape, rather than the tighter type the concrete pair would answer with: which alternative other holds is not known until run time, so neither is the result's.

◆ intersects() [1/7]

template<class PointType_, class TLabel>
template<class EmptyPoint>
bool pgl::Line< PointType_, TLabel >::intersects ( const EmptyShape< EmptyPoint > & ) const
inlinenodiscardconstexpr

Tests whether this shape and the other shape intersect (A ∩ B ≠ ∅).

◆ intersects() [2/7]

template<class PointType, class LabelType>
template<LineConcept OtherLine>
bool pgl::Line< PointType, LabelType >::intersects ( const OtherLine< PointType_, TLabel > & other) const
nodiscardconstexpr

Tests whether this shape and the other shape intersect (A ∩ B ≠ ∅).

Template Parameters
OtherNumberCoordinate type of the other line defining points.
OtherPoint::LabelTypeLabel type of the other line defining points.
Parameters
otherOther line.
Returns
true if the lines share at least one point.

◆ intersects() [3/7]

template<class PointType, class LabelType>
template<OrientedSegmentConcept OtherOrientedSegment>
bool pgl::Line< PointType, LabelType >::intersects ( const OtherOrientedSegment & other) const
nodiscardconstexpr

Tests whether this shape and the other shape intersect (A ∩ B ≠ ∅).

◆ intersects() [4/7]

template<class PointType, class LabelType>
template<PointConcept OtherPoint>
bool pgl::Line< PointType, LabelType >::intersects ( const OtherPoint & other) const
nodiscardconstexpr

Tests whether this shape and the other shape intersect (A ∩ B ≠ ∅).

Line

Geometric line predicates: geometric equality/order, containment, intersection against 1D and 2D shapes, and generic separation dispatch.

◆ intersects() [5/7]

template<class PointType, class LabelType>
template<SegmentConcept OtherSegment>
bool pgl::Line< PointType, LabelType >::intersects ( const OtherSegment & other) const
nodiscardconstexpr

Tests whether this shape and the other shape intersect (A ∩ B ≠ ∅).

◆ intersects() [6/7]

template<class PointType_, class TLabel>
template<typename OtherShape>
requires (!PointConcept<OtherShape> && detail::shapeRank<OtherShape> > detail::shapeRank<Line>)
bool pgl::Line< PointType_, TLabel >::intersects ( const OtherShape & other) const
inlinenodiscardconstexpr

Tests whether this shape and the other shape intersect (A ∩ B ≠ ∅).

◆ intersects() [7/7]

template<class PointType, class LabelType>
bool pgl::Line< PointType, LabelType >::intersects ( const Shape< PointType > & other) const
nodiscardconstexpr

Tests whether this shape and the other shape intersect (A ∩ B ≠ ∅).

◆ isDegenerate()

template<class PointType, class LabelType>
bool pgl::Line< PointType, LabelType >::isDegenerate ( ) const
nodiscardconstexpr

Returns whether the defining points coincide.

Returns
true if both defining points are equal.

◆ isHorizontal()

template<class PointType, class LabelType>
bool pgl::Line< PointType, LabelType >::isHorizontal ( ) const
nodiscardconstexpr

Returns whether the line is horizontal.

Returns
true if both defining points have the same y-coordinate.

◆ isUndefined()

template<class PointType, class LabelType>
bool pgl::Line< PointType, LabelType >::isUndefined ( ) const
nodiscardconstexpr

Returns whether the line is degenerate without collapsing to a point or to a segment.

A line through two equal points has no direction and no reasonable interpretation, so every degenerate line is undefined.

Complexity: O(1).

Returns
isDegenerate.

◆ isVertical()

template<class PointType, class LabelType>
bool pgl::Line< PointType, LabelType >::isVertical ( ) const
nodiscardconstexpr

Returns whether the line is vertical.

Returns
true if both defining points have the same x-coordinate.

◆ label()

template<class PointType_, class TLabel>
template<class A = LabelType>
requires (detail::has_label_v<A>)
A & pgl::Line< PointType_, TLabel >::label ( ) const
inlineconstexpr

Returns the line label.

The label is mutable even through a const line: it is metadata that does not participate in equality, hashing, or geometric predicates.

Returns
Reference to the stored label.

◆ max()

template<class PointType_, class TLabel>
const PointType & pgl::Line< PointType_, TLabel >::max ( ) const
inlineconstexpr

Returns the largest stored defining point.

Returns
Reference to the second defining point.

◆ min()

template<class PointType_, class TLabel>
const PointType & pgl::Line< PointType_, TLabel >::min ( ) const
inlineconstexpr

Returns the smallest stored defining point.

Returns
Reference to the first defining point.

◆ minkowskiErosion()

template<class PointType, class LabelType>
requires MinkowskiSummableConcept<Line<PointType_, TLabel>, OtherShape>
template<class OtherShape>
requires MinkowskiSummableConcept<Line<PointType_, TLabel>, OtherShape>
auto pgl::Line< PointType, LabelType >::minkowskiErosion ( const OtherShape & other) const
nodiscardconstexpr

Returns the Minkowski erosion of this shape by another (A ⊖ B).

The erosion is the point set {x : x ⊕ B ⊆ A}, the translations of other that keep it inside this shape – equivalently ⋂ {A - b : b ∈ B}. It is the morphological dual of minkowskiSum and is defined for the same pairs, but it is not commutative.

Eroding by a Point is the translation by its negation, so it returns this shape's own type; the other pairs come back as the convex region they are, a HalfplaneIntersection, which holds a lower-dimensional erosion and the empty one as readily as a two-dimensional one. A line erodes to itself when the operand is parallel to it, and to nothing otherwise.

Eroding by a shape that covers no point is the whole plane, which a HalfplaneIntersection returns and the tighter result types cannot.

Template Parameters
OtherShapeType of the shape to erode by.
Parameters
otherShape to erode by.
Returns
The erosion, in the tightest type that represents it.

◆ minkowskiSum()

template<class PointType, class LabelType>
requires MinkowskiSummableConcept<Line<PointType_, TLabel>, OtherShape>
template<class OtherShape>
requires MinkowskiSummableConcept<Line<PointType_, TLabel>, OtherShape>
auto pgl::Line< PointType, LabelType >::minkowskiSum ( const OtherShape & other) const
nodiscardconstexpr

Returns the Minkowski sum of this shape and another (A ⊕ B).

The sum is the point set {a + b : a ∈ A, b ∈ B}. Summing with a Point is a translation, so it returns this shape's own type. This shape is unbounded, so its every other sum is unbounded too and comes back as a HalfplaneIntersection: the operand may be any other unbounded convex shape (UnboundedConvexConcept) or any bounded convex one, and the sum of two convex polyhedra is a convex polyhedron. A non-convex operand is refused, its concavity being swept into the answer rather than absorbed. See MinkowskiSummableConcept.

Template Parameters
OtherShapeType of the other shape.
Parameters
otherShape to sum with.
Returns
The Minkowski sum, in the tightest type that represents it.

◆ operator*=() [1/2]

template<class PointType_, class TLabel>
template<class Scalar>
requires (!detail::is_point_v<Scalar> && !TransformationConcept<Scalar>)
Line< PointType, LabelType > & pgl::Line< PointType_, TLabel >::operator*= ( const Scalar & scalar)
constexpr

◆ operator*=() [2/2]

template<class PointType_, class TLabel>
template<class Scalar>
requires (!detail::is_point_v<Scalar> && !TransformationConcept<Scalar>)
Line & pgl::Line< PointType_, TLabel >::operator*= ( const Scalar & scalar)
constexpr

Scales the line around the origin in place.

Template Parameters
ScalarScalar type.
Parameters
scalarScale factor.
Returns
Reference to this line.

◆ operator+=() [1/2]

template<class PointType_, class TLabel>
template<PointConcept OtherPoint>
Line< PointType, LabelType > & pgl::Line< PointType_, TLabel >::operator+= ( const OtherPoint & translation)
constexpr

◆ operator+=() [2/2]

template<class PointType_, class TLabel>
template<PointConcept OtherPoint>
Line & pgl::Line< PointType_, TLabel >::operator+= ( const OtherPoint & translation)
constexpr

Translates both defining points in place.

Template Parameters
OtherNumberCoordinate type of the translation point.
OtherPoint::LabelTypeLabel type of the translation point.
Parameters
translationTranslation vector.
Returns
Reference to this line.

◆ operator-=() [1/2]

template<class PointType_, class TLabel>
template<PointConcept OtherPoint>
Line< PointType, LabelType > & pgl::Line< PointType_, TLabel >::operator-= ( const OtherPoint & translation)
constexpr

◆ operator-=() [2/2]

template<class PointType_, class TLabel>
template<PointConcept OtherPoint>
Line & pgl::Line< PointType_, TLabel >::operator-= ( const OtherPoint & translation)
constexpr

Translates both defining points by the opposite vector in place.

Template Parameters
OtherNumberCoordinate type of the translation point.
OtherPoint::LabelTypeLabel type of the translation point.
Parameters
translationTranslation vector to subtract.
Returns
Reference to this line.

◆ operator/=() [1/2]

template<class PointType_, class TLabel>
template<class Scalar>
requires (!detail::is_point_v<Scalar> && !TransformationConcept<Scalar>)
Line< PointType, LabelType > & pgl::Line< PointType_, TLabel >::operator/= ( const Scalar & scalar)
constexpr

◆ operator/=() [2/2]

template<class PointType_, class TLabel>
template<class Scalar>
requires (!detail::is_point_v<Scalar> && !TransformationConcept<Scalar>)
Line & pgl::Line< PointType_, TLabel >::operator/= ( const Scalar & scalar)
constexpr

Divides the line coordinates by a scalar in place.

Template Parameters
ScalarScalar type.
Parameters
scalarDivisor.
Returns
Reference to this line.

◆ operator<=>()

template<class PointType, class LabelType>
auto pgl::Line< PointType, LabelType >::operator<=> ( const Line< PointType_, TLabel > & other) const
nodiscardconstexpr

Provides an ordering compatible with geometric equality.

Parameters
otherLine to compare with.
Returns
Comparison result.
Warning
Coordinates are cubed but a single promotion is used.

◆ operator=()

template<class PointType_, class TLabel>
template<PointConcept OtherPointType, class OtherLabelType>
requires (std::constructible_from<PointType, const OtherPointType&>)
Line & pgl::Line< PointType_, TLabel >::operator= ( const Line< OtherPointType, OtherLabelType > & other)
inlineconstexpr

Assigns from a line with compatible point and label types.

◆ operator==()

template<class PointType, class LabelType>
bool pgl::Line< PointType, LabelType >::operator== ( const Line< PointType_, TLabel > & other) const
nodiscardconstexpr

Tests geometric equality of two lines.

Lines compare using the contains predicate.

Parameters
otherLine to compare with.
Returns
true if both lines represent the same geometric set.

Line

Geometric line predicates: geometric equality/order, containment, intersection against 1D and 2D shapes, and generic separation dispatch.

◆ operator[]()

template<class PointType_, class TLabel>
const PointType & pgl::Line< PointType_, TLabel >::operator[] ( std::size_t index) const
inlineconstexpr

Returns defining point 0 or 1.

Parameters
indexDefining-point index.
Returns
Reference to the selected defining point.

◆ parallel() [1/5]

template<class PointType, class LabelType>
template<LineConcept OtherLine>
bool pgl::Line< PointType, LabelType >::parallel ( const OtherLine< PointType_, TLabel > & other) const
nodiscardconstexpr

Returns whether another line is parallel to this line.

Template Parameters
OtherNumberCoordinate type of the other line defining points.
OtherPoint::LabelTypeLabel type of the other line defining points.
Parameters
otherOther line.
Returns
true if both slopes are the same.

◆ parallel() [2/5]

template<class PointType, class LabelType>
template<OrientedLineConcept OtherOrientedLine>
bool pgl::Line< PointType, LabelType >::parallel ( const OtherOrientedLine< PointType_, TLabel > & other) const
nodiscardconstexpr

Returns whether an oriented line is parallel to this line.

Template Parameters
OtherPointDefining-point type of the other oriented line.
Parameters
otherOther oriented line.
Returns
true if both slopes are the same.

◆ parallel() [3/5]

template<class PointType, class LabelType>
template<OrientedSegmentConcept OtherOrientedSegment>
bool pgl::Line< PointType, LabelType >::parallel ( const OtherOrientedSegment & other) const
nodiscardconstexpr

Returns whether an oriented segment is parallel to this line.

Template Parameters
OtherNumberCoordinate type of the segment endpoints.
OtherPoint::LabelTypeLabel type of the segment endpoints.
Parameters
otherOther oriented segment.
Returns
true if both slopes are the same.

◆ parallel() [4/5]

template<class PointType, class LabelType>
template<RayConcept OtherRay>
bool pgl::Line< PointType, LabelType >::parallel ( const OtherRay & other) const
nodiscardconstexpr

Returns whether a ray is parallel to this line.

Template Parameters
OtherPointDefining-point type of the ray.
Parameters
otherRay to test.
Returns
true if both slopes are the same.

◆ parallel() [5/5]

template<class PointType, class LabelType>
template<SegmentConcept OtherSegment>
bool pgl::Line< PointType, LabelType >::parallel ( const OtherSegment & other) const
nodiscardconstexpr

Returns whether a segment is parallel to this line.

Template Parameters
OtherNumberCoordinate type of the segment endpoints.
OtherPoint::LabelTypeLabel type of the segment endpoints.
Parameters
otherOther segment.
Returns
true if both slopes are the same.

◆ pointInside()

template<class PointType, class LabelType>
template<class ResultNumber>
Point< ResultNumber > pgl::Line< PointType, LabelType >::pointInside ( ) const
nodiscardconstexpr

Returns a point inside the line.

For a line, this is the min point.

Returns
Returns min()

◆ pointInsideInteriorContainedIn()

template<class PointType, class LabelType>
template<class OtherShape>
bool pgl::Line< PointType, LabelType >::pointInsideInteriorContainedIn ( const OtherShape & shape) const
nodiscardconstexpr

Tests whether some point in this shape's relative interior lies in the strict interior of shape.

Uses pointInside as the witness; it lies exactly in this shape's relative interior, so no scaled fallback is required.

◆ polar()

template<class PointType, class LabelType>
template<class ResultNumber>
Point< ResultNumber, typename PointType::LabelType > pgl::Line< PointType, LabelType >::polar ( ) const
nodiscardconstexpr

Returns the polar point.

Returns the polar point of a line in the chosen dual model.

Template Parameters
ResultNumberCoordinate type of the returned point.
Returns
Point (a,b) such that the line is ax + by = 1.
Warning
Uses division.
Template Parameters
ResultNumberCoordinate type of the polar point.
Returns
Polar point of this line.

◆ rotate90()

template<class PointType, class LabelType>
void pgl::Line< PointType, LabelType >::rotate90 ( int k = 1)
constexpr

Rotates the line by 90k degrees around the origin in place.

Parameters
kNumber of 90-degree CCW rotations (may be negative).

◆ rotated90()

template<class PointType, class LabelType>
Line< PointType, LabelType > pgl::Line< PointType, LabelType >::rotated90 ( int k = 1) const
nodiscardconstexpr

Returns the line rotated by 90k degrees around the origin.

Parameters
kNumber of 90-degree CCW rotations (may be negative).
Returns
Rotated line.

◆ samePointSet()

template<class PointType, class LabelType>
template<AnyShapeConcept OtherShape>
bool pgl::Line< PointType, LabelType >::samePointSet ( const OtherShape & other) const
nodiscardconstexpr

Tests whether another shape defines exactly the same point set.

◆ scaledDownX() [1/2]

template<class PointType_, class TLabel>
template<class OtherNumber>
Line< PointType, LabelType > pgl::Line< PointType_, TLabel >::scaledDownX ( const OtherNumber scalar) const
constexpr

◆ scaledDownX() [2/2]

template<class PointType_, class TLabel>
template<class OtherNumber>
Line pgl::Line< PointType_, TLabel >::scaledDownX ( const OtherNumber scalar) const
nodiscardconstexpr

Returns the line with its x-coordinates divided by a divisor.

◆ scaledDownY() [1/2]

template<class PointType_, class TLabel>
template<class OtherNumber>
Line< PointType, LabelType > pgl::Line< PointType_, TLabel >::scaledDownY ( const OtherNumber scalar) const
constexpr

◆ scaledDownY() [2/2]

template<class PointType_, class TLabel>
template<class OtherNumber>
Line pgl::Line< PointType_, TLabel >::scaledDownY ( const OtherNumber scalar) const
nodiscardconstexpr

Returns the line with its y-coordinates divided by a divisor.

◆ scaleDownX()

template<class PointType, class LabelType>
template<class OtherNumber>
void pgl::Line< PointType, LabelType >::scaleDownX ( const OtherNumber scalar)
constexpr

Divides the line's x-coordinates by a divisor in place.

◆ scaleDownY()

template<class PointType, class LabelType>
template<class OtherNumber>
void pgl::Line< PointType, LabelType >::scaleDownY ( const OtherNumber scalar)
constexpr

Divides the line's y-coordinates by a divisor in place.

◆ scaledUpX() [1/2]

template<class PointType_, class TLabel>
template<class OtherNumber>
Line< PointType, LabelType > pgl::Line< PointType_, TLabel >::scaledUpX ( const OtherNumber scalar) const
constexpr

◆ scaledUpX() [2/2]

template<class PointType_, class TLabel>
template<class OtherNumber>
Line pgl::Line< PointType_, TLabel >::scaledUpX ( const OtherNumber scalar) const
nodiscardconstexpr

Returns the line with its x-coordinates multiplied by a factor.

◆ scaledUpY() [1/2]

template<class PointType_, class TLabel>
template<class OtherNumber>
Line< PointType, LabelType > pgl::Line< PointType_, TLabel >::scaledUpY ( const OtherNumber scalar) const
constexpr

◆ scaledUpY() [2/2]

template<class PointType_, class TLabel>
template<class OtherNumber>
Line pgl::Line< PointType_, TLabel >::scaledUpY ( const OtherNumber scalar) const
nodiscardconstexpr

Returns the line with its y-coordinates multiplied by a factor.

◆ scaleUpX()

template<class PointType, class LabelType>
template<class OtherNumber>
void pgl::Line< PointType, LabelType >::scaleUpX ( const OtherNumber scalar)
constexpr

Multiplies the line's x-coordinates by a factor in place.

◆ scaleUpY()

template<class PointType, class LabelType>
template<class OtherNumber>
void pgl::Line< PointType, LabelType >::scaleUpY ( const OtherNumber scalar)
constexpr

Multiplies the line's y-coordinates by a factor in place.

◆ separates() [1/19]

template<class PointType_, class TLabel>
template<class EmptyPoint>
bool pgl::Line< PointType_, TLabel >::separates ( const EmptyShape< EmptyPoint > & ) const
inlinenodiscardconstexpr

Tests whether removing this shape disconnects the other shape (B∖A is disconnected).

◆ separates() [2/19]

template<class PointType, class LabelType>
template<MonotoneChainConcept OtherChain>
bool pgl::Line< PointType, LabelType >::separates ( const OtherChain & other) const
nodiscardconstexpr

Tests whether removing this shape disconnects the other shape (B∖A is disconnected).

◆ separates() [3/19]

template<class PointType, class LabelType>
template<ConvexConcept OtherConvex>
bool pgl::Line< PointType, LabelType >::separates ( const OtherConvex & other) const
nodiscardconstexpr

Tests whether removing this shape disconnects the other shape (B∖A is disconnected).

◆ separates() [4/19]

template<class PointType, class LabelType>
template<DiskConcept OtherDisk>
bool pgl::Line< PointType, LabelType >::separates ( const OtherDisk & other) const
nodiscardconstexpr

Tests whether removing this shape disconnects the other shape (B∖A is disconnected).

◆ separates() [5/19]

template<class PointType, class LabelType>
template<HalfplaneConcept OtherHalfplane>
bool pgl::Line< PointType, LabelType >::separates ( const OtherHalfplane & other) const
nodiscardconstexpr

Tests whether removing this shape disconnects the other shape (B∖A is disconnected).

◆ separates() [6/19]

template<class PointType, class LabelType>
template<LineConcept OtherLine>
bool pgl::Line< PointType, LabelType >::separates ( const OtherLine< PointType_, TLabel > & other) const
nodiscardconstexpr

Tests whether removing this shape disconnects the other shape (B∖A is disconnected).

◆ separates() [7/19]

template<class PointType, class LabelType>
template<OrientedLineConcept OtherOrientedLine>
bool pgl::Line< PointType, LabelType >::separates ( const OtherOrientedLine< PointType_, TLabel > & other) const
nodiscardconstexpr

Tests whether removing this shape disconnects the other shape (B∖A is disconnected).

◆ separates() [8/19]

template<class PointType, class LabelType>
template<OrientedSegmentConcept OtherOrientedSegment>
bool pgl::Line< PointType, LabelType >::separates ( const OtherOrientedSegment & other) const
nodiscardconstexpr

Tests whether removing this shape disconnects the other shape (B∖A is disconnected).

◆ separates() [9/19]

template<class PointType, class LabelType>
template<PointConcept OtherPoint>
bool pgl::Line< PointType, LabelType >::separates ( const OtherPoint & other) const
nodiscardconstexpr

Tests whether removing this shape disconnects the other shape (B∖A is disconnected).

Line

Geometric line predicates: geometric equality/order, containment, intersection against 1D and 2D shapes, and generic separation dispatch.

◆ separates() [10/19]

template<class PointType, class LabelType>
template<PolygonConcept OtherPolygon>
bool pgl::Line< PointType, LabelType >::separates ( const OtherPolygon & other) const
nodiscardconstexpr

Tests whether removing this shape disconnects the other shape (B∖A is disconnected).

◆ separates() [11/19]

template<class PointType, class LabelType>
template<PolylineConcept OtherPolyline>
bool pgl::Line< PointType, LabelType >::separates ( const OtherPolyline & other) const
nodiscardconstexpr

Tests whether removing this shape disconnects the other shape (B∖A is disconnected).

◆ separates() [12/19]

template<class PointType, class LabelType>
template<RayConcept OtherRay>
bool pgl::Line< PointType, LabelType >::separates ( const OtherRay & other) const
nodiscardconstexpr

Tests whether removing this shape disconnects the other shape (B∖A is disconnected).

◆ separates() [13/19]

template<class PointType, class LabelType>
template<RectangleConcept OtherRectangle>
bool pgl::Line< PointType, LabelType >::separates ( const OtherRectangle & other) const
nodiscardconstexpr

Tests whether removing this shape disconnects the other shape (B∖A is disconnected).

◆ separates() [14/19]

template<class PointType, class LabelType>
template<PolygonWithHolesConcept OtherRegion>
bool pgl::Line< PointType, LabelType >::separates ( const OtherRegion & other) const
nodiscard

Tests whether removing this shape disconnects the other shape (B∖A is disconnected).

The region is settled by the cell engine of implementation/separates.hpp; see the notes on pgl::PolygonWithHoles::separates for what a region admits that a simply connected target does not.

◆ separates() [15/19]

template<class PointType, class LabelType>
template<HalfplaneIntersectionConcept OtherRegion>
bool pgl::Line< PointType, LabelType >::separates ( const OtherRegion & other) const
nodiscardconstexpr

Tests whether removing this shape disconnects the other shape (B∖A is disconnected).

◆ separates() [16/19]

template<class PointType, class LabelType>
template<SegmentConcept OtherSegment>
bool pgl::Line< PointType, LabelType >::separates ( const OtherSegment & other) const
nodiscardconstexpr

Tests whether removing this shape disconnects the other shape (B∖A is disconnected).

◆ separates() [17/19]

template<class PointType, class LabelType>
template<PolygonSetConcept OtherSet>
bool pgl::Line< PointType, LabelType >::separates ( const OtherSet & other) const
nodiscard

Tests whether removing this shape disconnects the other shape (B∖A is disconnected).

A set of regions is the one target that may already be in several pieces before anything is removed, so this neither folds over its components nor answers false for a remover that misses it. See implementation/separates.hpp.

◆ separates() [18/19]

template<class PointType, class LabelType>
template<TriangleConcept OtherTriangle>
bool pgl::Line< PointType, LabelType >::separates ( const OtherTriangle & other) const
nodiscardconstexpr

Tests whether removing this shape disconnects the other shape (B∖A is disconnected).

◆ separates() [19/19]

template<class PointType, class LabelType>
bool pgl::Line< PointType, LabelType >::separates ( const Shape< PointType > & other) const
nodiscardconstexpr

Tests whether removing this shape disconnects the other shape (B∖A is disconnected).

◆ size()

template<class PointType_, class TLabel>
constexpr std::size_t pgl::Line< PointType_, TLabel >::size ( )
inlinestaticconstexpr

Returns the number of defining points (always 2).

◆ slope()

template<class PointType, class LabelType>
template<class ResultNumber>
ResultNumber pgl::Line< PointType, LabelType >::slope ( ) const
nodiscardconstexpr

Returns the slope of the line.

Undefined behavior for vertical lines.

Template Parameters
ResultNumberCoordinate type of the returned slope.
Returns
Slope.
Warning
Uses division of coordinates.

◆ squaredDistance() [1/6]

template<class PointType_, class TLabel>
template<class ResultNumber = double, class DiskPointType, class DiskLabel>
detail::floating_result_t< ResultNumber > pgl::Line< PointType_, TLabel >::squaredDistance ( const Disk< DiskPointType, DiskLabel > & disk) const
inlinenodiscard

Returns the squared Euclidean distance to a disk.

Forwards to Disk::squaredDistance. Reports in detail::floating_result_t<ResultNumber>: a distance realized on a circle is generally irrational, so a floating-point ResultNumber is honoured as asked and any other request falls back to double.

◆ squaredDistance() [2/6]

template<class PointType, class LabelType>
template<class ResultNumber, LineConcept OtherLine>
auto pgl::Line< PointType, LabelType >::squaredDistance ( const OtherLine< PointType_, TLabel > & other) const
nodiscardconstexpr

Returns the squared Euclidean distance to the given shape.

Template Parameters
ResultNumberCoordinate type of the returned distance (default: division_result_t).
OtherNumberCoordinate type of the other line defining points.
OtherPoint::LabelTypeLabel type of the other line defining points.
Parameters
otherOther line.
Returns
Squared Euclidean distance.
Warning
With an integer ResultNumber the exact squared distance is generally a fraction, so the internal division truncates and the result is inexact. Request a floating-point or pgl::Rational result type, e.g. squaredDistance<double>(other), for an accurate value.

◆ squaredDistance() [3/6]

template<class PointType, class LabelType>
template<class ResultNumber, OrientedSegmentConcept OtherOrientedSegment>
auto pgl::Line< PointType, LabelType >::squaredDistance ( const OtherOrientedSegment & other) const
nodiscardconstexpr

Returns the squared Euclidean distance to the given shape.

Zero when the segment crosses the line; otherwise the segment lies on one side and, because distance to a line is affine along the segment, the minimum is attained at an endpoint.

Template Parameters
ResultNumberCoordinate type of the returned distance (default: division_result_t).
OtherSegmentType of the segment.
Parameters
otherSegment to measure from.
Returns
Squared Euclidean distance.
Warning
With an integer ResultNumber the exact squared distance is generally a fraction, so the internal division truncates and the result is inexact. Request a floating-point or pgl::Rational result type, e.g. squaredDistance<double>(other), for an accurate value.

◆ squaredDistance() [4/6]

template<class PointType, class LabelType>
template<class ResultNumber, PointConcept OtherPoint>
auto pgl::Line< PointType, LabelType >::squaredDistance ( const OtherPoint & point) const
nodiscardconstexpr

Returns the squared Euclidean distance to the given shape.

The squared perpendicular distance divides the squared doubled triangle area by the squared line length.

Template Parameters
ResultNumberCoordinate type of the returned distance (default: division_result_t).
OtherPointType of the point.
Parameters
pointPoint to measure from.
Returns
Squared Euclidean distance.
Warning
With an integer ResultNumber the exact squared distance is generally a fraction, so the internal division truncates and the result is inexact. Request a floating-point or pgl::Rational result type, e.g. squaredDistance<double>(point), for an accurate value.

◆ squaredDistance() [5/6]

template<class PointType, class LabelType>
template<class ResultNumber, SegmentConcept OtherSegment>
auto pgl::Line< PointType, LabelType >::squaredDistance ( const OtherSegment & other) const
nodiscardconstexpr

Returns the squared Euclidean distance to the given shape.

Zero when the segment crosses the line; otherwise the segment lies on one side and, because distance to a line is affine along the segment, the minimum is attained at an endpoint.

Template Parameters
ResultNumberCoordinate type of the returned distance (default: division_result_t).
OtherSegmentType of the segment.
Parameters
otherSegment to measure from.
Returns
Squared Euclidean distance.
Warning
With an integer ResultNumber the exact squared distance is generally a fraction, so the internal division truncates and the result is inexact. Request a floating-point or pgl::Rational result type, e.g. squaredDistance<double>(other), for an accurate value.

◆ squaredDistance() [6/6]

template<class PointType_, class TLabel>
template<class ResultNumber = division_result_t<NumberType>, typename OtherShape>
requires ((detail::shapeRank<OtherShape> > detail::shapeRank<Line>) && requires(const OtherShape& o, const Line& self)
{ o.template squaredDistance<ResultNumber>(self); })
auto pgl::Line< PointType_, TLabel >::squaredDistance ( const OtherShape & other) const
inlinenodiscardconstexpr

Returns the squared Euclidean distance to the given shape.

Forwards to the other shape's implementation so that each unordered pair needs squaredDistance defined only once, on the higher-ranked shape.

◆ twiceArea()

template<class PointType, class LabelType>
Line< PointType, LabelType >::NumberType pgl::Line< PointType, LabelType >::twiceArea ( ) const
nodiscardconstexpr

Returns twice the area of the line.

A line is one-dimensional, so this is always zero.

Returns
Zero.

◆ verticesContain()

template<class PointType, class LabelType>
template<PointConcept OtherPoint>
bool pgl::Line< PointType, LabelType >::verticesContain ( const OtherPoint & point) const
nodiscardconstexpr

Returns whether the given point is one of the stored defining points.

Template Parameters
OtherPointType of the point.
Parameters
pointPoint to test.
Returns
true if the point equals one stored defining point.

◆ xAtY()

template<class PointType, class LabelType>
template<class ResultNumber, class OtherNumber>
std::optional< ResultNumber > pgl::Line< PointType, LabelType >::xAtY ( const OtherNumber & y) const
nodiscardconstexpr

Returns the x-coordinate of the line at a given y-coordinate, if defined.

Evaluates the x-coordinate of a line at a given y-coordinate.

For horizontal lines queried at their y-coordinate, the stored min().x() is returned to keep the API deterministic.

Template Parameters
ResultNumberCoordinate type of the returned value.
OtherNumberCoordinate type of the query y-coordinate.
Parameters
yQuery y-coordinate.
Returns
Corresponding x-coordinate, or empty when the line is horizontal at a different y.
Warning
Uses division after casting to ResultNumber.

Non-horizontal lines always define a unique result. For horizontal lines, the query succeeds only at the line y-coordinate, where the stored min().x() is returned

Template Parameters
ResultNumberReturn coordinate type.
OtherNumberQuery y-coordinate type.
Parameters
yQuery y-coordinate.
Returns
Corresponding x-coordinate, or empty when undefined.

◆ yAtX()

template<class PointType, class LabelType>
template<class ResultNumber, class OtherNumber>
std::optional< ResultNumber > pgl::Line< PointType, LabelType >::yAtX ( const OtherNumber & x) const
nodiscardconstexpr

Returns the y-coordinate of the line at a given x-coordinate, if defined.

Evaluates the y-coordinate of a line at a given x-coordinate.

For vertical lines queried at their x-coordinate, the stored min().y() is returned to keep the API deterministic.

Template Parameters
ResultNumberCoordinate type of the returned value.
OtherNumberCoordinate type of the query x-coordinate.
Parameters
xQuery x-coordinate.
Returns
Corresponding y-coordinate, or empty when the line is vertical at a different x.
Warning
Uses division after casting to ResultNumber.

Non-vertical lines always define a unique result. For vertical lines, the query succeeds only at the line x-coordinate, where the stored min().y() is returned

Template Parameters
ResultNumberReturn coordinate type.
OtherNumberQuery x-coordinate type.
Parameters
xQuery x-coordinate.
Returns
Corresponding y-coordinate, or empty when undefined.