skewb

README

Skewb

Skewb implementation in GO.

Documentation

Index

• type CenterColorGetter
• type CenterDowner
• type CornerColors
• type CornerColorsGetter
• type Drawer
• type Equaler
• type ExactEqualer
• type FullMirrorer
• type Mirrorer
• type Move
• type MovesApplier
• type OneLayerMirrorer
• type RubiskewbMovesApplier
• type Skewb
  • func New(upColor, frontColor, rightColor, backColor, leftColor, downColor string) Skewb
  • func (s *Skewb) ApplyRubiskewbMoves(rubiskewbMoves string) error
  • func (s *Skewb) ApplyWCAMoves(wcaMoves string) error
  • func (s *Skewb) CenterDown(color string) error
  • func (s *Skewb) Draw(fileName string) error
  • func (s *Skewb) Equal(other Skewber) bool
  • func (s *Skewb) ExactEqual(other Skewber) bool
  • func (s *Skewb) FullMirror(other Skewber) bool
  • func (s *Skewb) GetBackCenterColor() string
  • func (s *Skewb) GetDBRCornerColors() [3]string
  • func (s *Skewb) GetDFLCornerColors() [3]string
  • func (s *Skewb) GetDLBCornerColors() [3]string
  • func (s *Skewb) GetDRFCornerColors() [3]string
  • func (s *Skewb) GetDownCenterColor() string
  • func (s *Skewb) GetFrontCenterColor() string
  • func (s *Skewb) GetLeftCenterColor() string
  • func (s *Skewb) GetRightCenterColor() string
  • func (s *Skewb) GetUBLCornerColors() [3]string
  • func (s *Skewb) GetUFRCornerColors() [3]string
  • func (s *Skewb) GetULFCornerColors() [3]string
  • func (s *Skewb) GetURBCornerColors() [3]string
  • func (s *Skewb) GetUpCenterColor() string
  • func (s *Skewb) OneLayerMirror(other Skewber, layerColor string) bool
• type Skewber
• type WCAMovesApplier

Types

type CenterColorGetter

type CenterColorGetter interface {
	GetUpCenterColor() string
	GetFrontCenterColor() string
	GetRightCenterColor() string
	GetBackCenterColor() string
	GetLeftCenterColor() string
	GetDownCenterColor() string
}

type CenterDowner

type CenterDowner interface {
	CenterDown(color string) error
}

type CornerColors

type CornerColors struct {
	// contains filtered or unexported fields
}

type CornerColorsGetter

type CornerColorsGetter interface {
	GetUFRCornerColors() [3]string
	GetURBCornerColors() [3]string
	GetULFCornerColors() [3]string
	GetUBLCornerColors() [3]string
	GetDRFCornerColors() [3]string
	GetDBRCornerColors() [3]string
	GetDFLCornerColors() [3]string
	GetDLBCornerColors() [3]string
}

type Drawer

type Drawer interface {
	Draw(fileName string) error
}

type Equaler

type Equaler interface {
	Equal(other Skewber) bool
}

type ExactEqualer

type ExactEqualer interface {
	ExactEqual(other Skewber) bool
}

type FullMirrorer

type FullMirrorer interface {
	FullMirror(other Skewber) bool
}

type Mirrorer

type Mirrorer interface {
	OneLayerMirrorer
	FullMirrorer
}

type Move

type Move string

