Network GC reduction (Issue #8)

Author: KSP-TaxiService

src/CommNetConstellation/CommNetConstellation.csproj

@@ -80,6 +80,7 @@
     <Compile Include="UI\ColorPickerDialog.cs" />
     <Compile Include="UI\ConstellationControlDialog.cs" />
     <Compile Include="UI\ConstellationEditDialog.cs" />
+    <Compile Include="UI\GameUtils.cs" />
     <Compile Include="UI\GroundStationEditDialog.cs" />
     <Compile Include="UI\UIUtils.cs" />
     <Compile Include="UI\VesselMgtTools\AntennaTool.cs" />

src/CommNetConstellation/CommNetLayer/CNCCommNetHome.cs

@@ -20,7 +20,10 @@ public class CNCCommNetHome : CommNetHome, IComparable<CNCCommNetHome>
         [Persistent] public string ID;
         [Persistent] public Color Color = Color.red;
         [Persistent] protected string OptionalName = "";
-        [Persistent(collectionIndex = "Frequency")] public List<short> Frequencies = new List<short>(new short[] { CNCSettings.Instance.PublicRadioFrequency });
+        [Persistent(collectionIndex = "Frequency")] protected List<short> Frequencies = new List<short>(new short[] { CNCSettings.Instance.PublicRadioFrequency });
+
+        //for low-gc operations
+        protected short[] sorted_frequency_array;
 
         public double altitude { get { return this.alt; } }
         public double latitude { get { return this.lat; } }
@@ -72,14 +75,54 @@ public void replaceFrequency(short oldFrequency, short newFrequency)
             this.Frequencies.Remove(oldFrequency);
             this.Frequencies.Add(newFrequency);
             this.Frequencies.Sort();
+            regenerateFrequencyArray(this.Frequencies);
         }
 
         /// <summary>
         /// Drop the specific frequency from the list
         /// </summary>
-        public bool deleteFrequency(short frequency)
+        public void deleteFrequency(short frequency)
+        {
+            this.Frequencies.Remove(frequency);
+            regenerateFrequencyArray(this.Frequencies);
+        }
+
+        /// <summary>
+        /// Get the *sorted* array of frequencies only
+        /// </summary>
+        public short[] getFrequencyArray()
+        {
+            if(this.sorted_frequency_array == null)
+            {
+                regenerateFrequencyArray(this.Frequencies);
+            }
+            return this.sorted_frequency_array;
+        }
+
+        /// <summary>
+        /// Get the *sorted* list of frequencies only
+        /// </summary>
+        public List<short> getFrequencyList()
+        {
+            return this.Frequencies;
+        }
+
+        /// <summary>
+        /// Remove all frequencies
+        /// </summary>
+        public void deleteFrequencies()
         {
-            return this.Frequencies.Remove(frequency);
+            this.Frequencies.Clear();
+            regenerateFrequencyArray(this.Frequencies);
+        }
+
+        /// <summary>
+        /// Replace all frequencies
+        /// </summary>
+        public void replaceFrequencies(List<short> newFreqs)
+        {
+            this.Frequencies = newFreqs;
+            regenerateFrequencyArray(this.Frequencies);
         }
 
         /// <summary>
@@ -186,5 +229,24 @@ public int CompareTo(CNCCommNetHome other)
         {
             return this.stationName.CompareTo(other.stationName);
         }
+
+        /// <summary>
+        /// Regenerate frequency array used for low-gc operations
+        /// </summary>
+        protected void regenerateFrequencyArray(List<short> list)
+        {
+            if (list.Count == 0)
+            {
+                sorted_frequency_array = new short[] { };
+            }
+
+            sorted_frequency_array = new short[list.Count];
+            for(int i=0; i< list.Count; i++)
+            {
+                sorted_frequency_array[i] = list[i];
+            }
+
+            GameUtils.Quicksort(sorted_frequency_array, 0, sorted_frequency_array.Length - 1);
+        }
     }
 }

src/CommNetConstellation/CommNetLayer/CNCCommNetScenario.cs

@@ -1,4 +1,5 @@
 using CommNet;
+using CommNetConstellation.UI;
 using KSP.UI.Screens.Flight;
 using System;
 using System.Collections.Generic;
@@ -103,7 +104,7 @@ protected override void Start()
                 UnityEngine.Object.Destroy(bodies[i]);
             }
 
-            CNCLog.Verbose("CommNet Scenario loading done! ");
+            CNCLog.Verbose("CommNet Scenario loading done!");
         }
 
         public override void OnAwake()
@@ -208,7 +209,7 @@ public override void OnLoad(ConfigNode gameNode)
                         ConfigNode.LoadObjectFromConfig(dummyGroundStation, stationNodes[i]);
                         if(!stationNodes[i].HasNode("Frequencies")) // empty list is not saved as empty node in persistent.sfs
                         {
-                            dummyGroundStation.Frequencies.Clear();// clear the default frequency list
+                            dummyGroundStation.deleteFrequencies();// clear the default frequency list
                         }
                         persistentGroundStations.Add(dummyGroundStation);
                     }
