MDAG (HanLP portable-1.3.4 API)

java.lang.Object
- com.hankcs.hanlp.collection.MDAG.MDAG

所有已实现的接口:

ICacheAble

直接已知子类:

MDAGSet
```
public class MDAG
extends Object
implements ICacheAble
```
最小环形图
A minimalistic directed acyclical graph suitable for storing a set of Strings.

作者:

Kevin

字段概要

字段
限定符和类型	字段和说明
`protected TreeSet<Character>`	`charTreeSet` 字母表
`protected HashMap<MDAGNode,MDAGNode>`	`equivalenceClassMDAGNodeHashMap` 等价类集合，相当于论文中的register
`protected SimpleMDAGNode[]`	`mdagDataArray` 调用simplify()后填充此空间
`protected SimpleMDAGNode`	`simplifiedSourceNode` 简化后的根节点（简化指的是用数组简化，而不是最小化，这个结构永远是最小化的）
`protected MDAGNode`	`sourceNode` 根节点
`protected int`	`transitionCount` 所有边的数量

构造器概要

构造器
构造器和说明
`MDAG()` 空白图
`MDAG(BufferedReader dataFileBufferedReader)` 从一个打开的BufferedReader构造
`MDAG(Collection<String> strCollection)` Creates an MDAG from a collection of Strings.
`MDAG(File dataFile)` 从一个文件建立MDAG Creates an MDAG from a newline delimited file containing the data of interest.
`MDAG(String path)` 从文件路径构造

方法概要

All Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`HashMap<MDAGNode,MDAGNode>`	`_getEquivalenceClassMDAGNodeHashMap()` 调试用
`void`	`addString(String str)` Adds a string to the MDAG.
`void`	`addStrings(Collection<String> strCollection)` Adds a Collection of Strings to the MDAG.
`boolean`	`contains(String str)` 是否包含 Determines whether a String is present in the MDAG.
`HashSet<String>`	`getAllStrings()` 取出所有key Retrieves all the valid Strings that have been inserted in to the MDAG.
`SimpleMDAGNode[]`	`getSimpleMDAGArray()` 获取简化后的状态Array Returns the array of SimpleMDAGNodes collectively containing the data of this MDAG, or null if it hasn't been simplified yet.
`HashSet<String>`	`getStringsEndingWith(String suffixStr)` 后缀查询 Retrieves all the Strings in the MDAG that begin with a given String.
`HashSet<String>`	`getStringsStartingWith(String prefixStr)` 前缀查询 Retrieves all the Strings in the MDAG that begin with a given String.
`HashSet<String>`	`getStringsWithSubstring(String str)` 返回包含字串的key Retrieves all the Strings in the MDAG that contain a given String.
`boolean`	`load(ByteArray byteArray)` 载入
`void`	`removeString(String str)` Removes a String from the MDAG.
`void`	`save(DataOutputStream out)` 写入
`void`	`simplify()` 固化自己 Creates a space-saving version of the MDAG in the form of an array.
`void`	`unSimplify()` 解压缩

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - sourceNode
```
protected MDAGNode sourceNode
```
    根节点
  - simplifiedSourceNode
```
protected SimpleMDAGNode simplifiedSourceNode
```
    简化后的根节点（简化指的是用数组简化，而不是最小化，这个结构永远是最小化的）
  - equivalenceClassMDAGNodeHashMap
```
protected HashMap<MDAGNode,MDAGNode> equivalenceClassMDAGNodeHashMap
```
    等价类集合，相当于论文中的register
  - mdagDataArray
```
protected SimpleMDAGNode[] mdagDataArray
```
    调用simplify()后填充此空间
  - charTreeSet
```
protected TreeSet<Character> charTreeSet
```
    字母表
  - transitionCount
```
protected int transitionCount
```
    所有边的数量
- 构造器详细资料
  - MDAG
```
public MDAG(String path)
     throws IOException
```
    从文件路径构造
    
    参数:
    
    path -
    
    抛出:
    
    IOException
  - MDAG
```
public MDAG(File dataFile)
     throws IOException
```
    从一个文件建立MDAG
    Creates an MDAG from a newline delimited file containing the data of interest.
    
    参数:
    
    dataFile - a File representation of a file containing the Strings that the MDAG will contain
    
    抛出:
    
    IOException - if datafile cannot be opened, or a read operation on it cannot be carried out
  - MDAG
