rubik

Documentation

Overview

Package rubik models the standard 3x3 Rubik's Cube.

Index

• type Color
  • func (c Color) String() string
• type Cube
  • func NewCube() Cube
• type Rotation

Types

type Color

type Color int

Color represents one of the six colors in the standard 3x3 Rubik's Cube.

const (
	White Color = iota
	Yellow
	Blue
	Green
	Orange
	Red
)

The standard six colors in the standard 3x3 Rubik's Cube.

func (Color) String

func (c Color) String() string

type Cube

type Cube interface {
	F(Rotation)
	B(Rotation)
	R(Rotation)
	L(Rotation)
	U(Rotation)
	D(Rotation)
	Solved() bool
}

Cube represents a standard 3x3 Rubik's Cube.

func NewCube

func NewCube() Cube

NewCube creates a new standard 3x3 Rubik's Cube. The created cube is in solved state and the white face is in the front.

type Rotation

type Rotation int

Rotation represents a face rotation.

const (
	// C90 is a clockwise 90-degrees rotation.
	C90 Rotation = iota
	// CC90 is a counterclockwise 90-degrees rotation.
	CC90
	// C180 is a clockwise 180-degrees rotation.
	C180
)