区画ベースではなく、壁ベースの管理ID [詳解]

#include <Maze.h>

公開メンバ関数
constexpr	WallIndex ()
	デフォルトコンストラク [詳解]

constexpr	WallIndex (const int8_t x, const int8_t y, const uint8_t z)
	成分を受け取ってそのまま格納するコンストラクタ [詳解]

constexpr	WallIndex (const Position p, const Direction d)
	表現の冗長性を除去して格納するコンストラクタ [詳解]

constexpr	WallIndex (const uint16_t i)
	IDを使って初期化するコンストラクタ [詳解]

bool	operator== (const WallIndex i) const
	等号 [詳解]

bool	operator!= (const WallIndex i) const
	等号否定 [詳解]

uint16_t	getIndex () const
	迷路内の壁を一意な通し番号として表現したIDを返す。 [詳解]

Position	getPosition () const
	位置の取得 [詳解]

Direction	getDirection () const
	方向の取得 [詳解]

bool	isInsideOfField () const
	壁がフィールド内か判定する関数 [詳解]

WallIndex	next (const Direction d) const
	引数方向の WallIndex を取得する関数 [詳解]

std::array< Direction, 6 >	getNextDirection6 () const
	現在壁に隣接する、柱ではない6方向を取得 [詳解]

公開変数類
union {
struct {
int8_t x
	区画座標のx成分 [詳解]

int8_t y: 7
	区画座標のy成分 [詳解]

uint8_t z: 1
	区画内の壁の位置。0:East, 1:North [詳解]

}

uint16_t data
	データ全体へのアクセス用 [詳解]

};

静的公開変数類
static constexpr int	SIZE = MAZE_SIZE_MAX * MAZE_SIZE_MAX * 2
	壁を unique な通し番号として表現したときの総数。配列の確保などで使用できる。 [詳解]

フレンド
std::ostream &	operator<< (std::ostream &os, const WallIndex i)
	表示用演算子のオーバーロード。 ( x, y, d) の形式 [詳解]

詳解

区画ベースではなく、壁ベースの管理ID

uint16_t にキャストすることで全部の壁が通し番号になったIDを取得できるという特徴がある。迷路内部の壁の総数 WallIndex::SIZE 個の配列を確保しておけば、取得したIDをインデックスとして使える。そのとき、 WallIndex が迷路の内部にあるかどうか確認すること。(配列の範囲外アクセス防止) isInsideOfField() 関数により迷路の内部に位置するか確認できる。最初から全部が通し番号のIDで保持してしまうと、迷路の範囲外の壁を表現できなくなってしまうため、必要に応じてIDを生成するようになっている。

     [x, y]    : Cell Position
            z  : Wall Distinction in the Cell; 0:East, 1:North
  => (x, y, z) : Wall Index
+-------------+-------------+-------------+
|             |             |             |
|     Cell   Wall           |             |
|             |             |             |
+--- z = 1 ---+- (x, y, 1) -+-------------+
|             |             |             |
|    (x-1, y, 0)  [ x, y]  (x, y, 0)      |
|             |             |             |
+--- z = 1 ---+- (x,y-1,1) -+-------------+
|             |             |             |
|           z = 0         z = 0           |
|             |             |             |
+-------------+-------------+-------------+

構築子と解体子

◆ WallIndex() [1/4]

constexpr MazeLib::WallIndex::WallIndex ( )

inlineconstexpr

デフォルトコンストラク

477 : data(0) {}

MazeLib::WallIndex::data

uint16_t data

データ全体へのアクセス用

Definition: Maze.h:469

◆ WallIndex() [2/4]

constexpr MazeLib::WallIndex::WallIndex	(	const int8_t	x,
		const int8_t	y,
		const uint8_t	z
	)

inlineconstexpr

成分を受け取ってそのまま格納するコンストラクタ

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

◆ WallIndex() [3/4]

constexpr MazeLib::WallIndex::WallIndex	(	const Position	p,
		const Direction	d
	)

inlineconstexpr

表現の冗長性を除去して格納するコンストラクタ

引数

p	区画位置
d	区画内方向。4方位

                                                            : x(p.x), y(p.y) {
     uniquify(d);
   }

◆ WallIndex() [4/4]

constexpr MazeLib::WallIndex::WallIndex ( const uint16_t i )

inlineconstexpr

IDを使って初期化するコンストラクタ

引数

i	壁の通し番号ID。迷路内の壁であること。

注意: 迷路外の壁の場合未定義動作となる。

       : x(i & (MAZE_SIZE_MAX - 1)),
         y((i >> MAZE_SIZE_BIT) & (MAZE_SIZE_MAX - 1)),
         z(i >> (2 * MAZE_SIZE_BIT)) {}

関数詳解

◆ getDirection()

Direction MazeLib::WallIndex::getDirection ( ) const

inline

方向の取得

                                  {
     // return z == 0 ? Direction::East : Direction::North;
     return z << 1;  //< 高速化
   }

◆ getIndex()

uint16_t MazeLib::WallIndex::getIndex ( ) const

inline

迷路内の壁を一意な通し番号として表現したIDを返す。

注意: 迷路外の壁の場合未定義動作となる。 WallIndex::isInsideOfField() で迷路区画内か確認すること。

