PatternRingGodel Class Reference

Standard RingGodel with an added mask to use when checking if two RingGodels match. More...

#include <RingGodel.hpp>

Inheritance diagram for PatternRingGodel:

Public Member Functions
	PatternRingGodel ()
	Constructs pattern ring godel with empty mask.
virtual	~PatternRingGodel ()
	Destructor.
virtual void	SetEmpty ()
	Sets the godel and mask to empty.
void	AddSliceToMask (int slice)
	Adds the given slice to the mask.
bool	MatchesGodel (const RingGodel &godel) const
	Returns true if we match godel on our mask.
void	AddColorToSlice (int slice, HexColor color)
	Adds BLACK, WHITE or EMPTY to slice in ring_godel.
void	RemoveColorFromSlice (int slice, HexColor color)
	Removes a color from a slice: color can be BLACK, WHITE, EMPTY.
void	SetSliceToColor (int slice, HexColor color)
	Sets the color of slice: color can be BLACK, WHITE, EMPTY.
int	Index () const
	Returns the index of this ring_godel; use to hash into arrays.
int	Value () const
	Returns godel as an integer.
Static Public Member Functions
static const std::vector < RingGodel > &	ValidGodels ()
	Returns the valid ring godels.
Static Protected Member Functions
static int	Score (HexColor color)
	Score for color in a slice.
static int	AdjustScoreBySlice (int score, int slice)
	Adjusts a score by the slice.
Protected Attributes
int	m_value
	The actual godel value.
Static Protected Attributes
static const int	BITS_PER_SLICE = 3
	Number of bits to use for each slice in the ring godel.
static const int	SLICE_MASK = 7
	Sould be 1<<(BITS_PER_SLICE) - 1.
Private Attributes
int	m_mask

Detailed Description

Standard RingGodel with an added mask to use when checking if two RingGodels match.

Definition at line 128 of file RingGodel.hpp.

Constructor & Destructor Documentation

PatternRingGodel::PatternRingGodel ( )

Constructs pattern ring godel with empty mask.

Definition at line 85 of file RingGodel.cpp.

PatternRingGodel::~PatternRingGodel ( ) [virtual]

Destructor.

Definition at line 91 of file RingGodel.cpp.

Member Function Documentation

void RingGodel::AddColorToSlice	(	int	slice,
		HexColor	color
	)			`[inherited]`

Adds BLACK, WHITE or EMPTY to slice in ring_godel.

Definition at line 54 of file RingGodel.cpp.

References RingGodel::GlobalData::color_slice_score, RingGodel::GetGlobalData(), and RingGodel::m_value.

Referenced by PatternState::Update(), and PatternState::UpdateRingGodel().

void PatternRingGodel::AddSliceToMask ( int slice )

Adds the given slice to the mask.

Definition at line 101 of file RingGodel.cpp.

References RingGodel::AdjustScoreBySlice(), m_mask, and RingGodel::SLICE_MASK.

Referenced by Pattern::compute_ring_godel().

int RingGodel::AdjustScoreBySlice	(	int	score,
		int	slice
	)			`[inline, static, protected, inherited]`

Adjusts a score by the slice.

Definition at line 107 of file RingGodel.hpp.

References RingGodel::BITS_PER_SLICE.

Referenced by AddSliceToMask(), and RingGodel::GlobalData::GlobalData().

int RingGodel::Index ( ) const [inherited]

Returns the index of this ring_godel; use to hash into arrays.

Definition at line 78 of file RingGodel.cpp.

References RingGodel::GetValidGodelData(), RingGodel::ValidGodelData::godel_to_index, and RingGodel::m_value.

Referenced by HashedPatternSet::ListForGodel().

bool PatternRingGodel::MatchesGodel ( const RingGodel & godel ) const

Returns true if we match godel on our mask.

For a match to occur, each corresponding slice in godel must be a superset of the slice in this godel. If godel has BW, then B or W or BW will match it, but if we have BW, only BW in godel will match.

Definition at line 106 of file RingGodel.cpp.

References m_mask, RingGodel::m_value, and RingGodel::Value().

Referenced by PatternState::CheckRingGodel(), and HashedPatternSet::hash().