The point class represents a point, \( p \in \mathcal{R}^d \) . It provides access methods to set and query the point coordinates. More...

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

Inheritance diagram for axom::primal::Point< T, NDIMS >:

[legend]

Public Types
enum	{ DIMENSION = NDIMS , NBYTES = NDIMS * sizeof(T) }

using	PointType = Point< T, NDIMS >

using	CoordType = T

Public Member Functions
AXOM_HOST_DEVICE	Point (T val=T(), int sz=NDIMS)
	Fill the first sz coordinates with val and zeros the rest. More...

AXOM_HOST_DEVICE	Point (const NumericArray< T, NDIMS > &arr)
	Constructor from a numeric array. More...

AXOM_HOST_DEVICE	Point (const T *vals, int sz=NDIMS)
	Creates a point from the first sz values of the input array. More...

AXOM_HOST_DEVICE	Point (std::initializer_list< T > values)
	Creates a point from an initializer list. More...

AXOM_HOST_DEVICE const NumericArray< T, NDIMS > &	array () const
	Returns a reference to the underlying NumericArray. More...

AXOM_HOST_DEVICE NumericArray< T, NDIMS > &	array ()

AXOM_HOST_DEVICE void	to_array (T *arr) const
	Output the point's coordinates to the array. More...

std::ostream &	print (std::ostream &os) const
	Simple formatted print of a point instance. More...

Overloaded [] operator methods
AXOM_HOST_DEVICE const T &	operator[] (int i) const
	Access operator for individual components. More...

AXOM_HOST_DEVICE T &	operator[] (int i)

Raw data member access methods
AXOM_HOST_DEVICE const T *	data () const
	Returns a pointer to the underlying data. More...

AXOM_HOST_DEVICE T *	data ()

Static Public Member Functions
static constexpr AXOM_HOST_DEVICE int	dimension ()
	Returns the dimension of this point instance. More...

static AXOM_HOST_DEVICE Point	make_point (const T &x, const T &y, const T &z=0.0)
	Utility function to constructs a Point with the given coordinates. More...

static AXOM_HOST_DEVICE Point	midpoint (const Point &A, const Point &B)
	Returns the midpoint between point A and point B. More...

static AXOM_HOST_DEVICE Point	lerp (const Point &A, const Point &B, T alpha)
	Performs linear interpolation/extrapolation between two points. More...

static AXOM_HOST_DEVICE Point	zero ()
	Helper function to return a point whose coordinates are all 0. More...

