Result File Operators (smith-chem-wisc#843)

* Added and tested result file operators

* Cleanup

* variable renaming

* cleanup

* made fewere changes

---------

Co-authored-by: trishorts <[email protected]>

Author: nbollis

mzLib/Readers/ExternalResults/BaseClasses/ResultFile.cs

@@ -79,6 +79,48 @@ public bool CanRead(string filePath)
 
         #endregion
 
+        #region Operators
+
+        public static ResultFile<TResult> operator +(ResultFile<TResult> thisFile, TResult resultToAdd)
+        {
+            thisFile.Results.Add(resultToAdd);
+            return thisFile;
+        }
+
+        public static ResultFile<TResult> operator +(ResultFile<TResult> thisFile, IEnumerable<TResult> resultsToAdd)
+        {
+            thisFile.Results.AddRange(resultsToAdd);
+            return thisFile;
+        }
+
+        public static ResultFile<TResult> operator +(ResultFile<TResult> thisFile, ResultFile<TResult> fileToAdd)
+        {
+            thisFile.Results.AddRange(fileToAdd.Results);
+            return thisFile;
+        }
+
+        public static ResultFile<TResult> operator -(ResultFile<TResult> thisFile, TResult resultToRemove)
+        {
+            thisFile.Results.Remove(resultToRemove);
+            return thisFile;
+        }
+
+        public static ResultFile<TResult> operator -(ResultFile<TResult> thisFile, IEnumerable<TResult> resultsToRemove)
+        {
+            foreach (var result in resultsToRemove)
+                thisFile.Results.Remove(result);
+            return thisFile;
+        }
+
+        public static ResultFile<TResult> operator -(ResultFile<TResult> thisFile, ResultFile<TResult> fileToRemove)
+        {
+            foreach (var result in fileToRemove.Results)
+                thisFile.Results.Remove(result);
+            return thisFile;
+        }
+
+        #endregion
+
         #region Interface Implementations
 
         public IEnumerator<TResult> GetEnumerator() => Results.GetEnumerator();
@@ -106,8 +148,5 @@ public override int GetHashCode()
         }
 
         #endregion
-
-
-
     }
 }

mzLib/Test/FileReadingTests/TestResultFile.cs

@@ -64,5 +64,48 @@ public static void TestGetEnumerator()
                 Assert.That(feature.GetType() == typeof(Ms1Feature));
             }
         }
+
+        [Test]
+        public static void TestOperatorOverloads()
+        {
+            string path1 = @"FileReadingTests\ExternalFileTypes\Ms1Feature_TopFDv1.6.2_ms1.feature";
+            string path2 = @"FileReadingTests\ExternalFileTypes\Ms1Feature_FlashDeconvOpenMs3.0.0_ms1.feature";
+
+            Ms1FeatureFile fileToTest = new Ms1FeatureFile(path1);
+            Ms1FeatureFile ms1Features2 = new Ms1FeatureFile(path2);
+
+            Ms1Feature feature = new Ms1Feature();
+            List<Ms1Feature> features = new List<Ms1Feature> { new Ms1Feature() };
+
+
+            var initialCount = fileToTest.Count();
+            var file2Count = ms1Features2.Count();
+
+            // Test operator +
+            var result1 = fileToTest + feature;
+            Assert.That(result1.Results.Contains(feature));
+            Assert.That(fileToTest.Count, Is.EqualTo(initialCount + 1));
+
+            var result2 = fileToTest + features;
+            Assert.That(result2.Results.Contains(feature));
+            Assert.That(fileToTest.Count, Is.EqualTo(initialCount + 2));
+
+            var result3 = fileToTest + ms1Features2;
+            Assert.That(result3.Results.Contains(feature));
+            Assert.That(fileToTest.Count, Is.EqualTo(initialCount + 2 + file2Count));
+
+            // Test operator -
+            var result4 = fileToTest - feature;
+            Assert.That(!result4.Results.Contains(feature));
+            Assert.That(fileToTest.Count, Is.EqualTo(initialCount + 1 + file2Count));
+
+            var result5 = fileToTest - features;
+            Assert.That(!result5.Results.Contains(feature));
+            Assert.That(fileToTest.Count, Is.EqualTo(initialCount + file2Count));
+
+            var result6 = fileToTest - ms1Features2;
+            Assert.That(!result6.Results.Contains(feature));
+            Assert.That(fileToTest.Count, Is.EqualTo(initialCount));
+        }
     }
 }