var (
	U            Move = "U"
	UPrime       Move = "U'"
	R            Move = "R"
	RPrime       Move = "R'"
	LittleR      Move = "r"
	LittleRPrime Move = "r'"
	B            Move = "B"
	BPrime       Move = "B'"
	LittleB      Move = "b"
	LittleBPrime Move = "b'"
	L            Move = "L"
	LPrime       Move = "L'"
	LittleL      Move = "l"
	LittleLPrime Move = "l'"
	F            Move = "F"
	FPrime       Move = "F'"
	LittleF      Move = "f"
	LittleFPrime Move = "f'"

	X      Move = "x"
	XPrime Move = "x'"
	X2     Move = "x2"
	Y      Move = "y"
	YPrime Move = "y'"
	Y2     Move = "y2"
	Z      Move = "z"
	ZPrime Move = "z'"
	Z2     Move = "z2"

	ErrWCAMove = errors.New("wca move is not supported; valid types are: \"U\", \"U'\" \"R\", \"R'\" \"B\", \"B'\" \"L\", \"L'\", \"x\", \"x'\", \"x2\", \"y\", \"y'\", \"y2\", \"z\", \"z'\", \"z2\"")
	ErrColor   = errors.New("color is not part of Skewb")
)

type MovesApplier

type MovesApplier interface {
	ApplyWCAMoves(wcaMoves string) error
	ApplyRubiskewbMoves(rubiskewbMoves string) error
}

type OneLayerMirrorer

type OneLayerMirrorer interface {
	OneLayerMirror(other Skewber, layerColor string) bool
}

type RubiskewbMovesApplier

type RubiskewbMovesApplier interface {
	ApplyRubiskewbMoves(rubiskewbMoves string) error
}

type Skewb

type Skewb struct {
	// contains filtered or unexported fields
}

func New

func New(upColor, frontColor, rightColor, backColor, leftColor, downColor string) Skewb

func (*Skewb) ApplyRubiskewbMoves

func (s *Skewb) ApplyRubiskewbMoves(rubiskewbMoves string) error

func (*Skewb) ApplyWCAMoves

func (s *Skewb) ApplyWCAMoves(wcaMoves string) error

func (*Skewb) CenterDown

func (s *Skewb) CenterDown(color string) error

func (*Skewb) Draw

func (s *Skewb) Draw(fileName string) error

func (*Skewb) Equal

func (s *Skewb) Equal(other Skewber) bool

func (*Skewb) ExactEqual

func (s *Skewb) ExactEqual(other Skewber) bool

func (*Skewb) FullMirror

func (s *Skewb) FullMirror(other Skewber) bool

func (*Skewb) GetBackCenterColor

func (s *Skewb) GetBackCenterColor() string

func (*Skewb) GetDBRCornerColors

func (s *Skewb) GetDBRCornerColors() [3]string

func (*Skewb) GetDFLCornerColors

func (s *Skewb) GetDFLCornerColors() [3]string

func (*Skewb) GetDLBCornerColors

func (s *Skewb) GetDLBCornerColors() [3]string

func (*Skewb) GetDRFCornerColors

func (s *Skewb) GetDRFCornerColors() [3]string

func (*Skewb) GetDownCenterColor

func (s *Skewb) GetDownCenterColor() string

func (*Skewb) GetFrontCenterColor

func (s *Skewb) GetFrontCenterColor() string

func (*Skewb) GetLeftCenterColor

func (s *Skewb) GetLeftCenterColor() string

func (*Skewb) GetRightCenterColor

func (s *Skewb) GetRightCenterColor() string

func (*Skewb) GetUBLCornerColors

func (s *Skewb) GetUBLCornerColors() [3]string

func (*Skewb) GetUFRCornerColors

func (s *Skewb) GetUFRCornerColors() [3]string

func (*Skewb) GetULFCornerColors

func (s *Skewb) GetULFCornerColors() [3]string

func (*Skewb) GetURBCornerColors

func (s *Skewb) GetURBCornerColors() [3]string

func (*Skewb) GetUpCenterColor

func (s *Skewb) GetUpCenterColor() string

func (*Skewb) OneLayerMirror

func (s *Skewb) OneLayerMirror(other Skewber, layerColor string) bool

type Skewber

type Skewber interface {
	Drawer
	MovesApplier
	CenterDowner
	Equaler
	ExactEqualer
	Mirrorer
	CornerColorsGetter
	CenterColorGetter
}

type WCAMovesApplier

type WCAMovesApplier interface {
	ApplyWCAMoves(wcaMoves string) error
}