pcn

Documentation

Overview

Package pcn implements encoding and decoding of pure coordinate notation (PCN).

Index

• func Decode(s string) (core.Move, error)
• func Encode(m core.Move) string
• func MustDecode(s string) core.Move

Examples

• Encode

Functions

func Decode

func Decode(s string) (core.Move, error)

Decode decodes a PCN string and returns the move it represents.

func Encode

func Encode(m core.Move) string

Encode encodes a move as a PCN string.

Example

moves := []core.Move{
	// Double pawn push.
	{From: core.B2, To: core.B4},
	// Queen promotion.
	{From: core.F2, To: core.F1, Promotion: core.Queen},
	// White short castle.
	{From: core.E1, To: core.G1},
}
for _, m := range moves {
	fmt.Println(Encode(m))
}

Output:

b2b4
f2f1q
e1g1

func MustDecode

func MustDecode(s string) core.Move

MustDecode is like Decode but panics if the PCN is invalid.