ground_segmentation::Index3D Struct Reference

Integer 3D grid index used as key in hash map. More...

#include <ground_detection_types.hpp>

Classes
struct	HashFunction

Public Member Functions
	Index3D (int x, int y, int z)
	Index3D ()
bool	operator== (const Index3D &oth) const
Index3D	operator+ (Index3D const &obj) const

Public Attributes
int	x
int	y
int	z

Detailed Description

Integer 3D grid index used as key in hash map.

Provides:

• Hash function for unordered_map
• Equality operator
• Offset addition operator

Designed for efficient sparse 3D grid storage.

Definition at line 144 of file ground_detection_types.hpp.

Constructor & Destructor Documentation

Index3D() [1/2]

ground_segmentation::Index3D::Index3D ( int  x, int  y, int  z  )

inline

Definition at line 146 of file ground_detection_types.hpp.

  : x(x), y(y), z(z) {}

Index3D() [2/2]

ground_segmentation::Index3D::Index3D ( )

inline

Definition at line 148 of file ground_detection_types.hpp.

  {
    x = std::numeric_limits<int>::min();
    y = std::numeric_limits<int>::min();
    z = std::numeric_limits<int>::min();
  }

References x, y, and z.

Referenced by operator+().

Here is the caller graph for this function:

Member Function Documentation

operator+()

Index3D ground_segmentation::Index3D::operator+ ( Index3D const &  obj ) const

inline

Definition at line 169 of file ground_detection_types.hpp.

  {
    return Index3D(x + obj.x, y + obj.y, z + obj.z);
  }

References Index3D(), x, y, and z.

Here is the call graph for this function:

operator==()

bool ground_segmentation::Index3D::operator== ( const Index3D &  oth ) const

inline

Definition at line 164 of file ground_detection_types.hpp.

  {
    return (x == oth.x) & (y == oth.y) & (z == oth.z); // use non-lazy `&` to avoid branching
  }

References x, y, and z.

Member Data Documentation

x

int ground_segmentation::Index3D::x

Definition at line 154 of file ground_detection_types.hpp.

Referenced by ground_segmentation::PointCloudGrid< PointT >::findNearestGroundNeighbor(), ground_segmentation::PointCloudGrid< PointT >::generateIndices(), ground_segmentation::PointCloudGrid< PointT >::getNeighbors(), Index3D(), ground_segmentation::Index3D::HashFunction::operator()(), operator+(), and operator==().

y

int ground_segmentation::Index3D::y

Definition at line 154 of file ground_detection_types.hpp.

Referenced by ground_segmentation::PointCloudGrid< PointT >::findNearestGroundNeighbor(), ground_segmentation::PointCloudGrid< PointT >::generateIndices(), ground_segmentation::PointCloudGrid< PointT >::getNeighbors(), Index3D(), ground_segmentation::Index3D::HashFunction::operator()(), operator+(), and operator==().

z

int ground_segmentation::Index3D::z

Definition at line 154 of file ground_detection_types.hpp.

Referenced by ground_segmentation::PointCloudGrid< PointT >::findNearestGroundNeighbor(), ground_segmentation::PointCloudGrid< PointT >::generateIndices(), ground_segmentation::PointCloudGrid< PointT >::getNeighbors(), Index3D(), ground_segmentation::Index3D::HashFunction::operator()(), operator+(), and operator==().

---

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

• /home/runner/work/ground_segmentation/ground_segmentation/include/ground_detection_types.hpp