Fix variance characteristtics names

Also fixed some xml comments.
intervals-mining-lab · Nov 14, 2024 · 40daf60 · 40daf60
1 parent 083e332
commit 40daf60
Show file tree

Hide file tree

Showing 91 changed files with 239 additions and 208 deletions.
diff --git a/Libiada.Clusterizator/Krab/Calculators/QualityCalculator.cs b/Libiada.Clusterizator/Krab/Calculators/QualityCalculator.cs
@@ -6,7 +6,7 @@ namespace Libiada.Clusterizator.Krab.Calculators;
 public static class QualityCalculator
 {
     /// <summary>
-    /// The calculate.
+    /// Quality calculation method.
     /// </summary>
     /// <param name="currentGraph">
     /// The current graph.

diff --git a/...e/Characteristics/Calculators/CongenericCalculators/RemotenessKurtosisCoefficientTests.cs b/...e/Characteristics/Calculators/CongenericCalculators/RemotenessKurtosisCoefficientTests.cs
@@ -10,13 +10,13 @@
 public class RemotenessKurtosisCoefficientTests : CongenericCalculatorsTests<RemotenessKurtosisCoefficient>
 {
     /// <summary>
-    /// The average remoteness dispersion test.
+    /// The remoteness kurtosis coefficient test.
     /// </summary>
     /// <param name="index">
     /// The congeneric sequence index in <see cref="ChainsStorage"/>.
     /// </param>
     /// <param name="link">
-    /// Redundant parameter, not used in calculations.
+    /// Binding of the intervals in the sequence.
     /// </param>
     /// <param name="value">
     /// The value.

diff --git a/...e.Tests/Core/Characteristics/Calculators/CongenericCalculators/RemotenessKurtosisTests.cs b/...e.Tests/Core/Characteristics/Calculators/CongenericCalculators/RemotenessKurtosisTests.cs
@@ -10,13 +10,13 @@
 public class RemotenessKurtosisTests : CongenericCalculatorsTests<RemotenessKurtosis>
 {
     /// <summary>
-    /// The average remoteness dispersion test.
+    /// The remoteness kurtosis test.
     /// </summary>
     /// <param name="index">
     /// The congeneric sequence index in <see cref="ChainsStorage"/>.
     /// </param>
     /// <param name="link">
-    /// Redundant parameter, not used in calculations.
+    /// Binding of the intervals.
     /// </param>
     /// <param name="value">
     /// The value.

diff --git a/...e/Characteristics/Calculators/CongenericCalculators/RemotenessSkewnessCoefficientTests.cs b/...e/Characteristics/Calculators/CongenericCalculators/RemotenessSkewnessCoefficientTests.cs
@@ -10,13 +10,13 @@
 public class RemotenessSkewnessCoefficientTests : CongenericCalculatorsTests<RemotenessSkewnessCoefficient>
 {
     /// <summary>
-    /// The average remoteness dispersion test.
+    /// The remoteness skewness coefficient test.
     /// </summary>
     /// <param name="index">
     /// The congeneric sequence index in <see cref="ChainsStorage"/>.
     /// </param>
     /// <param name="link">
-    /// Redundant parameter, not used in calculations.
+    /// Binding of the intervals in the sequence.
     /// </param>
     /// <param name="value">
     /// The value.

diff --git a/...e.Tests/Core/Characteristics/Calculators/CongenericCalculators/RemotenessSkewnessTests.cs b/...e.Tests/Core/Characteristics/Calculators/CongenericCalculators/RemotenessSkewnessTests.cs
@@ -10,13 +10,13 @@
 public class RemotenessSkewnessTests : CongenericCalculatorsTests<RemotenessSkewness>
 {
     /// <summary>
-    /// The average remoteness dispersion test.
+    /// The remoteness skewness test.
     /// </summary>
     /// <param name="index">
     /// The congeneric sequence index in <see cref="ChainsStorage"/>.
     /// </param>
     /// <param name="link">
-    /// Redundant parameter, not used in calculations.
+    /// Binding of the intervals in the sequence.
     /// </param>
     /// <param name="value">
     /// The value.

diff --git a/...ore/Characteristics/Calculators/CongenericCalculators/RemotenessStandardDeviationTests.cs b/...ore/Characteristics/Calculators/CongenericCalculators/RemotenessStandardDeviationTests.cs
@@ -16,7 +16,7 @@ public class RemotenessStandardDeviationTests : CongenericCalculatorsTests<Remot
     /// The congeneric sequence index in <see cref="ChainsStorage"/>.
     /// </param>
     /// <param name="link">
-    /// Redundant parameter, not used in calculations.
+    /// Binding of the intervals in the sequence.
     /// </param>
     /// <param name="value">
     /// The value.

diff --git a/...cCalculators/RemotenessDispersionTests.cs → ...ricCalculators/RemotenessVarianceTests.cs b/...cCalculators/RemotenessDispersionTests.cs → ...ricCalculators/RemotenessVarianceTests.cs
@@ -4,19 +4,19 @@
 using Libiada.Core.Core.Characteristics.Calculators.CongenericCalculators;
 
 /// <summary>
-/// The remoteness dispersion tests.
+/// The remoteness variance tests.
 /// </summary>
 [TestFixture]
-public class RemotenessDispersionTests : CongenericCalculatorsTests<RemotenessDispersion>
+public class RemotenessVarianceTests : CongenericCalculatorsTests<RemotenessVariance>
 {
     /// <summary>
-    /// The average remoteness dispersion test.
+    /// The remoteness variance test.
     /// </summary>
     /// <param name="index">
     /// The congeneric sequence index in <see cref="ChainsStorage"/>.
     /// </param>
     /// <param name="link">
-    /// Redundant parameter, not used in calculations.
+    /// Binding of the intervals in the sequence.
     /// </param>
     /// <param name="value">
     /// The value.

diff --git a/.../Characteristics/Calculators/FullCalculators/AverageRemotenessKurtosisCoefficientTests.cs b/.../Characteristics/Calculators/FullCalculators/AverageRemotenessKurtosisCoefficientTests.cs
@@ -10,13 +10,13 @@
 public class AverageRemotenessKurtosisCoefficientTests : FullCalculatorsTests<AverageRemotenessKurtosisCoefficient>
 {
     /// <summary>
-    /// The average remoteness dispersion test.
+    /// The average remoteness kurtosis coefficient test.
     /// </summary>
     /// <param name="index">
     /// Full sequence index in <see cref="ChainsStorage"/>.
     /// </param>
     /// <param name="link">
-    /// Redundant parameter, not used in calculations.
+    /// Binding of the intervals in the sequence.
     /// </param>
     /// <param name="value">
     /// The value.

diff --git a/....Tests/Core/Characteristics/Calculators/FullCalculators/AverageRemotenessKurtosisTests.cs b/....Tests/Core/Characteristics/Calculators/FullCalculators/AverageRemotenessKurtosisTests.cs
@@ -10,13 +10,13 @@
 public class AverageRemotenessKurtosisTests : FullCalculatorsTests<AverageRemotenessKurtosis>
 {
     /// <summary>
-    /// The average remoteness dispersion test.
+    /// The average remoteness kurtosis test.
     /// </summary>
     /// <param name="index">
     /// Full sequence index in <see cref="ChainsStorage"/>.
     /// </param>
     /// <param name="link">
-    /// Redundant parameter, not used in calculations.
+    /// Binding of the intervals in the sequence.
     /// </param>
     /// <param name="value">
     /// The value.

diff --git a/.../Characteristics/Calculators/FullCalculators/AverageRemotenessSkewnessCoefficientTests.cs b/.../Characteristics/Calculators/FullCalculators/AverageRemotenessSkewnessCoefficientTests.cs
@@ -4,19 +4,19 @@
 using Libiada.Core.Core.Characteristics.Calculators.FullCalculators;
 
 /// <summary>
-/// The average remoteness asymmetry test.
+/// The average remoteness asymmetry coefficient test.
 /// </summary>
 [TestFixture]
 public class AverageRemotenessSkewnessCoefficientTests : FullCalculatorsTests<AverageRemotenessSkewnessCoefficient>
 {
     /// <summary>
-    /// The average remoteness dispersion test.
+    /// The average remoteness asymmetry coefficient test.
     /// </summary>
     /// <param name="index">
     /// Full sequence index in <see cref="ChainsStorage"/>.
     /// </param>
     /// <param name="link">
-    /// Redundant parameter, not used in calculations.
+    /// Binding of the intervals in the sequence.
     /// </param>
     /// <param name="value">
     /// The value.

diff --git a/....Tests/Core/Characteristics/Calculators/FullCalculators/AverageRemotenessSkewnessTests.cs b/....Tests/Core/Characteristics/Calculators/FullCalculators/AverageRemotenessSkewnessTests.cs
@@ -10,13 +10,13 @@
 public class AverageRemotenessSkewnessTests : FullCalculatorsTests<AverageRemotenessSkewness>
 {
     /// <summary>
-    /// The average remoteness dispersion test.
+    /// The average remoteness asymmetry test.
     /// </summary>
     /// <param name="index">
     /// Full sequence index in <see cref="ChainsStorage"/>.
     /// </param>
     /// <param name="link">
-    /// Redundant parameter, not used in calculations.
+    /// Binding of the intervals in the sequence.
     /// </param>
     /// <param name="value">
     /// The value.

diff --git a/...re/Characteristics/Calculators/FullCalculators/AverageRemotenessStandardDeviationTests.cs b/...re/Characteristics/Calculators/FullCalculators/AverageRemotenessStandardDeviationTests.cs
@@ -16,7 +16,7 @@ public class AverageRemotenessStandardDeviationTests : FullCalculatorsTests<Aver
     /// Full sequence index in <see cref="ChainsStorage"/>.
     /// </param>
     /// <param name="link">
-    /// Redundant parameter, not used in calculations.
+    /// Binding of the intervals in the sequence.
     /// </param>
     /// <param name="value">
     /// The value.

diff --git a/...ators/AverageRemotenessDispersionTests.cs → ...ulators/AverageRemotenessVarianceTests.cs b/...ators/AverageRemotenessDispersionTests.cs → ...ulators/AverageRemotenessVarianceTests.cs
@@ -4,19 +4,19 @@
 using Libiada.Core.Core.Characteristics.Calculators.FullCalculators;
 
 /// <summary>
-/// The average remoteness dispersion test.
+/// The average remoteness variance test.
 /// </summary>
 [TestFixture]
-public class AverageRemotenessDispersionTests : FullCalculatorsTests<AverageRemotenessDispersion>
+public class AverageRemotenessVarianceTests : FullCalculatorsTests<AverageRemotenessVariance>
 {
     /// <summary>
-    /// The average remoteness dispersion test.
+    /// The average remoteness variance test.
     /// </summary>
     /// <param name="index">
     /// Full sequence index in <see cref="ChainsStorage"/>.
     /// </param>
     /// <param name="link">
-    /// Redundant parameter, not used in calculations.
+    /// Binding of the intervals in the sequence.
     /// </param>
     /// <param name="value">
     /// The value.

diff --git a/...Tests/Core/Characteristics/Calculators/FullCalculators/EntropyKurtosisCoefficientTests.cs b/...Tests/Core/Characteristics/Calculators/FullCalculators/EntropyKurtosisCoefficientTests.cs
@@ -10,13 +10,13 @@
 public class EntropyKurtosisCoefficientTests : FullCalculatorsTests<EntropyKurtosisCoefficient>
 {
     /// <summary>
-    /// The average remoteness dispersion test.
+    /// The entropy kurtosis coefficient test.
     /// </summary>
     /// <param name="index">
     /// Full sequence index in <see cref="ChainsStorage"/>.
     /// </param>
     /// <param name="link">
-    /// Redundant parameter, not used in calculations.
+    /// Binding of the intervals in the sequence.
     /// </param>
     /// <param name="value">
     /// The value.

diff --git a/Libiada.Core.Tests/Core/Characteristics/Calculators/FullCalculators/EntropyKurtosisTests.cs b/Libiada.Core.Tests/Core/Characteristics/Calculators/FullCalculators/EntropyKurtosisTests.cs
@@ -4,19 +4,19 @@
 using Libiada.Core.Core.Characteristics.Calculators.FullCalculators;
 
 /// <summary>
-/// The average remoteness kurtosis tests.
+/// The entropy kurtosis tests.
 /// </summary>
 [TestFixture]
 public class EntropyKurtosisTests : FullCalculatorsTests<EntropyKurtosis>
 {
     /// <summary>
-    /// The average remoteness dispersion test.
+    /// The entropy kurtosis test.
     /// </summary>
     /// <param name="index">
     /// Full sequence index in <see cref="ChainsStorage"/>.
     /// </param>
     /// <param name="link">
-    /// Redundant parameter, not used in calculations.
+    /// Binding of the intervals in the sequence.
     /// </param>
     /// <param name="value">
     /// The value.

diff --git a/...Tests/Core/Characteristics/Calculators/FullCalculators/EntropySkewnessCoefficientTests.cs b/...Tests/Core/Characteristics/Calculators/FullCalculators/EntropySkewnessCoefficientTests.cs
@@ -4,19 +4,19 @@
 using Libiada.Core.Core.Characteristics.Calculators.FullCalculators;
 
 /// <summary>
-/// The average remoteness asymmetry test.
+/// The entropy asymmetry coefficient test.
 /// </summary>
 [TestFixture]
 public class EntropySkewnessCoefficientTests : FullCalculatorsTests<EntropySkewnessCoefficient>
 {
     /// <summary>
-    /// The average remoteness dispersion test.
+    /// The entropy asymmetry coefficient test.
     /// </summary>
     /// <param name="index">
     /// Full sequence index in <see cref="ChainsStorage"/>.
     /// </param>
     /// <param name="link">
-    /// Redundant parameter, not used in calculations.
+    /// Binding of the intervals in the sequence.
     /// </param>
     /// <param name="value">
     /// The value.

diff --git a/Libiada.Core.Tests/Core/Characteristics/Calculators/FullCalculators/EntropySkewnessTests.cs b/Libiada.Core.Tests/Core/Characteristics/Calculators/FullCalculators/EntropySkewnessTests.cs
@@ -4,19 +4,19 @@
 using Libiada.Core.Core.Characteristics.Calculators.FullCalculators;
 
 /// <summary>
-/// The average remoteness asymmetry test.
+/// The entropy asymmetry test.
 /// </summary>
 [TestFixture]
 public class EntropySkewnessTests : FullCalculatorsTests<EntropySkewness>
 {
     /// <summary>
-    /// The average remoteness dispersion test.
+    /// The entropy asymmetry test.
     /// </summary>
     /// <param name="index">
     /// Full sequence index in <see cref="ChainsStorage"/>.
     /// </param>
     /// <param name="link">
-    /// Redundant parameter, not used in calculations.
+    /// Binding of the intervals in the sequence.
     /// </param>
     /// <param name="value">
     /// The value.

diff --git a/...e.Tests/Core/Characteristics/Calculators/FullCalculators/EntropyStandardDeviationTests.cs b/...e.Tests/Core/Characteristics/Calculators/FullCalculators/EntropyStandardDeviationTests.cs
@@ -2,6 +2,7 @@
 
 using Libiada.Core.Core;
 using Libiada.Core.Core.Characteristics.Calculators.FullCalculators;
+using Libiada.Core.Core.SimpleTypes;
 
 /// <summary>
 /// Standard Deviation test.
@@ -16,7 +17,7 @@ public class EntropyStandardDeviationTests : FullCalculatorsTests<EntropyStandar
     /// Full sequence index in <see cref="ChainsStorage"/>.
     /// </param>
     /// <param name="link">
-    /// Redundant parameter, not used in calculations.
+    /// Binding of the intervals in the sequence.
     /// </param>
     /// <param name="value">
     /// The value.

diff --git a/...FullCalculators/EntropyDispersionTests.cs → ...s/FullCalculators/EntropyVarianceTests.cs b/...FullCalculators/EntropyDispersionTests.cs → ...s/FullCalculators/EntropyVarianceTests.cs
@@ -4,19 +4,19 @@
 using Libiada.Core.Core.Characteristics.Calculators.FullCalculators;
 
 /// <summary>
-/// The average remoteness dispersion test.
+/// The entropy variance test.
 /// </summary>
 [TestFixture]
-public class EntropyDispersionTests : FullCalculatorsTests<EntropyDispersion>
+public class EntropyVarianceTests : FullCalculatorsTests<EntropyVariance>
 {
     /// <summary>
-    /// The average remoteness dispersion test.
+    /// The entropy variance test.
     /// </summary>
     /// <param name="index">
     /// Full sequence index in <see cref="ChainsStorage"/>.
     /// </param>
     /// <param name="link">
-    /// Redundant parameter, not used in calculations.
+    /// Binding of the intervals in the sequence.
     /// </param>
     /// <param name="value">
     /// The value.

diff --git a/...ore.Tests/Core/Characteristics/Calculators/FullCalculators/FullCalculatorsFactoryTests.cs b/...ore.Tests/Core/Characteristics/Calculators/FullCalculators/FullCalculatorsFactoryTests.cs
@@ -26,7 +26,7 @@ public class FullCalculatorsFactoryTests
     [TestCase(FullCharacteristic.ATSkew, typeof(ATSkew))]
     [TestCase(FullCharacteristic.AverageRemoteness, typeof(AverageRemoteness))]
     [TestCase(FullCharacteristic.AverageRemotenessATSkew, typeof(AverageRemotenessATSkew))]
-    [TestCase(FullCharacteristic.AverageRemotenessDispersion, typeof(AverageRemotenessDispersion))]
+    [TestCase(FullCharacteristic.AverageRemotenessVariance, typeof(AverageRemotenessVariance))]
     [TestCase(FullCharacteristic.AverageRemotenessGCRatio, typeof(AverageRemotenessGCRatio))]
     [TestCase(FullCharacteristic.AverageRemotenessGCSkew, typeof(AverageRemotenessGCSkew))]
     [TestCase(FullCharacteristic.AverageRemotenessGCToATRatio, typeof(AverageRemotenessGCToATRatio))]
@@ -44,7 +44,7 @@ public class FullCalculatorsFactoryTests
     [TestCase(FullCharacteristic.Depth, typeof(Depth))]
     [TestCase(FullCharacteristic.DescriptiveInformation, typeof(DescriptiveInformation))]
     [TestCase(FullCharacteristic.ElementsCount, typeof(ElementsCount))]
-    [TestCase(FullCharacteristic.EntropyDispersion, typeof(EntropyDispersion))]
+    [TestCase(FullCharacteristic.EntropyVariance, typeof(EntropyVariance))]
     [TestCase(FullCharacteristic.EntropyKurtosis, typeof(EntropyKurtosis))]
     [TestCase(FullCharacteristic.EntropyKurtosisCoefficient, typeof(EntropyKurtosisCoefficient))]
     [TestCase(FullCharacteristic.EntropySkewness, typeof(EntropySkewness))]
@@ -62,7 +62,7 @@ public class FullCalculatorsFactoryTests
     [TestCase(FullCharacteristic.Periodicity, typeof(Periodicity))]
     [TestCase(FullCharacteristic.Probability, typeof(Probability))]
     [TestCase(FullCharacteristic.Regularity, typeof(Regularity))]
-    [TestCase(FullCharacteristic.RemotenessDispersion, typeof(RemotenessDispersion))]
+    [TestCase(FullCharacteristic.RemotenessVariance, typeof(RemotenessVariance))]
     [TestCase(FullCharacteristic.RemotenessKurtosis, typeof(RemotenessKurtosis))]
     [TestCase(FullCharacteristic.RemotenessKurtosisCoefficient, typeof(RemotenessKurtosisCoefficient))]
     [TestCase(FullCharacteristic.RemotenessSkewness, typeof(RemotenessSkewness))]

diff --git a/...ts/Core/Characteristics/Calculators/FullCalculators/RemotenessKurtosisCoefficientTests.cs b/...ts/Core/Characteristics/Calculators/FullCalculators/RemotenessKurtosisCoefficientTests.cs
@@ -10,13 +10,13 @@
 public class RemotenessKurtosisCoefficientTests : FullCalculatorsTests<RemotenessKurtosisCoefficient>
 {
     /// <summary>
-    /// The average remoteness dispersion test.
+    /// The remoteness kurtosis coefficient test.
     /// </summary>
     /// <param name="index">
     /// Full sequence index in <see cref="ChainsStorage"/>.
     /// </param>
     /// <param name="link">
-    /// Redundant parameter, not used in calculations.
+    /// Binding of the intervals in the sequence.
     /// </param>
     /// <param name="value">
     /// The value.

diff --git a/...da.Core.Tests/Core/Characteristics/Calculators/FullCalculators/RemotenessKurtosisTests.cs b/...da.Core.Tests/Core/Characteristics/Calculators/FullCalculators/RemotenessKurtosisTests.cs
@@ -10,13 +10,13 @@
 public class RemotenessKurtosisTests : FullCalculatorsTests<RemotenessKurtosis>
 {
     /// <summary>
-    /// The average remoteness dispersion test.
+    /// The remoteness kurtosis test.
     /// </summary>
     /// <param name="index">
     /// Full sequence index in <see cref="ChainsStorage"/>.
     /// </param>
     /// <param name="link">
-    /// Redundant parameter, not used in calculations.
+    /// Binding of the intervals in the sequence.
     /// </param>
     /// <param name="value">
     /// The value.