static AXOM_HOST_DEVICE Point	ones ()
	Helper function to return a point whose coordinates are all 1 This is equivalent to using the single value constructor: Point(1) (with the appropriate casting) and is only valid for Points with a numerical type (i.e. where static_cast<T>(1) is valid. More...

Friends
AXOM_HOST_DEVICE friend bool	operator== (const Point &lhs, const Point &rhs)
	Equality comparison operator for points. More...

AXOM_HOST_DEVICE friend bool	operator!= (const Point &lhs, const Point &rhs)
	Inequality operator for points. More...

Detailed Description

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

The point class represents a point, \( p \in \mathcal{R}^d \) . It provides access methods to set and query the point coordinates.

Template Parameters

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

Member Typedef Documentation

◆ PointType

template<typename T , int NDIMS>

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

◆ CoordType

template<typename T , int NDIMS>

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

Member Enumeration Documentation

◆ anonymous enum

template<typename T , int NDIMS>

anonymous enum

Enumerator
DIMENSION
NBYTES

Constructor & Destructor Documentation

◆ Point() [1/4]

template<typename T , int NDIMS>

AXOM_HOST_DEVICE axom::primal::Point< T, NDIMS >::Point	(	T	val = `T()`,
		int	sz = `NDIMS`
	)

inlineexplicit

Fill the first sz coordinates with val and zeros the rest.

Parameters

[in]	val	The value to set the coordinates to. Defaults to zero
[in]	sz	The number of coordinates to set to val. The rest will be set to zero. Defaults is NDIMS. If sz is greater than NDIMS, we set all coordinates to val

◆ Point() [2/4]

template<typename T , int NDIMS>

AXOM_HOST_DEVICE axom::primal::Point< T, NDIMS >::Point ( const NumericArray< T, NDIMS > & arr )

inlineexplicit

Constructor from a numeric array.

Parameters

[in] arr The numeric array to copy from

◆ Point() [3/4]

template<typename T , int NDIMS>

AXOM_HOST_DEVICE axom::primal::Point< T, NDIMS >::Point	(	const T *	vals,
		int	sz = `NDIMS`
	)

inlineexplicit

Creates a point from the first sz values of the input array.

Parameters

[in]	vals	An array containing at least sz values
[in]	sz	num values to copy from the vals array. Defaults to NDIMS.

Note: If sz is greater than NDIMS, we only take the first NDIMS values.

◆ Point() [4/4]

template<typename T , int NDIMS>

AXOM_HOST_DEVICE axom::primal::Point< T, NDIMS >::Point ( std::initializer_list< T > values )

inline

Creates a point from an initializer list.

Parameters

[in] values an initializer list containing the values of the point. If the size is not the same as the size of this point, this behaves the same way as the constructor which takes a pointer and size.

Member Function Documentation

◆ dimension()

template<typename T , int NDIMS>

static constexpr AXOM_HOST_DEVICE int axom::primal::Point< T, NDIMS >::dimension ( )

inlinestaticconstexpr

Returns the dimension of this point instance.

Returns: d the dimension of the point.

Postcondition: d >= 1.

◆ operator[]() [1/2]

template<typename T , int NDIMS>

AXOM_HOST_DEVICE const T& axom::primal::Point< T, NDIMS >::operator[] ( int i ) const

inline

Access operator for individual components.

Parameters

[in] i the component index to access

Returns: p[i] the value at the given component index.

Precondition: (i >= 0) && (i < ndims)

◆ operator[]() [2/2]

template<typename T , int NDIMS>

AXOM_HOST_DEVICE T& axom::primal::Point< T, NDIMS >::operator[] ( int i )

inline

◆ data() [1/2]

template<typename T , int NDIMS>

AXOM_HOST_DEVICE const T* axom::primal::Point< T, NDIMS >::data ( ) const

inline

Returns a pointer to the underlying data.

References axom::primal::NumericArray< T, SIZE >::data().

◆ data() [2/2]

template<typename T , int NDIMS>

AXOM_HOST_DEVICE T* axom::primal::Point< T, NDIMS >::data ( )

inline

References axom::primal::NumericArray< T, SIZE >::data().

◆ array() [1/2]

template<typename T , int NDIMS>

AXOM_HOST_DEVICE const NumericArray<T, NDIMS>& axom::primal::Point< T, NDIMS >::array ( ) const

inline

Returns a reference to the underlying NumericArray.

◆ array() [2/2]

template<typename T , int NDIMS>

AXOM_HOST_DEVICE NumericArray<T, NDIMS>& axom::primal::Point< T, NDIMS >::array ( )

inline

◆ to_array()

template<typename T , int NDIMS>

AXOM_HOST_DEVICE void axom::primal::Point< T, NDIMS >::to_array ( T * arr ) const

inline

Output the point's coordinates to the array.

Parameters

arr	The array that we are outputting to.

Precondition: The user needs to make sure that the array has been allocated and has sufficient space for NDIMS coordinates.

References axom::primal::NumericArray< T, SIZE >::to_array().

◆ print()

template<typename T , int NDIMS>

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

Simple formatted print of a point instance.

Parameters

os	The output stream to write to

Returns: A reference to the modified ostream

◆ make_point()

template<typename T , int NDIMS>

AXOM_HOST_DEVICE Point< T, NDIMS > axom::primal::Point< T, NDIMS >::make_point	(	const T &	x,
		const T &	y,
		const T &	z = `0.0`
	)

inlinestatic

Utility function to constructs a Point with the given coordinates.

Parameters

[in]	x	the x–coordinate of the point.
[in]	y	the y–coordinate of the point.
[in]	z	the z–coordinate of the point. Default is 0.0.

Returns: p a Point instance with the given coordinates.

◆ midpoint()

template<typename T , int NDIMS>

AXOM_HOST_DEVICE Point< T, NDIMS > axom::primal::Point< T, NDIMS >::midpoint	(	const Point< T, NDIMS > &	A,
		const Point< T, NDIMS > &	B
	)

inlinestatic

Returns the midpoint between point A and point B.

Parameters

[in]	A	user-supplied point
[in]	B	user-supplied point

Returns: p point at the midpoint A and B.

◆ lerp()

template<typename T , int NDIMS>

AXOM_HOST_DEVICE Point< T, NDIMS > axom::primal::Point< T, NDIMS >::lerp	(	const Point< T, NDIMS > &	A,
		const Point< T, NDIMS > &	B,
		T	alpha
	)

inlinestatic

Performs linear interpolation/extrapolation between two points.

Given points A, B and a weight \( \alpha \), this method computes point \( P\) defined by \( P = (1-\alpha) \cdot A + \alpha \cdot B\)

Parameters

[in]	A	user-supplied point
[in]	B	user-supplied point
[in]	alpha	user-supplied scalar weight \( \alpha\)

Returns: P the computed point.

Note: \( \forall\alpha \in [0,1] \) this method linearly interpolates between the two points A, B.; \( \forall\alpha \not\in [0,1] \) the method extrapolates.

Postcondition: \( P==A\) when \( \alpha=0.0\); \( P==B\) when \( \alpha=1.0\); The return point, P, and the user-supplied points A, B are collinear.

◆ zero()

template<typename T , int NDIMS>

static AXOM_HOST_DEVICE Point axom::primal::Point< T, NDIMS >::zero ( )

inlinestatic

Helper function to return a point whose coordinates are all 0.

References axom::primal::Point< T, NDIMS >::Point().

◆ ones()

template<typename T , int NDIMS>

static AXOM_HOST_DEVICE Point axom::primal::Point< T, NDIMS >::ones ( )

inlinestatic

Helper function to return a point whose coordinates are all 1 This is equivalent to using the single value constructor: Point(1) (with the appropriate casting) and is only valid for Points with a numerical type (i.e. where static_cast<T>(1) is valid.

References axom::primal::Point< T, NDIMS >::Point().

Friends And Related Function Documentation

◆ operator==

template<typename T , int NDIMS>

AXOM_HOST_DEVICE friend bool operator==	(	const Point< T, NDIMS > &	lhs,
		const Point< T, NDIMS > &	rhs
	)

friend

Equality comparison operator for points.

◆ operator!=

template<typename T , int NDIMS>

AXOM_HOST_DEVICE friend bool operator!=	(	const Point< T, NDIMS > &	lhs,
		const Point< T, NDIMS > &	rhs
	)

friend

Inequality operator for points.

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

/home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/primal/geometry/Point.hpp

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

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

Member Typedef Documentation

◆ PointType

◆ CoordType

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ Point() [1/4]

◆ Point() [2/4]

◆ Point() [3/4]

◆ Point() [4/4]

Member Function Documentation

◆ dimension()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ data() [1/2]

◆ data() [2/2]

◆ array() [1/2]

◆ array() [2/2]

◆ to_array()

◆ print()

◆ make_point()

◆ midpoint()

◆ lerp()

◆ zero()

◆ ones()

Friends And Related Function Documentation

◆ operator==

◆ operator!=

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