@@ -288,7 +289,7 @@ public List<CNCCommNetVessel> getCommNetVessels(short targetFrequency = -1)
             List<CNCCommNetVessel> newList = new List<CNCCommNetVessel>();
             for(int i=0; i<commVessels.Count; i++)
             {
-                if (commVessels[i].getFrequencies().Contains(targetFrequency) || targetFrequency == -1)
+                if (targetFrequency == -1 || GameUtils.firstCommonElement(commVessels[i].getFrequencyArray(), new short[] { targetFrequency }) >= 0)
                     newList.Add(commVessels[i]);
             }
 
@@ -359,20 +360,16 @@ private void onVesselCountChanged(Vessel v)
         /// <summary>
         /// Convenient method to obtain a frequency list from a given CommNode
         /// </summary>
-        public List<short> getFrequencies(CommNode a)
+        public short[] getFrequencies(CommNode a)
         {
-            List<short> aFreqs = new List<short>();
-
             if (a.isHome && findCorrespondingGroundStation(a) != null)
             {
-                aFreqs.AddRange(findCorrespondingGroundStation(a).Frequencies);
+                return findCorrespondingGroundStation(a).getFrequencyArray();
             }
             else
             {
-                aFreqs = ((CNCCommNetVessel)findCorrespondingVessel(a).Connection).getFrequencies();
+                return ((CNCCommNetVessel)findCorrespondingVessel(a).Connection).getFrequencyArray();
             }
-
-            return aFreqs;
         }
 
         /// <summary>

src/CommNetConstellation/CommNetLayer/CNCCommNetUI.cs

@@ -1,4 +1,5 @@
 using CommNet;
+using CommNetConstellation.UI;
 using KSP.Localization;
 using KSP.UI.Screens.Mapview;
 using System;
@@ -130,12 +131,12 @@ private void OnMapNodeUpdateVisible(MapNode node, MapNode.IconData iconData)
         private Color getConstellationColor(CommNode a, CommNode b)
         {
             //Assume the connection between A and B passes the check test
-            List<short> commonFreqs = Constellation.NonLinqIntersect(CNCCommNetScenario.Instance.getFrequencies(a), CNCCommNetScenario.Instance.getFrequencies(b));
+            short[] commonFreqs = GameUtils.NonLinqIntersect(CNCCommNetScenario.Instance.getFrequencies(a), CNCCommNetScenario.Instance.getFrequencies(b));
             IRangeModel rangeModel = CNCCommNetScenario.RangeModel;
             short strongestFreq = -1;
             double longestRange = 0.0;
 
-            for (int i = 0; i < commonFreqs.Count; i++)
+            for (int i = 0; i < commonFreqs.Length; i++)
             {
                 short thisFreq = commonFreqs[i];
                 double thisRange = rangeModel.GetMaximumRange(CNCCommNetScenario.Instance.getCommPower(a, thisFreq), CNCCommNetScenario.Instance.getCommPower(b, thisFreq));

src/CommNetConstellation/CommNetLayer/CNCCommNetVessel.cs

@@ -82,6 +82,9 @@ public enum FrequencyListOperation
         [Persistent] private List<double> FreqDictionaryValues = new List<double>();
         [Persistent] public FrequencyListOperation FreqListOperation = FrequencyListOperation.AutoBuild; // initial value
 
+        //for low-gc operations
+        protected short[] sorted_frequency_array;
+
         protected short strongestFreq = -1;
         protected List<CNCAntennaPartInfo> vesselAntennas = new List<CNCAntennaPartInfo>();
         protected bool stageActivated = false;
@@ -392,19 +395,33 @@ protected Dictionary<short, double> buildFrequencyList(List<CNCAntennaPartInfo>
                 short freq = allFreqs[i];
 
                 //best antenna power * (total power / best power) ^ (sum(expo*power)/total power)
-                double weightedExpo = Constellation.NonLinqSum(expoFreqDict[freq]) / Constellation.NonLinqSum(combinepowerFreqDict[freq]);
-                double combinedPower = (combinepowerFreqDict[freq].Count == 0)? 0.0 : Constellation.NonLinqMax(combinepowerFreqDict[freq]) * Math.Pow((Constellation.NonLinqSum(combinepowerFreqDict[freq]) / Constellation.NonLinqMax(combinepowerFreqDict[freq])), weightedExpo);
+                double weightedExpo = GameUtils.NonLinqSum(expoFreqDict[freq]) / GameUtils.NonLinqSum(combinepowerFreqDict[freq]);
+                double combinedPower = (combinepowerFreqDict[freq].Count == 0)? 0.0 : GameUtils.NonLinqMax(combinepowerFreqDict[freq]) * Math.Pow((GameUtils.NonLinqSum(combinepowerFreqDict[freq]) / GameUtils.NonLinqMax(combinepowerFreqDict[freq])), weightedExpo);
                 freqDict.Add(freq, Math.Max(combinedPower, noncombinepowerDict[freq]));
                 CNCLog.Debug("CommNet Vessel '{0}''s freq list has freq {1} of {2} power", this.Vessel.GetName(), freq, Math.Max(combinedPower, noncombinepowerDict[freq]));
             }
 
+            regenerateFrequencyArray(freqDict);
+
             return freqDict;
         }
 
+        /// <summary>
+        /// Get the *sorted* array of frequencies only
+        /// </summary>
+        public short[] getFrequencyArray()
+        {
+            if(sorted_frequency_array == null)
+            {
+                regenerateFrequencyArray(this.FrequencyDict);
+            }
+            return sorted_frequency_array;
+        }
+
         /// <summary>
         /// Get the *unsorted* list of frequencies only
         /// </summary>
-        public List<short> getFrequencies()
+        public List<short> getFrequencyList()
         {
             List<short> freqs = new List<short>();
             var itr = this.FrequencyDict.Keys.GetEnumerator();
@@ -557,6 +574,8 @@ public void addToFreqList(short frequency, double commPower)
             else
                 this.FrequencyDict.Add(frequency, commPower);
 
+            regenerateFrequencyArray(this.FrequencyDict);
+
             CNCLog.Debug("CommNet Vessel '{0}''s freq list gains {1} ({2} power)", this.Vessel.GetName(), frequency, commPower);
         }
 
@@ -568,6 +587,8 @@ public void removeFromFreqList(short frequency)
             if (!isFreqListEditable()) return; 
 
             this.FrequencyDict.Remove(frequency);
+            regenerateFrequencyArray(this.FrequencyDict);
+
             CNCLog.Debug("CommNet Vessel '{0}''s freq list loses freq {1}", this.Vessel.GetName(), frequency);
         }
 
