Antzy21.Games.Checkerboard 3.0.0

Suggested Alternatives

Antzy21.Games.Checkerboard 4.0.0

Additional Details

This package added a lot of over head which lead to poor performance, as it tried to maintain ties to old style API

There is a newer version of this package available.
See the version list below for details.
dotnet add package Antzy21.Games.Checkerboard --version 3.0.0
                    
NuGet\Install-Package Antzy21.Games.Checkerboard -Version 3.0.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Antzy21.Games.Checkerboard" Version="3.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Antzy21.Games.Checkerboard" Version="3.0.0" />
                    
Directory.Packages.props
<PackageReference Include="Antzy21.Games.Checkerboard" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Antzy21.Games.Checkerboard --version 3.0.0
                    
#r "nuget: Antzy21.Games.Checkerboard, 3.0.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Antzy21.Games.Checkerboard@3.0.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Antzy21.Games.Checkerboard&version=3.0.0
                    
Install as a Cake Addin
#tool nuget:?package=Antzy21.Games.Checkerboard&version=3.0.0
                    
Install as a Cake Tool

Checkerboard

This library is for creating, modifying and accessing a checkerboard. A checkerboard is a 2D grid of squares, and games that use a checkerboard typically have pieces that are placed in the squares available. e.g. Chess and Checkers. Checkerboard is written functionally in F# and does not rely on external packages. Version 3.0 is designed for memory efficiency, by storing the 2d grid as a collection of binary integers.

Types and Modules

The Checkerboard library contains 5 types, each with a module to perform functions on the type.

Board

The board type is a 2D array of squares of a generic piece type. Currently restricted to 8x8, using the unsigned 64 bit int type. The piece information is stored in pieceTypeMaps, which are deciphered into pieces using the parser object, stored as part of the board.

type board<'Piece> = {hasPieceMap: uint64; pieceTypeMaps: uint64 list; parser: parser<'Piece>}

The Board module contains submodules for creating a board, getting square(s) and updating a board.

Square

The square type is a record type of an optional generic piece type, and the coordinates it has on a board.

type square = {piece: 'Piece option; coordinates: INumber * INumber}

The Square module contains functions for getting its properties, and updating the piece it contains.

Move

The move type is a tuple of two squares.

type move<'Piece> = square

It is useful for representing when a piece moves between two squares. The Move module contains functions for getting the pieces on the starting and destination squares, and finding the shift between the two squares.

Coordinates

The coordinates type is a tuple of ints.

type coordinates = int * int

The Coordinates module can parse rank and file naming convention into coordinates.

e.g. "a1" = (0, 0), "c4" = (2, 3)

Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
5.0.0 256 1/20/2024
4.0.1 236 11/19/2023
4.0.0 264 5/13/2023
3.0.0 452 1/21/2023 3.0.0 is deprecated because it has critical bugs.
2.0.1 280 3/31/2023
2.0.0 434 11/20/2022
1.2.1 498 10/10/2022
1.2.0 474 10/2/2022
1.1.1 487 9/4/2022
1.1.0 482 9/4/2022
1.0.1 498 9/4/2022
1.0.0 501 9/3/2022

Significant memory improvements