axom::primal::Line< T, NDIMS > Class Template Reference

Represents a line, \( L(t) \in \mathcal{R}^d \) , defined by an origin point, \( P \) and a normalized direction vector, \( \vec{d} \), \( \ni L(t)= P + t\vec{d} \forall t \in \mathcal{R} \). More...

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/main/src/axom/primal/geometry/Line.hpp>

Public Types
using	CoordType = T
using	PointType = Point< T, NDIMS >
using	SegmentType = Segment< T, NDIMS >
using	VectorType = Vector< T, NDIMS >

Public Member Functions
	Line ()=delete
AXOM_HOST_DEVICE	Line (const PointType &origin, const VectorType &direction)
	Constructs a line object with the given origin and direction. More...
	Line (const SegmentType &S)
	Constructs a line object from a directed segment. \params [in] S user-supplied segment. More...
AXOM_HOST_DEVICE const PointType &	origin () const
	Returns the origin of this Line instance. More...
AXOM_HOST_DEVICE PointType	at (const T &t) const
	Returns a point along the line by evaluating \( L(t) \). More...
AXOM_HOST_DEVICE const VectorType &	direction () const
	Returns the direction vector of this Line instance. More...
std::ostream &	print (std::ostream &os) const
	Simple formatted print of a line instance. More...

Detailed Description

template<typename T, int NDIMS>
class axom::primal::Line< T, NDIMS >

Represents a line, \( L(t) \in \mathcal{R}^d \) , defined by an origin point, \( P \) and a normalized direction vector, \( \vec{d} \), \( \ni L(t)= P + t\vec{d} \forall t \in \mathcal{R} \).

Template Parameters

T	the coordinate type, e.g., double, float, etc.
NDIMS	the number of dimensions

Member Typedef Documentation

CoordType

template<typename T , int NDIMS>

using axom::primal::Line< T, NDIMS >::CoordType = T

PointType

template<typename T , int NDIMS>

using axom::primal::Line< T, NDIMS >::PointType = Point<T, NDIMS>

SegmentType

template<typename T , int NDIMS>

using axom::primal::Line< T, NDIMS >::SegmentType = Segment<T, NDIMS>

VectorType

template<typename T , int NDIMS>

using axom::primal::Line< T, NDIMS >::VectorType = Vector<T, NDIMS>

Constructor & Destructor Documentation

Line() [1/3]

template<typename T , int NDIMS>

axom::primal::Line< T, NDIMS >::Line ( )

delete

Line() [2/3]

template<typename T , int NDIMS>

AXOM_HOST_DEVICE axom::primal::Line< T, NDIMS >::Line	(	const PointType &	origin,
		const VectorType &	direction
	)

Constructs a line object with the given origin and direction.

Parameters

[in]	origin	the origin of the line.
[in]	direction	the direction of the line.

Precondition

direction.squared_norm()!= 0.0

References SLIC_ASSERT, and axom::primal::Vector< T, NDIMS >::squared_norm().

Line() [3/3]

template<typename T , int NDIMS>

axom::primal::Line< T, NDIMS >::Line ( const SegmentType &  S )

explicit

Constructs a line object from a directed segment. \params [in] S user-supplied segment.

References SLIC_ASSERT, and axom::primal::Vector< T, NDIMS >::squared_norm().

Member Function Documentation

origin()

template<typename T , int NDIMS>

AXOM_HOST_DEVICE const PointType& axom::primal::Line< T, NDIMS >::origin ( ) const

inline

Returns the origin of this Line instance.

Returns

origin a point instance corresponding to the origin of the line.

at()

template<typename T , int NDIMS>

AXOM_HOST_DEVICE Point< T, NDIMS > axom::primal::Line< T, NDIMS >::at ( const T &  t ) const

inline

Returns a point along the line by evaluating \( L(t) \).

Parameters

[in]

t

user-supplied value for L(t).

Returns

p a point along the line.

direction()

template<typename T , int NDIMS>

AXOM_HOST_DEVICE const VectorType& axom::primal::Line< T, NDIMS >::direction ( ) const

inline

Returns the direction vector of this Line instance.

Returns

direction the direction vector of the line.

Postcondition

direction.norm()==1

print()

template<typename T , int NDIMS>

std::ostream& axom::primal::Line< T, NDIMS >::print ( std::ostream &  os ) const

inline

Simple formatted print of a line instance.

Parameters

os	The output stream to write to

Returns

A reference to the modified ostream

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/main/src/axom/primal/geometry/Line.hpp