delete deprecated functions (#83)

* delete deprecated functions

* bump version

* analyzer

* fix file name

Author: sensuikan1973

CHANGELOG.md

@@ -1,3 +1,9 @@
+# 1.5.0
+
+- delete deprecated functions.
+  - `computeBestPathNumWithLink`
+  - `streamOfBestPathNumWithLink`
+
 # 1.4.0
 
 - enable `edaxBookCountBestpath` to receive Board param.

example/pubspec.lock

@@ -91,7 +91,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "1.4.0"
+    version: "1.5.0"
   meta:
     dependency: transitive
     description:

example/pubspec.yaml

@@ -1,5 +1,5 @@
 name: libedax4dart_example
-version: 1.4.0-example
+version: 1.5.0-example
 publish_to: none
 
 environment:

lib/libedax4dart.dart

@@ -1,10 +1,9 @@
 /// dart wrapper for libedax
 library libedax4dart;
 
-export 'src/best_path_num_with_link.dart';
 export 'src/board.dart';
 export 'src/constants.dart';
-export 'src/count_best_path_result.dart';
+export 'src/count_bestpath_result.dart';
 export 'src/hint.dart';
 export 'src/libedax.dart';
 export 'src/link.dart';

lib/src/best_path_num_with_link.dart

@@ -1,13 +1,11 @@
 import 'dart:ffi';
-import 'dart:math';
 
 import 'package:ffi/ffi.dart';
 import 'package:meta/meta.dart';
 
-import 'best_path_num_with_link.dart';
 import 'board.dart';
 import 'constants.dart';
-import 'count_best_path_result.dart';
+import 'count_bestpath_result.dart';
 import 'ffi/bindings/bindings.dart';
 import 'ffi/bindings/structs/board.dart' as c_board;
 import 'ffi/bindings/structs/hint.dart' as c_hint;
@@ -19,7 +17,6 @@ import 'hint.dart';
 import 'move.dart';
 import 'move_list_with_position.dart';
 import 'position.dart';
-import 'util.dart';
 
 @immutable
 class LibEdax {
@@ -376,148 +373,4 @@ class LibEdax {
   /// Stop edaxBookCountBestpath
   @experimental
   void edaxBookStopCountBestpath() => _bindings.edaxBookStopCountBestpath();
-
-  /// Compute the indicator of efficiency to win, which means the minimum number you should memorize on the situation both of players always choose one of the best move list.
-  ///
-  /// [level] is search depth. <br>
-  /// If [onlyBestScoreLink] is true, only compute the best score links on the current moves.
-  ///
-  /// This is a Dart level function, and unique feature to libedax4dart.
-  ///
-  /// btw, you can also see the graph of tree generated by this function, with using `BestPathNumWithLink.root.exportGraphvizDotFile()`. <br>
-  /// e.g. on a light book, when current moves is 'f5f6', you can get a graph like this([graphviz online](https://bit.ly/3edxWGO)).
-  ///
-  /// This function is not only experimental but also __advanced__. <br>
-  /// __You must understand [the book structure of edax](https://choi.lavox.net/edax/book) and following important notice list__.
-  ///
-  /// * Because internal each node lookup is stopped when book has no links, the more lower the accuracy of your book is, the more lower this feature accuracy is.
-  ///   * In addition, if your book has some depth links (e.g. 24, 30, 40, ...), shallow depth link (≈ path is few) can be taken with a reasonable probability.
-  ///   * __In a word, if the accuracy of your book is low, you shoudn't use this function__. For you reference, if your book has N GB and the depth is more than 30, this feature can probably be inidicator.
-  /// * This function only lookup the best score links. So, this indicator can't consider easy win links which is _not_ best score. In reversi game, the situation can sometimes be found in my experience as a player.
-  ///   * __In a word, as you know, this indicator isn't perfect. This is just a indicator__.
-  /// * The depth of this feature depends on [level] or your book.
-  /// * The moves which meet up with anoter moves is counted respectively.
-  ///   * btw, symmetric moves is counted 1 because of edax book structure.
-  /// * O(k^N). slow.
-  ///   * TODO(developer): consider following implementation.
-  ///     * isolation.
-  ///     * save tree data on local.
-  ///
-  /// REF: https://github.com/abulmo/edax-reversi/blob/1ae7c9fe5322ac01975f1b3196e788b0d25c1e10/src/book.c#L2438-L2447
-  @Deprecated('use edax_book_count_bestpath and edax_book_stop_count_bestpath')
-  @experimental
-  List<BestPathNumWithLink> computeBestPathNumWithLink({
-    required final int level,
-    final bool onlyBestScoreLink = true,
-    final bool enableToPrintMovesOnBuildingTree = false,
-  }) {
-    final headMoves = edaxGetMoves();
-    final maxDepth = headMoves.length + level * 2;
-    if (headMoves.isEmpty || headMoves.length >= maxDepth) return [];
-
-    final headColor = edaxGetCurrentPlayer();
-    final moveListWithPosition = edaxGetBookMoveWithPositionByMoves(headMoves);
-    final position = moveListWithPosition.position;
-    final targetRootLinks = onlyBestScoreLink ? position.bestScoreLinks : position.links;
-
-    return targetRootLinks.map((final link) {
-      final move = symetryMove(link.move, moveListWithPosition.symetry);
-      final root = BestPathNumNode(
-        null,
-        BestPathNumNodeValue(
-          headMoves + move2String(move),
-          headColor == TurnColor.black ? TurnColor.white : TurnColor.black,
-        ),
-      );
-      _buildTree(root, maxDepth, enableToPrintMovesOnBuildingTree);
-      return BestPathNumWithLink(
-        root.value.bestPathNumOfBlack,
-        root.value.bestPathNumOfWhite,
-        link,
-        move,
-        root,
-      );
-    }).toList();
-  }
-
-  /// See: [computeBestPathNumWithLink]
-  ///
-  /// you can get BestPathNumWithLink one by one.
-  @Deprecated('use edax_book_count_bestpath and edax_book_stop_count_bestpath')
-  @experimental
-  Stream<BestPathNumWithLink> streamOfBestPathNumWithLink({
-    required final int level,
-    final bool onlyBestScoreLink = true,
-    final bool enableToPrintMovesOnBuildingTree = false,
-  }) async* {
-    final headMoves = edaxGetMoves();
-    final maxDepth = headMoves.length + level * 2;
-    if (headMoves.isEmpty || headMoves.length >= maxDepth) return;
-
-    final headColor = edaxGetCurrentPlayer();
-    final moveListWithPosition = edaxGetBookMoveWithPositionByMoves(headMoves);
-    final position = moveListWithPosition.position;
-    final targetRootLinks = onlyBestScoreLink ? position.bestScoreLinks : position.links;
-
-    for (final link in targetRootLinks) {
-      final move = symetryMove(link.move, moveListWithPosition.symetry);
-      final root = BestPathNumNode(
-        null,
-        BestPathNumNodeValue(
-          headMoves + move2String(move),
-          headColor == TurnColor.black ? TurnColor.white : TurnColor.black,
-        ),
-      );
-      _buildTree(root, maxDepth, enableToPrintMovesOnBuildingTree);
-      yield BestPathNumWithLink(
-        root.value.bestPathNumOfBlack,
-        root.value.bestPathNumOfWhite,
-        link,
-        move,
-        root,
-      );
-    }
-  }
-
-  @Deprecated('use edax_book_count_bestpath and edax_book_stop_count_bestpath')
-  void _buildTree(final BestPathNumNode parent, final int maxDepth, final bool enableToPrintMovesOnBuildingTree) {
-    if (parent.value.moves.length >= maxDepth) {
-      // On edge, reagard (1,1) .
-      parent.value.bestPathNumOfBlack = 1;
-      parent.value.bestPathNumOfWhite = 1;
-      return;
-    }
-    final moveListWithPosition = edaxGetBookMoveWithPositionByMoves(parent.value.moves);
-    final position = moveListWithPosition.position;
-    if (position.links.isEmpty) {
-      // On edge, reagard (1,1) .
-      parent.value.bestPathNumOfBlack = 1;
-      parent.value.bestPathNumOfWhite = 1;
-      return;
-    }
-
-    final addedNodeList = position.bestScoreLinks.map((final link) {
-      final move = symetryMove(link.move, moveListWithPosition.symetry);
-      final node = BestPathNumNode(
-        parent,
-        BestPathNumNodeValue(
-          parent.value.moves + move2String(move),
-          parent.value.currentColor == TurnColor.black ? TurnColor.white : TurnColor.black,
-        ),
-      );
-      if (enableToPrintMovesOnBuildingTree) print(node.value.moves); // ignore: avoid_print
-      _buildTree(node, maxDepth, enableToPrintMovesOnBuildingTree);
-      return node;
-    });
-    for (final addedNode in addedNodeList) {
-      parent.children.add(addedNode);
-      if (parent.value.currentColor == TurnColor.black) {
-        parent.value.bestPathNumOfWhite += addedNode.value.bestPathNumOfWhite;
-        parent.value.bestPathNumOfBlack = min(parent.value.bestPathNumOfBlack, addedNode.value.bestPathNumOfBlack);
-      } else {
-        parent.value.bestPathNumOfBlack += addedNode.value.bestPathNumOfBlack;
-        parent.value.bestPathNumOfWhite = min(parent.value.bestPathNumOfWhite, addedNode.value.bestPathNumOfWhite);
-      }
-    }
-  }
 }

lib/src/count_best_path_result.dart lib/src/count_bestpath_result.dartlib/src/count_best_path_result.dart renamed to lib/src/count_bestpath_result.dart

@@ -1,7 +1,7 @@
 # See: https://dart.dev/tools/pub/publishing
 
 name: libedax4dart
-version: 1.4.0
+version: 1.5.0
 description: Dart wrapper for libedax. With using libedax4dart, you can execute functions equivalent to edax.
 homepage: https://github.com/sensuikan1973/libedax4dart
 documentation: https://sensuikan1973.github.io/libedax4dart

lib/src/libedax.dart

@@ -311,81 +311,6 @@ void main() {
         ..edaxBookStopCountBestpath()
         ..libedaxTerminate();
     });
-
-    group('Deprecated functions', () {
-      group('computeBestPathNumWithLink', () {
-        test('with no moves', () {
-          const initParams = ['', '-book-file', _testBookFile];
-          final edax = LibEdax()..libedaxInitialize(initParams);
-          sleep(const Duration(seconds: 1));
-          edax.edaxInit();
-          final bestPathNumWithLink = edax.computeBestPathNumWithLink(level: 40);
-          expect(bestPathNumWithLink.isEmpty, true);
-          edax.libedaxTerminate();
-        });
-
-        test('with moves f5f6', () {
-          const initParams = ['', '-book-file', _testBookFile];
-          final edax = LibEdax()..libedaxInitialize(initParams);
-          sleep(const Duration(seconds: 1));
-          edax
-            ..edaxInit()
-            ..edaxPlay('f5f6');
-          final bestPathNumWithLink = edax.computeBestPathNumWithLink(level: 40);
-          expect(bestPathNumWithLink.length, 1);
-          expect(bestPathNumWithLink.first.moveString, 'e6');
-          expect(bestPathNumWithLink.first.bestPathNumOfBlack, 2);
-          expect(bestPathNumWithLink.first.bestPathNumOfWhite, 1);
-          edax.libedaxTerminate();
-        });
-
-        test('with long moves less than 40, exportGraphvizDotFile', () {
-          const initParams = ['', '-book-file', _testBookFile];
-          const moves = 'F5f6e6d6e7g5c5c6e3d3c7f3f4g4g3d7e8c8c4f7c2d2f2h3d8f8g6h5g7b5h7c3b4e1';
-          final edax = LibEdax()..libedaxInitialize(initParams);
-          sleep(const Duration(seconds: 1));
-          edax
-            ..edaxInit()
-            ..edaxPlay(moves);
-          final bestPathNumWithLink = edax.computeBestPathNumWithLink(level: 40);
-          expect(bestPathNumWithLink.length, 1);
-          print(bestPathNumWithLink.first.root.exportGraphvizDotFile()); // ignore: avoid_print
-          expect(bestPathNumWithLink.first.moveString, 'd1');
-          expect(bestPathNumWithLink.first.bestPathNumOfBlack, 1);
-          expect(bestPathNumWithLink.first.bestPathNumOfWhite, 1);
-          edax.libedaxTerminate();
-        });
-
-        test('with moves greater than book level', () {
-          const initParams = ['', '-book-file', _testBookFile];
-          const moves = 'F5f6e6d6e7g5c5c6e3d3c7f3f4g4g3d7e8c8c4f7c2d2f2h3d8f8g6h5g7b5h7c3b4e1d1a5a4a3b2b2a2a1';
-          final edax = LibEdax()..libedaxInitialize(initParams);
-          sleep(const Duration(seconds: 1));
-          edax
-            ..edaxInit()
-            ..edaxPlay(moves);
-          final bestPathNumWithLink = edax.computeBestPathNumWithLink(level: 40);
-          expect(bestPathNumWithLink.isEmpty, true);
-          edax.libedaxTerminate();
-        });
-      });
-
-      group('streamOfBestPathNumWithLink', () {
-        test('with moves f5f6', () async {
-          const initParams = ['', '-book-file', _testBookFile];
-          final edax = LibEdax()..libedaxInitialize(initParams);
-          await Future<void>.delayed(const Duration(seconds: 1));
-          edax
-            ..edaxInit()
-            ..edaxPlay('f5f6');
-          final stream = edax.streamOfBestPathNumWithLink(level: 10);
-          await Future<void>.delayed(const Duration(seconds: 1));
-          final firstEvent = await stream.first;
-          expect(firstEvent.moveString, 'e6');
-          edax.libedaxTerminate();
-        });
-      });
-    });
   });
 
   group('util command', () {