From 69cf8351edb50cd0a7431a90c8f4a69fdaf57417 Mon Sep 17 00:00:00 2001
From: Quinniboi10 <69563433+Quinniboi10@users.noreply.github.com>
Date: Wed, 1 Jul 2026 20:15:43 -0700
Subject: [PATCH] addition operators for GridLocation including associated docs
 and tests

---
 Docs/GridLocation.html               | 40 ++++++++++++++++++++++++++++
 Library/collections/gridlocation.cpp | 10 +++++++
 Library/collections/gridlocation.h   |  6 +++++
 SPL-unit-tests/test-grid.cpp         | 11 ++++++++
 4 files changed, 67 insertions(+)

diff --git a/Docs/GridLocation.html b/Docs/GridLocation.html
index cbfc7794..c795f391 100644
--- a/Docs/GridLocation.html
+++ b/Docs/GridLocation.html
@@ -39,6 +39,16 @@ <h1 class=header><code>struct GridLocation</code></h1>
     <td class=indexKey><nobr><a href="#Method:toString">toString()</a>&nbsp;</nobr></td><td class=indexSynopsis width=100%>Returns a printable string representation of this <code>GridLocation</code>.</td></tr>
     <td class=indexHead colspan=3>Operators</td>
 </tr>
+<tr>
+
+    <td class=indexKey><nobr><a href="#Operator:+"><var>loc1</var> + <var>loc2</var></a>&nbsp;</nobr></td>
+    <td class=indexSynopsis width=100%>Returns a new <code>GridLocation</code> with row and col added together.</td>
+</tr>
+<tr>
+
+    <td class=indexKey><nobr><a href="#Operator:+="><var>loc1</var> += <var>loc2</var></a>&nbsp;</nobr></td>
+    <td class=indexSynopsis width=100%>Add <code>loc2.row</code> and <code>loc2.col</code> to <code>loc1</code>.</td>
+</tr>
 <tr>
 
     <td class=indexKey><nobr><a href="#Operator:=="><var>loc1</var> == <var>loc2</var></a>&nbsp;</nobr></td>
@@ -101,6 +111,36 @@ <h2>Method detail</h2>
 string str = loc.toString();
 </pre>
 
+<hr>
+<a name="Operator:+"></a>
+<pre class=detailCode>
+GridLocation operator+(const GridLocation&amp; loc1, const GridLocation&amp; loc2);
+</pre>
+Returns a new <code>GridLocation</code> where <code>new.row = loc1.row + loc2.row</code> and <code>new.col = loc1.col + loc2.col</code>.
+
+<p>Usage:<br>
+</div>
+<pre class=usageCode>
+GridLocation startLoc(5, 10);
+GridLocation offset(1, 1);
+GridLocation endLoc = startLoc + offset;
+</pre>
+
+<hr>
+<a name="Operator:+="></a>
+<pre class=detailCode>
+GridLocation&amp; operator+=(GridLocation&amp; loc1, const GridLocation&amp; loc2);
+</pre>
+Equal to <code>loc1 = loc1 + loc2</code>. Returns <code>loc1</code> as a reference.
+
+<p>Usage:<br>
+</div>
+<pre class=usageCode>
+GridLocation pos(5, 10);
+GridLocation offset(1, 1);
+pos += offset;
+</pre>
+
 <hr>
 <a name="Operator:<<"></a>
 <pre class=detailCode>
diff --git a/Library/collections/gridlocation.cpp b/Library/collections/gridlocation.cpp
index 680fbf3d..7b117947 100644
--- a/Library/collections/gridlocation.cpp
+++ b/Library/collections/gridlocation.cpp
@@ -30,6 +30,16 @@ int hashCode(const GridLocation& loc) {
     return hashCode(loc.row, loc.col);
 }
 
+GridLocation operator +(const GridLocation& loc1, const GridLocation& loc2) {
+    return GridLocation(loc1.row + loc2.row, loc1.col + loc2.col);
+}
+
+GridLocation& operator +=(GridLocation& loc1, const GridLocation& loc2) {
+    loc1.row += loc2.row;
+    loc1.col += loc2.col;
+    return loc1;
+}
+
 bool operator <(const GridLocation& loc1, const GridLocation& loc2) {
     return loc1.row < loc2.row ||
             (loc1.row == loc2.row && loc1.col < loc2.col);
diff --git a/Library/collections/gridlocation.h b/Library/collections/gridlocation.h
index 3b399031..e26143c7 100644
--- a/Library/collections/gridlocation.h
+++ b/Library/collections/gridlocation.h
@@ -56,6 +56,12 @@ struct GridLocation {
  */
 int hashCode(const GridLocation& loc);
 
+/*
+ * Addition operators for grid locations.
+ */
+GridLocation operator +(const GridLocation& loc1, const GridLocation& loc2);
+GridLocation& operator +=(GridLocation& loc1, const GridLocation& loc2);
+
 /*
  * Relational operators for comparing grid locations.
  */
diff --git a/SPL-unit-tests/test-grid.cpp b/SPL-unit-tests/test-grid.cpp
index b303335a..bd240156 100644
--- a/SPL-unit-tests/test-grid.cpp
+++ b/SPL-unit-tests/test-grid.cpp
@@ -263,6 +263,17 @@ PROVIDED_TEST("GridLocationRange, contains") {
 }
 
 
+PROVIDED_TEST("GridLocation, offset math and behavior") {
+    GridLocation start(5, 10);
+    GridLocation offset(1, -8);
+    EXPECT_EQUAL(start + offset, GridLocation(6, 2));
+    GridLocation& startReference = start += offset;
+    EXPECT_EQUAL(start, GridLocation(6, 2));
+    startReference = GridLocation(0, 0);
+    EXPECT_EQUAL(start, GridLocation(0, 0));
+}
+
+
 PROVIDED_TEST("GridLocationRange dimensions,size,isEmpty ") {
     Grid<int> grid;
     GridLocationRange range;