axom::spin::PointHash< CoordType > Struct Template Reference

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/latest/src/axom/spin/MortonIndex.hpp>

Public Types
using	MortonIndex = std::size_t

Public Member Functions
std::size_t	operator() (CoordType &coord) const
	Mortonizes a coordinate (viewed as a 1D point) More...
std::size_t	operator() (primal::Point< CoordType, 1 > const &pt) const
	Mortonizes a 1D point. More...
std::size_t	operator() (primal::Point< CoordType, 2 > const &pt) const
	Mortonizes a 2D point. More...
std::size_t	operator() (primal::Point< CoordType, 3 > const &pt) const
	Mortonizes a 3D point. More...
std::size_t	operator() (primal::Point< CoordType, 4 > const &pt) const
	Mortonizes a 4D point. More...

Member Typedef Documentation

MortonIndex

template<typename CoordType >

using axom::spin::PointHash< CoordType >::MortonIndex = std::size_t

Member Function Documentation

operator()() [1/5]

template<typename CoordType >

std::size_t axom::spin::PointHash< CoordType >::operator() ( CoordType &  coord ) const

inline

Mortonizes a coordinate (viewed as a 1D point)

Note

This is a no-op and is provided for genericity in point dimension

Parameters

[in]

coord

The coordinate of the

Returns

The morton index of the 1D point

operator()() [2/5]

template<typename CoordType >

std::size_t axom::spin::PointHash< CoordType >::operator() ( primal::Point< CoordType, 1 > const &  pt ) const

inline

Mortonizes a 1D point.

Note

This is a no-op and is provided for genericity in point dimension

Parameters

[in]

pt

The 1D point

Returns

The morton index of the point

operator()() [3/5]

template<typename CoordType >

std::size_t axom::spin::PointHash< CoordType >::operator() ( primal::Point< CoordType, 2 > const &  pt ) const

inline

Mortonizes a 2D point.

Parameters

[in]

pt

The 2D point

Returns

The morton index of the point

operator()() [4/5]

template<typename CoordType >

std::size_t axom::spin::PointHash< CoordType >::operator() ( primal::Point< CoordType, 3 > const &  pt ) const

inline

Mortonizes a 3D point.

Parameters

[in]

pt

The 3D point

Returns

The morton index of the point

operator()() [5/5]

template<typename CoordType >

std::size_t axom::spin::PointHash< CoordType >::operator() ( primal::Point< CoordType, 4 > const &  pt ) const

inline

Mortonizes a 4D point.

Parameters

[in]

pt

The 4D point

Returns

A morton index of the point

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/latest/src/axom/spin/MortonIndex.hpp