sudoklify-common/dev.teogor.sudoklify.components/BoxCoordinates

BoxCoordinates

data class BoxCoordinates(val topLeftRow: Int, val topLeftCol: Int, val bottomRightRow: Int, val bottomRightCol: Int)

Data class representing the coordinates of a box in a Sudoku grid.

This class encapsulates the details of a rectangular box within a Sudoku grid, defined by its top-left and bottom-right coordinates. It provides additional properties to easily access the dimensions of the box and its corner coordinates.

Constructors

BoxCoordinates

constructor(topLeftRow: Int, topLeftCol: Int, bottomRightRow: Int, bottomRightCol: Int)

Properties

bottomRight

val bottomRight: Pair<Int, Int>

Gets the coordinates of the bottom-right cell of the box as a tuple.

bottomRightCol

val bottomRightCol: Int

The column index of the bottom-right cell in the box.

bottomRightRow

val bottomRightRow: Int

The row index of the bottom-right cell in the box.

height

val height: Int

Computes the height of the box, which is the number of rows spanned by the box.

topLeft

val topLeft: Pair<Int, Int>

Gets the coordinates of the top-left cell of the box as a tuple.

topLeftCol

val topLeftCol: Int

The column index of the top-left cell in the box.

topLeftRow

val topLeftRow: Int

The row index of the top-left cell in the box.

width

val width: Int

Computes the width of the box, which is the number of columns spanned by the box.

Functions

contains

fun BoxCoordinates.contains(row: Int, col: Int): Boolean

Checks if the given cell coordinates are within this box.

expand

fun BoxCoordinates.expand(rowExpansion: Int, colExpansion: Int): BoxCoordinates

Expands the box by the specified number of rows and columns.

intersect

fun BoxCoordinates.intersect(other: BoxCoordinates): BoxCoordinates?

Computes the intersection of this box with another BoxCoordinates instance.

isAlternateBox

fun BoxCoordinates.isAlternateBox(dimension: Dimension): Boolean

Determines if the box should have a darker background color.

isBottomEnd

fun BoxCoordinates.isBottomEnd(dimension: Dimension): Boolean

Checks if the box is in the bottom-right corner of the Sudoku grid.

isBottomStart

fun BoxCoordinates.isBottomStart(dimension: Dimension): Boolean

Checks if the box is in the bottom-left corner of the Sudoku grid.

isTopEnd

fun BoxCoordinates.isTopEnd(dimension: Dimension): Boolean

Checks if the box is in the top-right corner of the Sudoku grid.

isTopStart

fun BoxCoordinates.isTopStart(dimension: Dimension): Boolean

Checks if the box is in the top-left corner of the Sudoku grid.

toFormattedString

fun BoxCoordinates.toFormattedString(): String

Converts the box coordinates to a human-readable string representation.