Merge pull request #66 from Apricot-S/develop

v3.1.0

Author: Apricot-S

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "xiangting"
 description = "A library for calculating the deficiency number (a.k.a. xiangting number, 向聴数)."
-version = "3.0.0"
+version = "3.1.0"
 authors = ["Apricot S."]
 edition = "2021"
 license = "MIT"

src/bingpai.rs

@@ -8,25 +8,9 @@ use thiserror::Error;
 /// 兵牌: Hand excluding melds (a.k.a. pure hand, 純手牌).
 ///
 /// Each element of the array represents the count of a specific tile in the hand.
-/// The correspondence between the index and the tile is shown in the table below.
+/// The correspondence between the index and the tile is the same as [`Tile`](crate::Tile).
 ///
-/// | Index | 0   | 1   | 2   | 3   | 4   | 5   | 6   | 7   | 8   |
-/// | ----- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
-/// | Tile  | 1m  | 2m  | 3m  | 4m  | 5m  | 6m  | 7m  | 8m  | 9m  |
-///
-/// | Index | 9   | 10  | 11  | 12  | 13  | 14  | 15  | 16  | 17  |
-/// | ----- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
-/// | Tile  | 1p  | 2p  | 3p  | 4p  | 5p  | 6p  | 7p  | 8p  | 9p  |
-///
-/// | Index | 18  | 19  | 20  | 21  | 22  | 23  | 24  | 25  | 26  |
-/// | ----- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
-/// | Tile  | 1s  | 2s  | 3s  | 4s  | 5s  | 6s  | 7s  | 8s  | 9s  |
-///
-/// | Index | 27        | 28         | 29        | 30         | 31         | 32         | 33       |
-/// | ----- | --------- | ---------- | --------- | ---------- | ---------- | ---------- | -------- |
-/// | Tile  | East (1z) | South (2z) | West (3z) | North (4z) | White (5z) | Green (6z) | Red (7z) |
-///
-/// See also [`InvalidShoupaiError`](crate::InvalidShoupaiError) for more information.
+/// See also [`InvalidBingpaiError`](crate::InvalidBingpaiError) for more information.
 ///
 /// # Examples
 ///

src/fulu_mianzi.rs

@@ -3,11 +3,10 @@
 // This file is part of https://github.com/Apricot-S/xiangting
 
 use crate::constants::{MAX_SHUPAI_INDEX, MAX_TILE_INDEX, NUM_TILE_INDEX};
+use crate::tile::Tile;
 use std::fmt;
 use thiserror::Error;
 
-type Tile = u8;
-
 /// Position of the claimed tile in the melded sequence.
 /// Used in [`FuluMianzi::Shunzi`](self::FuluMianzi::Shunzi).
 #[derive(Debug, Clone)]
@@ -42,11 +41,6 @@ pub enum ClaimedTilePosition {
 pub enum FuluMianzi {
     /// 順子: Sequence.
     ///
-    /// The first argument represents the index of the tile.
-    /// The second argument represents the position of the claimed tile in the meld.
-    /// The correspondence between the index and the tile is the same as
-    /// [`Bingpai`](crate::Bingpai).
-    ///
     /// # Examples
     ///
     /// ```
@@ -63,10 +57,6 @@ pub enum FuluMianzi {
     Shunzi(Tile, ClaimedTilePosition),
     /// 刻子: Triplet.
     ///
-    /// The argument represents the index of the tile.
-    /// The correspondence between the index and the tile is the same as
-    /// [`Bingpai`](crate::Bingpai).
-    ///
     /// # Examples
     ///
     /// ```
@@ -77,10 +67,6 @@ pub enum FuluMianzi {
     Kezi(Tile),
     /// 槓子: Quad.
     ///
-    /// The argument represents the index of the tile.
-    /// The correspondence between the index and the tile is the same as
-    /// [`Bingpai`](crate::Bingpai).
-    ///
     /// # Examples
     ///
     /// ```

src/lib.rs

@@ -48,6 +48,8 @@ mod shisanyao;
 mod shoupai;
 #[cfg(not(feature = "build-file"))]
 mod standard;
+#[cfg(not(feature = "build-file"))]
+mod tile;
 
 #[cfg(not(feature = "build-file"))]
 pub use bingpai::{Bingpai, InvalidBingpaiError};
@@ -57,6 +59,8 @@ pub use calculate::{calculate_replacement_number, calculate_replacement_number_3
 pub use fulu_mianzi::{ClaimedTilePosition, FuluMianzi, InvalidFuluMianziError};
 #[cfg(not(feature = "build-file"))]
 pub use shoupai::{FuluMianziList, InvalidShoupaiError};
+#[cfg(not(feature = "build-file"))]
+pub use tile::Tile;
 
 #[cfg(feature = "build-map")]
 #[doc(hidden)]

src/tile.rs

@@ -0,0 +1,25 @@
+// SPDX-FileCopyrightText: 2025 Apricot S.
+// SPDX-License-Identifier: MIT
+// This file is part of https://github.com/Apricot-S/xiangting
+
+/// 牌: Tile.
+///
+/// The value represents the index of the tile.
+/// The correspondence between the index and the tile is shown in the table below.
+///
+/// | Index | 0   | 1   | 2   | 3   | 4   | 5   | 6   | 7   | 8   |
+/// | ----- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
+/// | Tile  | 1m  | 2m  | 3m  | 4m  | 5m  | 6m  | 7m  | 8m  | 9m  |
+///
+/// | Index | 9   | 10  | 11  | 12  | 13  | 14  | 15  | 16  | 17  |
+/// | ----- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
+/// | Tile  | 1p  | 2p  | 3p  | 4p  | 5p  | 6p  | 7p  | 8p  | 9p  |
+///
+/// | Index | 18  | 19  | 20  | 21  | 22  | 23  | 24  | 25  | 26  |
+/// | ----- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
+/// | Tile  | 1s  | 2s  | 3s  | 4s  | 5s  | 6s  | 7s  | 8s  | 9s  |
+///
+/// | Index | 27        | 28         | 29        | 30         | 31         | 32         | 33       |
+/// | ----- | --------- | ---------- | --------- | ---------- | ---------- | ---------- | -------- |
+/// | Tile  | East (1z) | South (2z) | West (3z) | North (4z) | White (5z) | Green (6z) | Red (7z) |
+pub type Tile = u8;