```
public MDAG(BufferedReader dataFileBufferedReader)
     throws IOException
```
    从一个打开的BufferedReader构造
    
    参数:
    
    dataFileBufferedReader -
    
    抛出:
    
    IOException
  - MDAG
```
public MDAG(Collection<String> strCollection)
```
    Creates an MDAG from a collection of Strings.
    
    参数:
    
    strCollection - a Collection containing Strings that the MDAG will contain
  - MDAG
```
public MDAG()
```
    空白图
- 方法详细资料
  - save
```
public void save(DataOutputStream out)
          throws Exception
```
    从接口复制的说明: ICacheAble
    
    写入
    
    指定者:
    
    save 在接口中 ICacheAble
    
    抛出:
    
    Exception
  - load
```
public boolean load(ByteArray byteArray)
```
    从接口复制的说明: ICacheAble
    
    载入
    
    指定者:
    
    load 在接口中 ICacheAble
    
    返回:
  - addStrings
```
public final void addStrings(Collection<String> strCollection)
```
    Adds a Collection of Strings to the MDAG.
    
    参数:
    
    strCollection - a Collection containing Strings to be added to the MDAG
  - addString
```
public void addString(String str)
```
    Adds a string to the MDAG.
    
    参数:
    
    str - the String to be added to the MDAG
  - removeString
```
public void removeString(String str)
```
    Removes a String from the MDAG.
    
    参数:
    
    str - the String to be removed from the MDAG
  - simplify
```
public void simplify()
```
    固化自己
    Creates a space-saving version of the MDAG in the form of an array. Once the MDAG is simplified, Strings can no longer be added to or removed from it.
  - unSimplify
```
public void unSimplify()
```
    解压缩
  - contains
```
public boolean contains(String str)
```
    是否包含
    Determines whether a String is present in the MDAG.
    
    参数:
    
    str - the String to be searched for
    
    返回:
    
    true if str is present in the MDAG, and false otherwise
  - getAllStrings
```
public HashSet<String> getAllStrings()
```
    取出所有key
    Retrieves all the valid Strings that have been inserted in to the MDAG.
    
    返回:
    
    a HashSet containing all the Strings that have been inserted into the MDAG
  - getStringsStartingWith
```
public HashSet<String> getStringsStartingWith(String prefixStr)
```
    前缀查询
    Retrieves all the Strings in the MDAG that begin with a given String.
    
    参数:
    
    prefixStr - a String that is the prefix for all the desired Strings
    
    返回:
    
    a HashSet containing all the Strings present in the MDAG that begin with prefixString
  - getStringsWithSubstring
```
public HashSet<String> getStringsWithSubstring(String str)
```
    返回包含字串的key
    Retrieves all the Strings in the MDAG that contain a given String.
    
    参数:
    
    str - a String that is contained in all the desired Strings
    
    返回:
    
    a HashSet containing all the Strings present in the MDAG that begin with prefixString
  - getStringsEndingWith
```
public HashSet<String> getStringsEndingWith(String suffixStr)
```
    后缀查询
    Retrieves all the Strings in the MDAG that begin with a given String.
    
    参数:
    
    suffixStr - a String that is the suffix for all the desired Strings
    
    返回:
    
    a HashSet containing all the Strings present in the MDAG that end with suffixStr
  - getSimpleMDAGArray
```
public SimpleMDAGNode[] getSimpleMDAGArray()
```
    获取简化后的状态Array
    Returns the array of SimpleMDAGNodes collectively containing the data of this MDAG, or null if it hasn't been simplified yet.
    
    返回:
    
    the array of SimpleMDAGNodes collectively containing the data of this MDAG if this MDAG has been simplified, or null if it has not
  - _getEquivalenceClassMDAGNodeHashMap
```
public HashMap<MDAGNode,MDAGNode> _getEquivalenceClassMDAGNodeHashMap()
```
    调试用
    
    返回:

类 MDAG

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

sourceNode

simplifiedSourceNode

equivalenceClassMDAGNodeHashMap

mdagDataArray

charTreeSet

transitionCount

构造器详细资料

MDAG

MDAG

MDAG

MDAG

MDAG

方法详细资料

save

load

addStrings

addString

removeString

simplify

unSimplify

contains

getAllStrings

getStringsStartingWith

getStringsWithSubstring

getStringsEndingWith

getSimpleMDAGArray

_getEquivalenceClassMDAGNodeHashMap