Distribution calculator: entity renamed (#160)

gyrdym · web-flow · commit a9bd3c6f3b15 · 2020-11-28T17:51:36.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,8 @@
 # Changelog
 
+## 15.3.2
+- Awfully long identifier `SequenceElementsDistributionCalculator` renamed to `DistributionCalculator`
+
 ## 15.3.1
 - README: 
     - typos corrected
diff --git a/lib/src/classifier/decision_tree_classifier/_init_module.dart b/lib/src/classifier/decision_tree_classifier/_init_module.dart
@@ -1,10 +1,9 @@
 import 'package:ml_algo/src/classifier/decision_tree_classifier/_injector.dart';
 import 'package:ml_algo/src/classifier/decision_tree_classifier/decision_tree_classifier_factory.dart';
 import 'package:ml_algo/src/classifier/decision_tree_classifier/decision_tree_classifier_factory_impl.dart';
-import 'package:ml_algo/src/common/sequence_elements_distribution_calculator/distribution_calculator_factory.dart';
-import 'package:ml_algo/src/common/sequence_elements_distribution_calculator/distribution_calculator_factory_impl.dart';
+import 'package:ml_algo/src/common/distribution_calculator/distribution_calculator_factory.dart';
+import 'package:ml_algo/src/common/distribution_calculator/distribution_calculator_factory_impl.dart';
 import 'package:ml_algo/src/di/common/init_common_module.dart';
-import 'package:ml_algo/src/di/injector.dart';
 import 'package:ml_algo/src/tree_trainer/leaf_detector/leaf_detector_factory.dart';
 import 'package:ml_algo/src/tree_trainer/leaf_detector/leaf_detector_factory_impl.dart';
 import 'package:ml_algo/src/tree_trainer/leaf_label/leaf_label_factory_factory.dart';
@@ -27,8 +26,8 @@ void initDecisionTreeModule() {
 
   decisionTreeInjector
     ..clearAll()
-    ..registerSingleton<SequenceElementsDistributionCalculatorFactory>(
-            () => const SequenceElementsDistributionCalculatorFactoryImpl())
+    ..registerSingleton<DistributionCalculatorFactory>(
+            () => const DistributionCalculatorFactoryImpl())
 
     ..registerSingleton<NominalTreeSplitterFactory>(
             () => const NominalTreeSplitterFactoryImpl())
@@ -60,7 +59,7 @@ void initDecisionTreeModule() {
     ..registerSingleton<TreeLeafLabelFactoryFactory>(
             () => TreeLeafLabelFactoryFactoryImpl(
           decisionTreeInjector
-              .get<SequenceElementsDistributionCalculatorFactory>(),
+              .get<DistributionCalculatorFactory>(),
         ))
 
     ..registerSingleton<TreeTrainerFactory>(
diff --git a/lib/src/common/distribution_calculator/distribution_calculator.dart b/lib/src/common/distribution_calculator/distribution_calculator.dart
@@ -1,6 +1,6 @@
 import 'dart:collection';
 
-abstract class SequenceElementsDistributionCalculator {
+abstract class DistributionCalculator {
   HashMap<T, double> calculate<T>(Iterable<T> sequence,
       [int classLabelsLength]);
 }
diff --git a/lib/src/common/distribution_calculator/distribution_calculator_factory.dart b/lib/src/common/distribution_calculator/distribution_calculator_factory.dart
@@ -0,0 +1,5 @@
+import 'package:ml_algo/src/common/distribution_calculator/distribution_calculator.dart';
+
+abstract class DistributionCalculatorFactory {
+  DistributionCalculator create();
+}
diff --git a/lib/src/common/distribution_calculator/distribution_calculator_factory_impl.dart b/lib/src/common/distribution_calculator/distribution_calculator_factory_impl.dart
@@ -0,0 +1,13 @@
+import 'package:ml_algo/src/common/distribution_calculator/distribution_calculator.dart';
+import 'package:ml_algo/src/common/distribution_calculator/distribution_calculator_factory.dart';
+import 'package:ml_algo/src/common/distribution_calculator/distribution_calculator_impl.dart';
+
+class DistributionCalculatorFactoryImpl implements
+    DistributionCalculatorFactory {
+
+  const DistributionCalculatorFactoryImpl();
+
+  @override
+  DistributionCalculator create() =>
+      const DistributionCalculatorImpl();
+}
diff --git a/lib/src/common/distribution_calculator/distribution_calculator_impl.dart b/lib/src/common/distribution_calculator/distribution_calculator_impl.dart
@@ -1,25 +1,29 @@
 import 'dart:collection';
 
-import 'package:ml_algo/src/common/sequence_elements_distribution_calculator/distribution_calculator.dart';
+import 'package:ml_algo/src/common/distribution_calculator/distribution_calculator.dart';
 
-class SequenceElementsDistributionCalculatorImpl implements
-    SequenceElementsDistributionCalculator {
-  const SequenceElementsDistributionCalculatorImpl();
+class DistributionCalculatorImpl implements DistributionCalculator {
+
+  const DistributionCalculatorImpl();
 
   @override
   HashMap<T, double> calculate<T>(Iterable<T> sequence,
       [int classLabelsLength]) {
+
     if (sequence.isEmpty || classLabelsLength == 0) {
       throw Exception('Empty value collection was provided');
     }
+
     final length = classLabelsLength ?? sequence.length;
     final bins = HashMap<T, double>();
     final probabilityStep = 1 / length;
+
     sequence.forEach((value) =>
         bins.update(value,
             (existing) => existing + probabilityStep,
             ifAbsent: () => probabilityStep),
     );
+
     return bins;
   }
 }
diff --git a/lib/src/common/sequence_elements_distribution_calculator/distribution_calculator_factory.dart b/lib/src/common/sequence_elements_distribution_calculator/distribution_calculator_factory.dart
diff --git a/lib/src/common/sequence_elements_distribution_calculator/distribution_calculator_factory_impl.dart b/lib/src/common/sequence_elements_distribution_calculator/distribution_calculator_factory_impl.dart
diff --git a/lib/src/tree_trainer/leaf_label/leaf_label_factory_factory_impl.dart b/lib/src/tree_trainer/leaf_label/leaf_label_factory_factory_impl.dart
@@ -1,4 +1,4 @@
-import 'package:ml_algo/src/common/sequence_elements_distribution_calculator/distribution_calculator_factory.dart';
+import 'package:ml_algo/src/common/distribution_calculator/distribution_calculator_factory.dart';
 import 'package:ml_algo/src/tree_trainer/leaf_label/leaf_label_factory.dart';
 import 'package:ml_algo/src/tree_trainer/leaf_label/leaf_label_factory_factory.dart';
 import 'package:ml_algo/src/tree_trainer/leaf_label/leaf_label_factory_type.dart';
@@ -9,7 +9,7 @@ class TreeLeafLabelFactoryFactoryImpl implements
 
   TreeLeafLabelFactoryFactoryImpl(this._distributionCalculatorFactory);
 
-  final SequenceElementsDistributionCalculatorFactory
+  final DistributionCalculatorFactory
     _distributionCalculatorFactory;
 
   @override
diff --git a/lib/src/tree_trainer/leaf_label/majority_leaf_label_factory.dart b/lib/src/tree_trainer/leaf_label/majority_leaf_label_factory.dart
@@ -1,6 +1,6 @@
 import 'dart:collection';
 
-import 'package:ml_algo/src/common/sequence_elements_distribution_calculator/distribution_calculator.dart';
+import 'package:ml_algo/src/common/distribution_calculator/distribution_calculator.dart';
 import 'package:ml_algo/src/tree_trainer/leaf_label/leaf_label.dart';
 import 'package:ml_algo/src/tree_trainer/leaf_label/leaf_label_factory.dart';
 import 'package:ml_linalg/matrix.dart';
@@ -10,7 +10,7 @@ class MajorityTreeLeafLabelFactory implements TreeLeafLabelFactory {
 
   MajorityTreeLeafLabelFactory(this.distributionCalculator);
 
-  final SequenceElementsDistributionCalculator distributionCalculator;
+  final DistributionCalculator distributionCalculator;
 
   @override
   TreeLeafLabel create(Matrix samples, int targetIdx) {
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,6 +1,6 @@
 name: ml_algo
 description: Machine learning algorithms, Machine learning models performance evaluation functionality
-version: 15.3.1
+version: 15.3.2
 homepage: https://github.com/gyrdym/ml_algo
 
 environment:
diff --git a/test/common/distribution_calculator/distribution_calculator_impl_test.dart b/test/common/distribution_calculator/distribution_calculator_impl_test.dart
@@ -1,4 +1,4 @@
-import 'package:ml_algo/src/common/sequence_elements_distribution_calculator/distribution_calculator_impl.dart';
+import 'package:ml_algo/src/common/distribution_calculator/distribution_calculator_impl.dart';
 import 'package:ml_linalg/vector.dart';
 import 'package:test/test.dart';
 
@@ -8,7 +8,7 @@ void main() {
       test('should calculate probability distribution of the given '
           'sequence', () {
         final labels = [1, 1, 1, 2, 3];
-        final calculator = const SequenceElementsDistributionCalculatorImpl();
+        final calculator = const DistributionCalculatorImpl();
         final actual = calculator.calculate(labels);
         final expected = {
           1: closeTo(3 / 5, 1e-4),
@@ -22,7 +22,7 @@ void main() {
           'equal to for the given sequence consisting of one repeating '
           'value', () {
         final values = [1, 1, 1, 1, 1];
-        final calculator = const SequenceElementsDistributionCalculatorImpl();
+        final calculator = const DistributionCalculatorImpl();
         final actual = calculator.calculate(values);
         final expected = {
           1: 1.0,
@@ -33,7 +33,7 @@ void main() {
       test('should return a map where all values (probabilities) are uniform '
           'if the given sequence elements are all different', () {
         final values = [10, 20, 30, 40, 60];
-        final calculator = const SequenceElementsDistributionCalculatorImpl();
+        final calculator = const DistributionCalculatorImpl();
         final actual = calculator.calculate(values);
         final expected = {
           10: 1 / 5,
@@ -56,7 +56,7 @@ void main() {
           Vector.fromList([0, 1, 0]),
           Vector.fromList([1, 0, 0]),
         ];
-        final calculator = const SequenceElementsDistributionCalculatorImpl();
+        final calculator = const DistributionCalculatorImpl();
         final actual = calculator.calculate(values);
         final expected = {
           Vector.fromList([1, 0, 0]): 2 / 5,
@@ -75,7 +75,7 @@ void main() {
           Vector.fromList([1, 0, 0]),
           Vector.fromList([1, 0, 0]),
         ];
-        final calculator = const SequenceElementsDistributionCalculatorImpl();
+        final calculator = const DistributionCalculatorImpl();
         final actual = calculator.calculate(values);
         final expected = {
           Vector.fromList([1, 0, 0]): 1.0,
@@ -90,7 +90,7 @@ void main() {
           Vector.fromList([1, 2, 3]),
           Vector.fromList([4, 5, 6]),
         ];
-        final calculator = const SequenceElementsDistributionCalculatorImpl();
+        final calculator = const DistributionCalculatorImpl();
         final actual = calculator.calculate(values);
         final expected = {
           Vector.fromList([1, 0, 0]): closeTo(1 / 3, 1e-4),
@@ -108,7 +108,7 @@ void main() {
         'class 2',
         'class 3',
       ];
-      final calculator = const SequenceElementsDistributionCalculatorImpl();
+      final calculator = const DistributionCalculatorImpl();
       final actual = calculator.calculate(values, 10);
       final expected = {
         'class 1': 1 / 10,
@@ -121,15 +121,15 @@ void main() {
     test('should throw an error if value collection is empty (provided length '
         'should be ignored)', () {
       final values = <double>[];
-      final calculator = const SequenceElementsDistributionCalculatorImpl();
+      final calculator = const DistributionCalculatorImpl();
       final actual = () => calculator.calculate(values, 10);
 
       expect(actual, throwsException);
     });
 
     test('should throw an error if given length is 0', () {
       final values = <double>[1, 2, 3];
-      final calculator = const SequenceElementsDistributionCalculatorImpl();
+      final calculator = const DistributionCalculatorImpl();
       final actual = () => calculator.calculate(values, 0);
 
       expect(actual, throwsException);
diff --git a/test/mocks.dart b/test/mocks.dart
@@ -4,8 +4,8 @@ import 'package:ml_algo/src/classifier/knn_classifier/knn_classifier_factory.dar
 import 'package:ml_algo/src/classifier/logistic_regressor/logistic_regressor.dart';
 import 'package:ml_algo/src/classifier/softmax_regressor/softmax_regressor.dart';
 import 'package:ml_algo/src/classifier/softmax_regressor/softmax_regressor_factory.dart';
-import 'package:ml_algo/src/common/sequence_elements_distribution_calculator/distribution_calculator.dart';
-import 'package:ml_algo/src/common/sequence_elements_distribution_calculator/distribution_calculator_factory.dart';
+import 'package:ml_algo/src/common/distribution_calculator/distribution_calculator.dart';
+import 'package:ml_algo/src/common/distribution_calculator/distribution_calculator_factory.dart';
 import 'package:ml_algo/src/cost_function/cost_function.dart';
 import 'package:ml_algo/src/cost_function/cost_function_factory.dart';
 import 'package:ml_algo/src/knn_kernel/kernel.dart';
@@ -133,10 +133,10 @@ class NominalTreeSplitterFactoryMock extends Mock implements
     NominalTreeSplitterFactory {}
 
 class DistributionCalculatorMock extends Mock implements
-    SequenceElementsDistributionCalculator {}
+    DistributionCalculator {}
 
 class DistributionCalculatorFactoryMock extends Mock implements
-    SequenceElementsDistributionCalculatorFactory {}
+    DistributionCalculatorFactory {}
 
 class TreeLeafDetectorMock extends Mock implements TreeLeafDetector {}
 
@@ -343,8 +343,8 @@ TreeSplitSelectorFactory createTreeSplitSelectorFactoryMock(
   return factory;
 }
 
-SequenceElementsDistributionCalculatorFactory createDistributionCalculatorFactoryMock(
-  SequenceElementsDistributionCalculator calculator,
+DistributionCalculatorFactory createDistributionCalculatorFactoryMock(
+  DistributionCalculator calculator,
 ) {
   final factory = DistributionCalculatorFactoryMock();
   when(factory.create()).thenReturn(calculator);
diff --git a/test/tree_trainer/leaf_label/majority_leaf_label_factory_test.dart b/test/tree_trainer/leaf_label/majority_leaf_label_factory_test.dart
@@ -1,6 +1,6 @@
 import 'dart:collection';
 
-import 'package:ml_algo/src/common/sequence_elements_distribution_calculator/distribution_calculator.dart';
+import 'package:ml_algo/src/common/distribution_calculator/distribution_calculator.dart';
 import 'package:ml_algo/src/tree_trainer/leaf_label/majority_leaf_label_factory.dart';
 import 'package:ml_linalg/matrix.dart';
 import 'package:mockito/mockito.dart';
@@ -70,7 +70,7 @@ void main() {
   });
 }
 
-SequenceElementsDistributionCalculator createDistributionCalculator(
+DistributionCalculator createDistributionCalculator(
     Iterable<num> values, HashMap<double, double> distribution) {
   final distributionCalculator = DistributionCalculatorMock();
 

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`import 'dart:collection';`
`2`	`2`
`3`		`-abstract class SequenceElementsDistributionCalculator {`
	`3`	`+abstract class DistributionCalculator {`
`4`	`4`	`HashMap<T, double> calculate<T>(Iterable<T> sequence,`
`5`	`5`	`[int classLabelsLength]);`
`6`	`6`	`}`