Autoware.Auto
autoware::motion::planning::parking_planner::Halfplane2D< T > Class Template Reference

Class describing a halfplane in two-dimensional space. More...

#include <geometry.hpp>

Public Member Functions

 Halfplane2D (const Point2D< T > &coefficients, T right_hand_side)
 
template<typename S = T, std::enable_if_t< std::is_arithmetic< S >::value, int > = 0>
bool contains_point (const Point2D< T > &point) const noexcept
 Check if a given point is in the halfplane or not. More...
 
const Point2D< T > & get_coefficients () const noexcept
 Get the coefficients of the left-hand side of the halfplane equation. More...
 
const T & get_right_hand_side () const noexcept
 Get the right-hand side constant of the halfplane equation. More...
 
std::vector< T > serialize () const
 Turn this halfplane into a vector of scalars. More...
 

Static Public Member Functions

static constexpr std::size_t get_serialized_length () noexcept
 Query how many scalars are involved in serializing this halfplane. More...
 

Detailed Description

template<typename T>
class autoware::motion::planning::parking_planner::Halfplane2D< T >

Class describing a halfplane in two-dimensional space.

Constructor & Destructor Documentation

◆ Halfplane2D()

template<typename T >
autoware::motion::planning::parking_planner::Halfplane2D< T >::Halfplane2D ( const Point2D< T > &  coefficients,
right_hand_side 
)
inline

Member Function Documentation

◆ contains_point()

template<typename T >
template<typename S = T, std::enable_if_t< std::is_arithmetic< S >::value, int > = 0>
bool autoware::motion::planning::parking_planner::Halfplane2D< T >::contains_point ( const Point2D< T > &  point) const
inlinenoexcept

Check if a given point is in the halfplane or not.

◆ get_coefficients()

template<typename T >
const Point2D<T>& autoware::motion::planning::parking_planner::Halfplane2D< T >::get_coefficients ( ) const
inlinenoexcept

Get the coefficients of the left-hand side of the halfplane equation.

◆ get_right_hand_side()

template<typename T >
const T& autoware::motion::planning::parking_planner::Halfplane2D< T >::get_right_hand_side ( ) const
inlinenoexcept

Get the right-hand side constant of the halfplane equation.

◆ get_serialized_length()

template<typename T >
static constexpr std::size_t autoware::motion::planning::parking_planner::Halfplane2D< T >::get_serialized_length ( )
inlinestaticnoexcept

Query how many scalars are involved in serializing this halfplane.

◆ serialize()

template<typename T >
std::vector<T> autoware::motion::planning::parking_planner::Halfplane2D< T >::serialize ( ) const
inline

Turn this halfplane into a vector of scalars.


The documentation for this class was generated from the following file: