baseCells.h File Reference

Base cell related lookup tables and access functions. More...

#include "QueryEngine/ExtensionFunctions/h3lib/include/constants.h"
#include "QueryEngine/ExtensionFunctions/h3lib/include/faceijk.h"
#include "QueryEngine/ExtensionFunctions/h3lib/lib/baseCells.hpp"

Include dependency graph for baseCells.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	BaseCellData
	information on a single base cell More...

Macros
#define	MAX_FACE_COORD   2

Functions
EXTENSION_INLINE int	_isBaseCellPentagon (int baseCell)
	Return whether or not the indicated base cell is a pentagon. More...
EXTENSION_INLINE int	_faceIjkToBaseCell (const FaceIJK(h))
	Return whether the indicated base cell is a pentagon where all neighbors are oriented towards it. More...
EXTENSION_INLINE int	_faceIjkToBaseCellCCWrot60 (const FaceIJK(h))
	Find base cell given FaceIJK. More...
EXTENSION_INLINE bool	_baseCellIsCwOffset (int baseCell, int testFace)
	Find the FaceIJK given a base cell. More...

Detailed Description

Base cell related lookup tables and access functions.

Definition in file baseCells.h.

Macro Definition Documentation

#define MAX_FACE_COORD   2

Maximum input for any component to face-to-base-cell lookup functions

Definition at line 45 of file baseCells.h.

Referenced by _faceIjkToH3().

Function Documentation

EXTENSION_INLINE bool _baseCellIsCwOffset	(	int	baseCell,
		int	testFace
	)

Find the FaceIJK given a base cell.

Given a base cell and the face it appears on, return the number of 60' ccw rotations for that base cell's coordinate system.

Returns

The number of rotations, or INVALID_ROTATIONS if the base cell is not found on the given faceReturn whether or not the tested face is a cw offset face.

Definition at line 887 of file baseCells.hpp.

References baseCellData, and BaseCellData::cwOffsetPent.

Referenced by _faceIjkToH3().

                                                                      {
  return baseCellData[baseCell].cwOffsetPent[0] == testFace ||
         baseCellData[baseCell].cwOffsetPent[1] == testFace;
}

Here is the caller graph for this function:

EXTENSION_INLINE int _faceIjkToBaseCell

(

const

FaceIJKh

)

Return whether the indicated base cell is a pentagon where all neighbors are oriented towards it.

Find base cell given FaceIJK.

Given the face number and a resolution 0 ijk+ coordinate in that face's face-centered ijk coordinate system, return the base cell located at that coordinate.

Valid ijk+ lookup coordinates are from (0, 0, 0) to (2, 2, 2).

Definition at line 842 of file baseCells.hpp.

References BaseCellRotation::baseCell, FACE_INDEX, faceIjkBaseCells, I_INDEX, J_INDEX, and K_INDEX.

Referenced by _faceIjkToH3().

                                                          {
  return faceIjkBaseCells[h[FACE_INDEX]][h[I_INDEX]][h[J_INDEX]][h[K_INDEX]].baseCell;
}

Here is the caller graph for this function:

EXTENSION_INLINE int _faceIjkToBaseCellCCWrot60

(

const

FaceIJKh

)

Find base cell given FaceIJK.

Given the face number and a resolution 0 ijk+ coordinate in that face's face-centered ijk coordinate system, return the number of 60' ccw rotations to rotate into the coordinate system of the base cell at that coordinates.

Valid ijk+ lookup coordinates are from (0, 0, 0) to (2, 2, 2).

Definition at line 854 of file baseCells.hpp.

References BaseCellRotation::ccwRot60, FACE_INDEX, faceIjkBaseCells, I_INDEX, J_INDEX, and K_INDEX.

Referenced by _faceIjkToH3().

                                                                  {
  return faceIjkBaseCells[h[FACE_INDEX]][h[I_INDEX]][h[J_INDEX]][h[K_INDEX]].ccwRot60;
}

Here is the caller graph for this function:

EXTENSION_INLINE int _isBaseCellPentagon

(

int

baseCell

)

Return whether or not the indicated base cell is a pentagon.

Invalid number of rotations

Definition at line 824 of file baseCells.hpp.

References baseCellData, and BaseCellData::isPentagon.

Referenced by _faceIjkToH3(), _h3ToFaceIjk(), and _h3ToFaceIjkWithInitializedFijk().

                                                       {
  return baseCellData[baseCell].isPentagon;
}

Here is the caller graph for this function: