#include <halfSpace.h>

Collaboration diagram for irafhy::HalfSpace:

Public Member Functions
	HalfSpace ()
	default constructor More...

	HalfSpace (const HalfSpace &halfSpace)=default
	copy constructor More...

	HalfSpace (HalfSpace &&halfSpace)=default
	move constructor More...

	HalfSpace (const Eigen::VectorXd &normal, double offset)
	constructor with given normal and offset More...

	HalfSpace (Eigen::VectorXd &&normal, double &&offset)
	constructor with given normal and offset More...

virtual	~HalfSpace ()=default
	destructor More...

int	dimension () const
	get the dimension of the half space More...

Eigen::VectorXd	normal () const
	get the normal of the half space More...

double	offset () const
	get the offset of the half space More...

bool	contains (const Point &point) const
	check if the given point inside the half space or not More...

bool	contains (const Eigen::VectorXd &coordinate) const
	check the given coordinate inside the half space or not More...

bool	holds (const Point &point) const
	check if the given point on the boundary of the half space or not More...

bool	holds (const Eigen::VectorXd &coordinate) const
	check if the given coordinate on the boundary of the half space More...

bool	intersect (const Eigen::VectorXd &lhsEndPoint, const Eigen::VectorXd &rhsEndPoint, Eigen::VectorXd &intersection) const
	check if the line segment between two points intersect with the half space or not More...

HalfSpace &	operator= (const HalfSpace &halfSpace)=default
	assignment operator More...

HalfSpace &	operator= (HalfSpace &&halfSpace) noexcept=default
	assignment operator More...

HalfSpace &	operator- ()
	reverse the normal of the half space More...

HalfSpace &	reverse ()
	reverse the normal the of the half space More...

Static Public Member Functions
static HalfSpace	Empty (std::size_t dimension=0)
	static constructor of Empty half space object More...

Private Attributes
Eigen::VectorXd	normal_
	normal of the half space which defined by normal * x + offset <= 0 More...

double	offset_
	offset used to define the half space More...

Constructor & Destructor Documentation

◆ HalfSpace() [1/5]

irafhy::HalfSpace::HalfSpace ( )

default constructor

References normal_, and offset_.

Referenced by Empty().

◆ HalfSpace() [2/5]

irafhy::HalfSpace::HalfSpace ( const HalfSpace & halfSpace )

default

copy constructor

Parameters

halfSpace given half space

◆ HalfSpace() [3/5]

irafhy::HalfSpace::HalfSpace ( HalfSpace && halfSpace )

default

move constructor

Parameters

halfSpace given half space

◆ HalfSpace() [4/5]

irafhy::HalfSpace::HalfSpace	(	const Eigen::VectorXd &	normal,
		double	offset
	)

constructor with given normal and offset

Parameters

normal	given normal
offset	given offset

References normal(), normal_, offset(), and offset_.

Here is the call graph for this function:

◆ HalfSpace() [5/5]

irafhy::HalfSpace::HalfSpace	(	Eigen::VectorXd &&	normal,
		double &&	offset
	)

constructor with given normal and offset

Parameters

normal	given normal
offset	given offset

References normal(), normal_, offset(), and offset_.

Here is the call graph for this function:

◆ ~HalfSpace()

virtual irafhy::HalfSpace::~HalfSpace ( )

virtualdefault

destructor

Member Function Documentation

◆ contains() [1/2]

bool irafhy::HalfSpace::contains ( const Point & point ) const

check if the given point inside the half space or not

Parameters

point given point

Returns: TRUE if the given point inside the half space

References irafhy::Point::coordinate(), normal_, and offset_.

Here is the call graph for this function:

◆ contains() [2/2]

bool irafhy::HalfSpace::contains ( const Eigen::VectorXd & coordinate ) const

check the given coordinate inside the half space or not

Parameters

coordinate given coordinate

Returns: TRUE if the given coordinate inside the half space

References normal_, and offset_.

◆ dimension()

int irafhy::HalfSpace::dimension ( ) const

get the dimension of the half space

Returns: the dimension of the half space

References normal_.

