Hungarian 算法 Python 实现

本文档将详细介绍如何使用和安装基于 Python 和 NumPy 实现的 Hungarian 算法。本算法适用于解决指派问题，它可以帮助找到在矩阵中使行和列配对成本最小或利润最大的方法。

1. 安装指南

在开始使用之前，您需要确保已安装了 Python 和 NumPy 库。

• 确保您的系统中已安装 Python。

• 使用 pip 安装 NumPy：

  pip install numpy
  

• 从 GitHub 仓库克隆或下载项目：

  git clone git://github.com/tdedecko/hungarian-algorithm.git
  

• 或者直接通过 pip 安装：

  pip install python-hungarian
  

2. 项目的使用说明

安装完成后，您可以通过以下步骤使用 Hungarian 算法。

创建 Hungarian 对象

您可以使用一个成本矩阵（costMatrix）初始化 Hungarian 对象。

hungarian = Hungarian(costMatrix)

或者，如果您想要创建一个 Hungarian 对象并在后续步骤中传入成本矩阵：

hungarian = Hungarian()
hungarian.calculate(costMatrix)

如果您的矩阵是利润矩阵（profitMatrix），则需要特别指定：

hungarian = Hungarian(profitMatrix, isProfitMatrix=True)

或者，将利润矩阵转换为成本矩阵：

costMatrix = Hungarian.makeCostMatrix(profitMatrix)

矩阵填充

如果您的矩阵不是方阵，它会自动被填充。您也可以手动进行填充：

paddedMatrix = Hungarian.padMatrix(costMatrix)

获取计算结果

完成计算后，您可以通过以下方法获取结果：

hungarian.getResults()

以及计算得到的总潜在值：

hungarian.getTotalPotential()

3. 项目API使用文档

以下是项目中主要的类和方法：

• Hungarian(costMatrix=None, isProfitMatrix=False): 创建一个 Hungarian 对象，可以传入成本矩阵或利润矩阵。
• calculate(costMatrix=None): 计算成本矩阵或利润矩阵的指派。
• getResults(): 返回计算后的结果。
• getTotalPotential(): 返回计算后的总潜在值。
• padMatrix(matrix): 手动填充矩阵至方阵。

4. 项目安装方式

请参考安装指南中提供的步骤进行安装。您可以通过 pip 或直接从 GitHub 仓库安装。确保安装了 NumPy 库后，再安装本项目。

以上是本项目的使用和技术文档，希望对您有所帮助。如果您在使用过程中遇到任何问题，请参考项目自带的帮助文档或相关资料。