@@ -579,6 +600,8 @@ public void clearFreqList()
             if (!isFreqListEditable()) return;
 
             this.FrequencyDict.Clear();
+            regenerateFrequencyArray(this.FrequencyDict);
+
             CNCLog.Debug("CommNet Vessel '{0}''s freq list is cleared", this.Vessel.GetName());
         }
 
@@ -775,6 +798,29 @@ public void PersistenceLoad()
             {
                 FrequencyDict.Add(FreqDictionaryKeys[i], FreqDictionaryValues[i]);
             }
+            regenerateFrequencyArray(FrequencyDict);
+        }
+
+        /// <summary>
+        /// Regenerate frequency array used for low-gc operations
+        /// </summary>
+        protected void regenerateFrequencyArray(Dictionary<short, double> dict)
+        {
+            if (dict.Keys.Count == 0)
+            {
+                sorted_frequency_array = new short[] { };
+            }
+
+            int i = 0;
+            sorted_frequency_array = new short[dict.Keys.Count];
+
+            var valueItr = dict.Keys.GetEnumerator();
+            while (valueItr.MoveNext())
+            {
+                sorted_frequency_array[i++] = valueItr.Current;
+            }
+
+            GameUtils.Quicksort(sorted_frequency_array, 0, sorted_frequency_array.Length - 1);
         }
     }
 }

src/CommNetConstellation/CommNetLayer/CNCCommNetwork.cs

@@ -1,6 +1,6 @@
 using CommNet;
+using CommNetConstellation.UI;
 using System;
-using System.Collections.Generic;
 
 namespace CommNetConstellation.CommNetLayer
 {
@@ -31,39 +31,33 @@ public static bool AreSame(CommNode a, CommNode b)
         /// </summary>
         protected override bool SetNodeConnection(CommNode a, CommNode b)
         {
-            List<short> aFreqs, bFreqs;
-
             try
             {
                 //stop links between ground stations
                 if (a.isHome && b.isHome)
                 {
                     this.Disconnect(a, b, true);
-                    return false;
                 }
-
-                //each CommNode has at least some frequencies?
-                aFreqs = CNCCommNetScenario.Instance.getFrequencies(a);
-                bFreqs = CNCCommNetScenario.Instance.getFrequencies(b);
-
-                //share same frequency?
-                for (int i = 0; i < aFreqs.Count; i++)
+                else
                 {
-                    if (bFreqs.Contains(aFreqs[i])) // yes, it does
+                    //each CommNode has at least some frequencies?
+                    if (GameUtils.firstCommonElement(CNCCommNetScenario.Instance.getFrequencies(a), CNCCommNetScenario.Instance.getFrequencies(b)) >= 0)
                     {
                         return base.SetNodeConnection(a, b);
                     }
+                    else
+                    {
+                        this.Disconnect(a, b, true);
+                    }
                 }
-
-                this.Disconnect(a, b, true);
-                return false;
             }
             catch (Exception e) // either CommNode could be a kerbal on EVA
             {
                 //CNCLog.Verbose("Error thrown when checking CommNodes '{0}' & '{1}' - {2}", a.name, b.name, e.Message);
                 this.Disconnect(a, b, true);
-                return false;
             }
+
+            return false;
         }
     }
 }