Add Matrix::GetOrDefault and type BoolMatrix

Author: terminalnode

common/util/matrix.go

@@ -24,6 +24,7 @@ type UInt32Matrix = Matrix[uint32]
 type UInt64Matrix = Matrix[uint64]
 
 type CharMatrix = UInt8Matrix
+type BoolMatrix = Matrix[bool]
 
 func NewMatrixFromRows[T any](
 	matrix [][]T,
@@ -77,3 +78,15 @@ func (m Matrix[T]) Get(
 	}
 	return m.matrix[y][x], nil
 }
+
+func (m Matrix[T]) GetOrDefault(
+	x int,
+	y int,
+	defaultReturn T,
+) (T, error) {
+	v, err := m.Get(x, y)
+	if err != nil {
+		return defaultReturn, err
+	}
+	return v, nil
+}

common/util/matrix_test.go

@@ -185,3 +185,33 @@ func TestMatrix_Get(t *testing.T) {
 		}
 	}
 }
+
+func TestMatrix_GetOrDefault(t *testing.T) {
+	defaultValue := Coordinate{1337, 420}
+
+	for x := -1; x <= matrix.MaxX+1; x++ {
+		for y := -1; y <= matrix.MaxY+1; y++ {
+			expected := Coordinate{X: x, Y: y}
+			actual, err := matrix.GetOrDefault(x, y, defaultValue)
+			isIn := matrix.IsInMatrix(x, y)
+
+			if isIn {
+				if actual != expected {
+					t.Errorf("Expected %v, but was %v", expected, actual)
+				}
+
+				if err != nil {
+					t.Errorf("Expected an error, but got nil")
+				}
+			} else {
+				if actual != defaultValue {
+					t.Errorf("Expected default value fallback (%v), but got %v", defaultValue, actual)
+				}
+
+				if err == nil {
+					t.Errorf("Expected err to be nil, but was %v", err)
+				}
+			}
+		}
+	}
+}