Referenced by intersect(), and irafhy::operator<<().

◆ Empty()

HalfSpace irafhy::HalfSpace::Empty ( std::size_t dimension = 0 )

static

static constructor of Empty half space object

Parameters

dimension dimension of the half space

Returns: Empty half space object in given dimension space

References HalfSpace().

Referenced by irafhy::Polytope::Empty().

Here is the call graph for this function:

◆ holds() [1/2]

bool irafhy::HalfSpace::holds ( const Point & point ) const

check if the given point on the boundary of the half space or not

Parameters

point given point

Returns: TRUE if the given coordinate hold the constraint which defines the half space

References irafhy::Point::coordinate(), normal_, and offset_.

Here is the call graph for this function:

◆ holds() [2/2]

bool irafhy::HalfSpace::holds ( const Eigen::VectorXd & coordinate ) const

check if the given coordinate on the boundary of the half space

Parameters

coordinate given coordinate

Returns: TRUE if the given coordinate hold the constraint which defines the half space

References normal_, and offset_.

◆ intersect()

bool irafhy::HalfSpace::intersect	(	const Eigen::VectorXd &	lhsEndPoint,
		const Eigen::VectorXd &	rhsEndPoint,
		Eigen::VectorXd &	intersection
	)		const

check if the line segment between two points intersect with the half space or not

Parameters

lhsEndPoint	left hand side point of the line segment
rhsEndPoint	right hand side point of the line segment
intersection	intersection of the line segment with the half space

Returns: TRUE if the line segment intersect with the half space

References dimension(), normal_, and offset_.

Here is the call graph for this function:

◆ normal()

Eigen::VectorXd irafhy::HalfSpace::normal ( ) const

get the normal of the half space

Returns: the normal of the half space

References normal_.

Referenced by HalfSpace(), and irafhy::operator<<().

◆ offset()

double irafhy::HalfSpace::offset ( ) const

get the offset of the half space

Returns: the offset of the half space

References offset_.

Referenced by HalfSpace(), and irafhy::operator<<().

◆ operator-()

HalfSpace & irafhy::HalfSpace::operator- ( )

reverse the normal of the half space

Returns: resulting half space

References normal_, and offset_.

◆ operator=() [1/2]

HalfSpace& irafhy::HalfSpace::operator= ( const HalfSpace & halfSpace )

default

assignment operator

Parameters

halfSpace right hand side half space object

Returns: resulting half space

◆ operator=() [2/2]

HalfSpace& irafhy::HalfSpace::operator= ( HalfSpace && halfSpace )

defaultnoexcept

assignment operator

Parameters

halfSpace right hand side half space object

Returns: resulting half space

◆ reverse()

HalfSpace & irafhy::HalfSpace::reverse ( )

reverse the normal the of the half space

Returns: resulting half space

References normal_, and offset_.

Member Data Documentation

◆ normal_

Eigen::VectorXd irafhy::HalfSpace::normal_

private

normal of the half space which defined by normal * x + offset <= 0

Referenced by contains(), dimension(), HalfSpace(), holds(), intersect(), normal(), operator-(), and reverse().

◆ offset_

double irafhy::HalfSpace::offset_

private

offset used to define the half space

Referenced by contains(), HalfSpace(), holds(), intersect(), offset(), operator-(), and reverse().

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

/home/jianqiang/CLionProjects/irafhy/include/irafhy/representation/geometric/basic/halfSpace.h
/home/jianqiang/CLionProjects/irafhy/src/representation/geometric/basic/halfSpace.cpp

Public Member Functions

Static Public Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ HalfSpace() [1/5]

◆ HalfSpace() [2/5]

◆ HalfSpace() [3/5]

◆ HalfSpace() [4/5]

◆ HalfSpace() [5/5]

◆ ~HalfSpace()

Member Function Documentation

◆ contains() [1/2]

◆ contains() [2/2]

◆ dimension()

◆ Empty()

◆ holds() [1/2]

◆ holds() [2/2]

◆ intersect()

◆ normal()

◆ offset()

◆ operator-()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ reverse()

Member Data Documentation

◆ normal_

◆ offset_