def test_cube_rotate(self):
# Create new testing cube face since the value get changed.
cube_face = Face(face_input=self.face_input, side_length=3)
# Rotate the face and check if it contains desired value.
cube_face.rotate_by_angle(angle=90)
assert np.array_equal(cube_face.get_item_list,
[6, 3, 0, 7, 4, 1, 8, 5, 2])
class TestCubeFace:
# Setup testing input.
face_input = [item for item in range(9)]
cube_face = Face(face_input=face_input, side_length=3)
def test_cube_face(self):
assert np.array_equal(self.cube_face.get_item_list, self.face_input)
def test_cube_row(self):
# Get rows and check if they contain desired value.
assert self.cube_face.get_row(row_name="T1")[0] == 0
assert self.cube_face.get_row(row_name="D1")[0] == 6
def test_cube_fill_row(self):
# Create new testing cube face since the value get changed.
cube_face = Face(face_input=self.face_input, side_length=3)
cube_face.fill_row(row_name="T1", input_list=[100, 200, 300])
# Get row and check if it contains desired value.
assert cube_face.get_row(row_name="T1")[0] == 100
def test_cube_col(self):
# Get cols and check if they contain desired value.
assert self.cube_face.get_col(col_name="R1")[0] == 2
assert self.cube_face.get_col(col_name="L1")[0] == 0
def test_cube_fill_col(self):
# Create new testing cube face since the value get changed.
cube_face = Face(face_input=self.face_input, side_length=3)
cube_face.fill_col(col_name="R1", input_list=[100, 200, 300])
# Get col and check if it contains desired value.
assert cube_face.get_col(col_name="R1")[0] == 100
def test_cube_rotate(self):
# Create new testing cube face since the value get changed.
cube_face = Face(face_input=self.face_input, side_length=3)
# Rotate the face and check if it contains desired value.
cube_face.rotate_by_angle(angle=90)
assert np.array_equal(cube_face.get_item_list,
[6, 3, 0, 7, 4, 1, 8, 5, 2])
class TestCubeFaceErrorCheck:
# Setup testing input.
face_input = [item for item in range(9)]
cube_face = Face(face_input=face_input, side_length=3)
def test_init(self):
try:
Face(face_input=list("wrong"), side_length=3)
raise AssertionError("Error message did not raise.")
except AssertionError as error:
assert str(error) == WRONG_CUBE_FACE_INPUT
def test_fill_row(self):
try:
self.cube_face.fill_row(row_name="T1", input_list=[1])
raise AssertionError("Error message did not raise.")
except AssertionError as error:
assert str(error) == WRONG_SIDE_LENGTH
try:
self.cube_face.fill_row(row_name="abracadabra",
input_list=[1, 2, 3])
raise AssertionError("Error message did not raise.")
except AssertionError as error:
assert str(error) == WRONG_FRAME_INDEX_NAME
def test_fill_col(self):
try:
self.cube_face.fill_col(col_name="R1", input_list=[1])
raise AssertionError("Error message did not raise.")
except AssertionError as error:
assert str(error) == WRONG_SIDE_LENGTH
try:
self.cube_face.fill_col(col_name="abracadabra",
input_list=[1, 2, 3])
raise AssertionError("Error message did not raise.")
except AssertionError as error:
assert str(error) == WRONG_FRAME_COLUMN_NAME
def test_init(self):
try:
Face(face_input=list("wrong"), side_length=3)
raise AssertionError("Error message did not raise.")
except AssertionError as error:
assert str(error) == WRONG_CUBE_FACE_INPUT
def test_cube_fill_col(self):
# Create new testing cube face since the value get changed.
cube_face = Face(face_input=self.face_input, side_length=3)
cube_face.fill_col(col_name="R1", input_list=[100, 200, 300])
# Get col and check if it contains desired value.
assert cube_face.get_col(col_name="R1")[0] == 100
class Cube:
"""Create a full cube with desired side length on inputs."""
def __init__(self, cube_input: list, cube_side_length: int):
"""Initialize entire cube with a list of items.
:param cube_input: A list of any type of inputs.
:param cube_side_length: The desired side length of the cube.
"""
# Check length of the input.
assert cube_side_length > 1, WRONG_CUBE_SIDE_LENGTH
assert len(cube_input) == cube_side_length**2 * 6, WRONG_CUBE_INPUT
# Save the cube side length and cube max index.
self._side_length = cube_side_length
self._cube_max_index = math.floor(cube_side_length / 2)
# Split the cube input into six arrays.
cube_input_list = np.array_split(ary=cube_input, indices_or_sections=6)
# Assume that we fill the cube in the following order:
# - 1. Top face
# - 2. Front face
# - 3. Right face
# - 4. Back face
# - 5. Left face
# - 6. Down face
self._top_face = Face(face_input=cube_input_list[0],
side_length=cube_side_length)
self._front_face = Face(face_input=cube_input_list[1],
side_length=cube_side_length)
self._right_face = Face(face_input=cube_input_list[2],
side_length=cube_side_length)
self._back_face = Face(face_input=cube_input_list[3],
side_length=cube_side_length)
self._left_face = Face(face_input=cube_input_list[4],
side_length=cube_side_length)
self._down_face = Face(face_input=cube_input_list[5],
side_length=cube_side_length)
@property
def content(self) -> list:
"""Return all items in the cube as a list."""
return \
self._top_face.get_item_list + self._front_face.get_item_list + \
self._right_face.get_item_list + self._back_face.get_item_list + \
self._left_face.get_item_list + self._down_face.get_item_list
def shift_content(self):
"""Shift the cube binary representation to right by one item."""
# Obtain the shifted content by padding the last bit to the first.
shifted_content = [self.content[-1]] + self.content[:-1]
# Re-Init the class with new content.
self.__init__(cube_input=shifted_content,
cube_side_length=self._side_length)
def shift_content_back(self):
"""Shift the cube binary representation to left by one item."""
# Obtain the shifted content by padding the first bit to the last.
shifted_content = self.content[1:] + [self.content[0]]
# Re-Init the class with new content.
self.__init__(cube_input=shifted_content,
cube_side_length=self._side_length)
def _shift_t(self, index: int):
"""Shift the top layer with the index clockwise by 90 degrees.
:param index: The layer selected for the move.
"""
# If the most outer layer was selected, rotate the corresponding face.
if index == self._cube_max_index:
self._top_face.rotate_by_angle(angle=90)
# Save temp row.
temp_row = self._left_face.get_row(row_name=f"T{index}").values
# back -> right -> front -> left -> back
self._left_face.fill_row(
row_name=f"T{index}",
input_list=self._front_face.get_row(row_name=f"T{index}").values)
self._front_face.fill_row(
row_name=f"T{index}",
input_list=self._right_face.get_row(row_name=f"T{index}").values)
self._right_face.fill_row(
row_name=f"T{index}",
input_list=self._back_face.get_row(row_name=f"T{index}").values)
self._back_face.fill_row(row_name=f"T{index}", input_list=temp_row)
def _shift_d(self, index: int):
"""Shift the down layer with the index clockwise by 90 degrees.
:param index: The layer selected for the move.
"""
# If the most outer layer was selected, rotate the corresponding face.
if index == self._cube_max_index:
self._down_face.rotate_by_angle(angle=90)
# Save temp row.
temp_row = self._left_face.get_row(row_name=f"D{index}").values
# back -> left -> front -> right -> back
self._left_face.fill_row(
row_name=f"D{index}",
input_list=self._back_face.get_row(row_name=f"D{index}").values)
self._back_face.fill_row(
row_name=f"D{index}",
input_list=self._right_face.get_row(row_name=f"D{index}").values)
self._right_face.fill_row(
row_name=f"D{index}",
input_list=self._front_face.get_row(row_name=f"D{index}").values)
self._front_face.fill_row(row_name=f"D{index}", input_list=temp_row)
def _shift_f(self, index: int):
"""Shift the front layer with the index clockwise by 90 degrees.
:param index: The layer selected for the move.
"""
# If the most outer layer was selected, rotate the corresponding face.
if index == self._cube_max_index:
self._front_face.rotate_by_angle(angle=90)
# Save temp row.
temp_row = self._top_face.get_row(row_name=f"D{index}").values
# top -> right -> down -> left -> top
self._top_face.fill_row(row_name=f"D{index}",
input_list=self._left_face.get_col(
col_name=f"R{index}").values[::-1])
self._left_face.fill_col(
col_name=f"R{index}",
input_list=self._down_face.get_row(row_name=f"T{index}").values)
self._down_face.fill_row(row_name=f"T{index}",
input_list=self._right_face.get_col(
col_name=f"L{index}").values[::-1])
self._right_face.fill_col(col_name=f"L{index}", input_list=temp_row)
def _shift_b(self, index: int):
"""Shift the back layer with the index clockwise by 90 degrees.
:param index: The layer selected for the move.
"""
# If the most outer layer was selected, rotate the corresponding face.
if index == self._cube_max_index:
self._back_face.rotate_by_angle(angle=90)
# Save temp row.
temp_row = self._top_face.get_row(row_name=f"T{index}").values
# top -> left -> down -> right -> top
self._top_face.fill_row(
row_name=f"T{index}",
input_list=self._right_face.get_col(col_name=f"R{index}").values)
self._right_face.fill_col(col_name=f"R{index}",
input_list=self._down_face.get_row(
row_name=f"D{index}").values[::-1])
self._down_face.fill_row(
row_name=f"D{index}",
input_list=self._left_face.get_col(col_name=f"L{index}").values)
self._left_face.fill_col(col_name=f"L{index}",
input_list=temp_row[::-1])
def _shift_r(self, index: int):
"""Shift the right layer with the index clockwise by 90 degrees.
:param index: The layer selected for the move.
"""
# If the most outer layer was selected, rotate the corresponding face.
if index == self._cube_max_index:
self._right_face.rotate_by_angle(angle=90)
# Save temp column.
temp_col = self._front_face.get_col(col_name=f"R{index}").values
# top -> back -> down -> front -> top
self._front_face.fill_col(
col_name=f"R{index}",
input_list=self._down_face.get_col(col_name=f"R{index}").values)
self._down_face.fill_col(col_name=f"R{index}",
input_list=self._back_face.get_col(
col_name=f"L{index}").values[::-1])
self._back_face.fill_col(col_name=f"L{index}",
input_list=self._top_face.get_col(
col_name=f"R{index}").values[::-1])
self._top_face.fill_col(col_name=f"R{index}", input_list=temp_col)
def _shift_l(self, index: int):
"""Shift the left layer with the index clockwise by 90 degrees.
:param index: The layer selected for the move.
"""
# If the most outer layer was selected, rotate the corresponding face.
if index == self._cube_max_index:
self._left_face.rotate_by_angle(angle=90)
# Save temp column.
temp_col = self._front_face.get_col(col_name=f"L{index}").values
# top -> front -> down -> back -> top
self._front_face.fill_col(
col_name=f"L{index}",
input_list=self._top_face.get_col(col_name=f"L{index}").values)
self._top_face.fill_col(col_name=f"L{index}",
input_list=self._back_face.get_col(
col_name=f"R{index}").values[::-1])
self._back_face.fill_col(col_name=f"R{index}",
input_list=self._down_face.get_col(
col_name=f"L{index}").values[::-1])
self._down_face.fill_col(col_name=f"L{index}", input_list=temp_col)
def shift(self, key: Key):
"""Shift the cube with a move in certain amount of angle.
:param key: A named tuple that holds information for one shift.
"""
# Calculate the number of movements.
number_of_movements = int(key.angle / 90)
# Perform moves based on the inputs.
if key.move == CubeMove.left.value:
for _ in range(number_of_movements):
self._shift_l(index=key.index)
elif key.move == CubeMove.right.value:
for _ in range(number_of_movements):
self._shift_r(index=key.index)
elif key.move == CubeMove.top.value:
for _ in range(number_of_movements):
self._shift_t(index=key.index)
elif key.move == CubeMove.down.value:
for _ in range(number_of_movements):
self._shift_d(index=key.index)
elif key.move == CubeMove.back.value:
for _ in range(number_of_movements):
self._shift_b(index=key.index)
elif key.move == CubeMove.front.value:
for _ in range(number_of_movements):
self._shift_f(index=key.index)
# If the input movement was not defined.
else:
raise ValueError(WRONG_CUBE_MOVE)
def __init__(self, cube_input: list, cube_side_length: int):
"""Initialize entire cube with a list of items.
:param cube_input: A list of any type of inputs.
:param cube_side_length: The desired side length of the cube.
"""
# Check length of the input.
assert cube_side_length > 1, WRONG_CUBE_SIDE_LENGTH
assert len(cube_input) == cube_side_length**2 * 6, WRONG_CUBE_INPUT
# Save the cube side length and cube max index.
self._side_length = cube_side_length
self._cube_max_index = math.floor(cube_side_length / 2)
# Split the cube input into six arrays.
cube_input_list = np.array_split(ary=cube_input, indices_or_sections=6)
# Assume that we fill the cube in the following order:
# - 1. Top face
# - 2. Front face
# - 3. Right face
# - 4. Back face
# - 5. Left face
# - 6. Down face
self._top_face = Face(face_input=cube_input_list[0],
side_length=cube_side_length)
self._front_face = Face(face_input=cube_input_list[1],
side_length=cube_side_length)
self._right_face = Face(face_input=cube_input_list[2],
side_length=cube_side_length)
self._back_face = Face(face_input=cube_input_list[3],
side_length=cube_side_length)
self._left_face = Face(face_input=cube_input_list[4],
side_length=cube_side_length)
self._down_face = Face(face_input=cube_input_list[5],
side_length=cube_side_length)