axom::bump::AveragePoints< T, NDIMS > Struct Template Reference

Average a series of points. More...

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/main/src/axom/bump/PrimalAdaptor.hpp>

Public Types
using	PointType = axom::primal::Point< T, NDIMS >
using	VectorType = axom::primal::Vector< T, NDIMS >

Public Member Functions
AXOM_HOST_DEVICE void	add (const PointType &pt)
	Add a point to the running sum. More...
AXOM_HOST_DEVICE void	clear ()
	Clear the sum. More...
AXOM_HOST_DEVICE PointType	get () const
	Get the average point value. More...

Public Attributes
VectorType	sum {}
int	numPoints {0}

Detailed Description

template<typename T, int NDIMS>
struct axom::bump::AveragePoints< T, NDIMS >

Average a series of points.

Template Parameters

T	The point precision.
NDIMS	The number of dimensions in the point.

Member Typedef Documentation

PointType

template<typename T , int NDIMS>

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

VectorType

template<typename T , int NDIMS>

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

Member Function Documentation

add()

template<typename T , int NDIMS>

AXOM_HOST_DEVICE void axom::bump::AveragePoints< T, NDIMS >::add ( const PointType &  pt )

inline

Add a point to the running sum.

Parameters

pt	The point to add.

References axom::bump::AveragePoints< T, NDIMS >::numPoints, and axom::bump::AveragePoints< T, NDIMS >::sum.

clear()

template<typename T , int NDIMS>

AXOM_HOST_DEVICE void axom::bump::AveragePoints< T, NDIMS >::clear ( )

inline

Clear the sum.

References axom::bump::AveragePoints< T, NDIMS >::numPoints, and axom::bump::AveragePoints< T, NDIMS >::sum.

get()

template<typename T , int NDIMS>

AXOM_HOST_DEVICE PointType axom::bump::AveragePoints< T, NDIMS >::get ( ) const

inline

Get the average point value.

Returns

The average point value.

References axom::primal::Vector< T, NDIMS >::array(), axom::bump::AveragePoints< T, NDIMS >::numPoints, and axom::bump::AveragePoints< T, NDIMS >::sum.

Member Data Documentation

sum

template<typename T , int NDIMS>

VectorType axom::bump::AveragePoints< T, NDIMS >::sum {}

numPoints

template<typename T , int NDIMS>

int axom::bump::AveragePoints< T, NDIMS >::numPoints {0}

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/main/src/axom/bump/PrimalAdaptor.hpp