戻り値: uint16_t ID

                             {
     // return (z << (2 * MAZE_SIZE_BIT)) | (y << MAZE_SIZE_BIT) | x;
     return (z << (MAZE_SIZE_BIT << 1)) | (y << MAZE_SIZE_BIT) | x;  //< 高速化
   }

◆ getNextDirection6()

std::array<Direction, 6> MazeLib::WallIndex::getNextDirection6 ( ) const

inline

現在壁に隣接する、柱ではない6方向を取得

戻り値: std::array<Direction, 6> 隣接方向の配列

                                                    {
     const auto d = getDirection();
     return {{
         d + Direction::Front,
         d + Direction::Back,
         d + Direction::Left45,
         d + Direction::Right45,
         d + Direction::Left135,
         d + Direction::Right135,
     }};
   }

呼び出し関係図:

◆ getPosition()

Position MazeLib::WallIndex::getPosition ( ) const

inline

位置の取得

521 { return Position(x, y); }

◆ isInsideOfField()

bool MazeLib::WallIndex::isInsideOfField ( ) const

inline

壁がフィールド内か判定する関数

(x, y) が (0, 0) と (MAZE_SIZE-1, MAZE_SIZE-1) の間、かつ、 z が外周上でない

戻り値: true フィールド内; false フィールド外(外周上を含む)

                                {
     /* x,y が フィールド内かつ、外周上にいない */
     // return !(x < 0 || y < 0 || x >= MAZE_SIZE || y >= MAZE_SIZE ||
     //          (z == 0 && (x == MAZE_SIZE - 1)) ||
     //          (z == 1 && (y == MAZE_SIZE - 1)));
     /* 高速化 */
     return (static_cast<uint8_t>(x) < MAZE_SIZE - 1 + z) &&
            (static_cast<uint8_t>(y) < MAZE_SIZE - z);
   }

◆ next()

WallIndex MazeLib::WallIndex::next ( const Direction d ) const

引数方向の WallIndex を取得する関数

引数

d 隣接方向

戻り値: WallIndex 隣接壁

                                                  {
   switch (d) {
     case Direction::East:
       return WallIndex(x + 1, y, z);
     case Direction::NorthEast:
       return WallIndex(x + 1 - z, y + z, 1 - z);
     case Direction::North:
       return WallIndex(x, y + 1, z);
     case Direction::NorthWest:
       return WallIndex(x - z, y + z, 1 - z);
     case Direction::West:
       return WallIndex(x - 1, y, z);
     case Direction::SouthWest:
       return WallIndex(x - z, y - 1 + z, 1 - z);
     case Direction::South:
       return WallIndex(x, y - 1, z);
     case Direction::SouthEast:
       return WallIndex(x + 1 - z, y - 1 + z, 1 - z);
     default:
       MAZE_LOGE << d << std::endl;
       return WallIndex(x, y, z);
   }
 }

呼び出し関係図:

◆ operator!=()

bool MazeLib::WallIndex::operator!= ( const WallIndex i ) const

inline

等号否定

                                            {
     // return x != i.x || y != i.y || z != i.z;
     return data != i.data;  //< 高速化
   }

◆ operator==()

bool MazeLib::WallIndex::operator== ( const WallIndex i ) const

inline

等号

                                            {
     // return x == i.x && y == i.y && z == i.z;
     return data == i.data;  //< 高速化
   }

フレンドと関連関数の詳解

◆ operator<<

std::ostream& operator<<	(	std::ostream &	os,
		const WallIndex	i
	)

friend

表示用演算子のオーバーロード。 ( x, y, d) の形式

                                                           {
   return os << "( " << std::setw(2) << +i.x << ", " << std::setw(2) << +i.y
             << ", " << i.getDirection().toChar() << ")";
 }

メンバ詳解

◆

union { ... }

◆ data

uint16_t MazeLib::WallIndex::data

データ全体へのアクセス用

◆ SIZE

constexpr int MazeLib::WallIndex::SIZE = MAZE_SIZE_MAX * MAZE_SIZE_MAX * 2

staticconstexpr

壁を unique な通し番号として表現したときの総数。配列の確保などで使用できる。

◆ x

int8_t MazeLib::WallIndex::x

区画座標のx成分

◆ y

int8_t MazeLib::WallIndex::y

区画座標のy成分

◆ z

uint8_t MazeLib::WallIndex::z

区画内の壁の位置。0:East, 1:North

この構造体詳解は次のファイルから抽出されました:

include/MazeLib/Maze.h
src/Maze.cpp

公開メンバ関数

公開変数類

静的公開変数類

フレンド

詳解

構築子と解体子

◆ WallIndex() [1/4]

◆ WallIndex() [2/4]

◆ WallIndex() [3/4]

◆ WallIndex() [4/4]

関数詳解

◆ getDirection()

◆ getIndex()

◆ getNextDirection6()

◆ getPosition()

◆ isInsideOfField()

◆ next()

◆ operator!=()

◆ operator==()

フレンドと関連関数の詳解

◆ operator<<

メンバ詳解

◆

◆ data

◆ SIZE

◆ x

◆ y

◆ z