Merge branch 'release/3.1.2'

Author: giacomelli

.github/CONTRIBUTING.md

@@ -1,4 +1,7 @@
 ## How to contribute to GeneticSharp
+The idea behind GeneticSharp is to provide the basic and classic components that allow any programmer to quickly create a genetic algorithm using the .NET platform. Therefore, most of the basics and classic operators (crossovers, mutations, selections, reinsertions, and terminations) are implemented on it.
+
+Having said that is not the goal of GeneticSharp to implement or provide all the possible ways to use a genetic algorithm, so, any PR that is not related to new operators, performance improvements, or bug fixing has a great chance to be rejected, but, feel free to read the contributing guidelines below and give a try.
 
 ### Did you find a bug?
 

.github/ISSUE_TEMPLATE/bug_report.md

@@ -13,6 +13,9 @@ Steps to reproduce the behavior:
 **Expected behavior**
 A clear and concise description of what you expected to happen.
 
+**Sample code**
+Provide a sample code exposing the bug.
+
 **Screenshots**
 If applicable, add screenshots to help explain your problem.
 

.github/ISSUE_TEMPLATE/question.md

@@ -12,3 +12,6 @@ Did you search for your answer at GeneticSharp's Stack Overflow [tag](https://st
 
 **Ask a question**
 If you did not find your answer at wiki and Stack Overflow tag, please, describe your question.
+
+** Sample code **
+Provide a sample code of what you have tried so far.

appveyor.yml

@@ -1,4 +1,4 @@
-version: 3.0.{build}
+version: 3.1.2.{build}
 os: Visual Studio 2022
 configuration: Release
 environment:

buildLibrariesNuget.cmd

@@ -1,4 +1,4 @@
-SET PACKAGE_VERSION="3.0.0"
+SET PACKAGE_VERSION="3.1.2"
 
 mkdir .\src\nuget
 

buildTemplatesNuget.cmd

@@ -1,4 +1,4 @@
-SET PACKAGE_VERSION=3.0.0
+SET PACKAGE_VERSION=3.1.2
 
 cd .\src\Templates
 

src/GeneticSharp.Benchmarks/RandomizationsBenchmark.cs

@@ -1,4 +1,5 @@
 using BenchmarkDotNet.Attributes;
+using System.Threading.Tasks;
 
 namespace GeneticSharp.Benchmarks
 {
@@ -53,6 +54,15 @@ public void Basic_GetUniqueInts()
         {
             _basic.GetUniqueInts(_arrayLength, _min, _max);
         }
+
+        [Benchmark]
+        public void Basic_GetInt_Threads()
+        {
+            Parallel.For(0, 100, i =>
+            {
+                _basic.GetInt(_min, _max);
+            });
+        }
         #endregion 
 
         #region FastRandom
@@ -97,6 +107,15 @@ public void FastRandom_GetUniqueInts()
         {
             _fastRandom.GetUniqueInts(_arrayLength, _min, _max);
         }
+
+        [Benchmark]
+        public void FastRandom_GetInt_Threads()
+        {
+            Parallel.For(0, 100, i =>
+            {
+                _fastRandom.GetInt(_min, _max);
+            });
+        }
         #endregion 
     }
 }

src/GeneticSharp.Benchmarks/SelectionsBenchmark.cs

@@ -54,5 +54,21 @@ public ISelection Tournament()
             target.SelectChromosomes(_chromosomesNumber, _generation);
             return target;
         }
+
+        [Benchmark]
+        public ISelection Rank()
+        {
+            var target = new RankSelection();
+            target.SelectChromosomes(_chromosomesNumber, _generation);
+            return target;
+        }
+
+        [Benchmark]
+        public ISelection Truncation()
+        {
+            var target = new TruncationSelection();
+            target.SelectChromosomes(_chromosomesNumber, _generation);
+            return target;
+        }
     }
 }

src/GeneticSharp.Domain.UnitTests/Chromosomes/ChromosomeBaseTest.cs

@@ -125,22 +125,6 @@ public void ReplaceGenes_NullGenes_Exception()
             });
         }
 
-        [Test]
-        public void ReplaceGenes_GenesExceedChromosomeLength_Exception()
-        {
-            var target = Substitute.For<ChromosomeBase>(3);
-
-            Assert.Catch<ArgumentException>(() =>
-            {
-                target.ReplaceGenes(0, new Gene[] { new Gene(1), new Gene(2), new Gene(3), new Gene(4) });
-            }, "The number of genes to be replaced is greater than available space, there is 3 genes between the index 0 and the end of chromosome, but there is 4 genes to be replaced.");
-
-            Assert.Catch<ArgumentException>(() =>
-            {
-                target.ReplaceGenes(1, new Gene[] { new Gene(1), new Gene(2), new Gene(3) });
-            }, "The number of genes to be replaced is greater than available space, there is 2 genes between the index 1 and the end of chromosome, but there is 3 genes to be replaced.");
-        }
-
         [Test]
         public void ReplaceGenes_ValidIndex_Replaced()
         {

src/GeneticSharp.Domain.UnitTests/FlowAssert.cs

@@ -49,6 +49,7 @@ public static void IsAtLeastOneOk(params Action[] flows)
         public static void IsAtLeastOneAttemptOk(int maxAttempts, Action flow)
         {
             bool ok = false;
+            string failedMessage = null;
 
             for(int i = 0; i < maxAttempts; i++)
             {
@@ -63,10 +64,11 @@ public static void IsAtLeastOneAttemptOk(int maxAttempts, Action flow)
                     Debug.WriteLine(ex.Message);
                     Debug.WriteLine(ex.StackTrace);
                     ok = false;
+                    failedMessage = ex.Message;
                 }
             }
 
-            Assert.IsTrue(ok);
+            Assert.IsTrue(ok, $"All {maxAttempts} attempts failed\n\n{failedMessage}");
         }
     }
 }