Corpus (HanLP portable-1.5.3 API)

java.lang.Object
- com.hankcs.hanlp.mining.word2vec.Corpus

直接已知子类:: CacheCorpus, TextFileCorpus

public abstract class Corpus
extends Object

字段概要

字段
限定符和类型	字段和说明
`protected File`	`cacheFile`
`protected Config`	`config`
`protected Charset`	`encoding`
`protected boolean`	`eoc`
`protected int[]`	`table`
`protected int`	`trainWords`
`protected VocabWord[]`	`vocab`
`protected Map<String,Integer>`	`vocabIndexMap`
`protected int`	`vocabMaxSize`
`protected int`	`vocabSize`

构造器概要

构造器
构造器和说明

Corpus(Config config)

Corpus(Corpus cloneSrc)

构造器
构造器和说明
`Corpus(Config config)`
`Corpus(Corpus cloneSrc)`

方法概要

All Methods Instance Methods Abstract Methods Concrete Methods
限定符和类型	方法和说明
`protected int`	`addWordToVocab(String word)` Adds a word to the vocabulary
`void`	`close()` Close the corpus and it cannot be read any more.
`boolean`	`endOfCorpus()`
`int`	`getTrainWords()`
`VocabWord[]`	`getVocab()`
`Map<String,Integer>`	`getVocabIndexMap()`
`int`	`getVocabSize()`
`abstract String`	`nextWord()` Read the next word from the corpus
`int`	`readWordIndex()`
`void`	`rewind(int numThreads, int id)` reset current corpus to initial status
`void`	`shutdown()`

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

字段详细资料

cacheFile
```
protected File cacheFile
```

config
```
protected Config config
```

trainWords
```
protected int trainWords
```

vocabSize
```
protected int vocabSize
```

vocabMaxSize
```
protected int vocabMaxSize
```

vocab
```
protected VocabWord[] vocab
```

vocabIndexMap

protected Map<String,Integer> vocabIndexMap

eoc
```
protected boolean eoc
```

encoding
```
protected Charset encoding
```

table
```
protected int[] table
```

构造器详细资料

Corpus

public Corpus(Config config)
       throws IOException

抛出:: IOException

Corpus

public Corpus(Corpus cloneSrc)
       throws IOException

抛出:: IOException

方法详细资料
- endOfCorpus
```
public boolean endOfCorpus()
```
- addWordToVocab
```
protected int addWordToVocab(String word)
```
  Adds a word to the vocabulary
  
  参数:
  
  word -
  
  返回:
- getTrainWords
```
public int getTrainWords()
```
- getVocabSize
```
public int getVocabSize()
```
- getVocab
```
public VocabWord[] getVocab()
```
- getVocabIndexMap
```
public Map<String,Integer> getVocabIndexMap()
```
- rewind
```
public void rewind(int numThreads,
                   int id)
            throws IOException
```
  reset current corpus to initial status
  
  抛出:
  
  IOException
- readWordIndex
```
public int readWordIndex()
                  throws IOException
```
  返回:
  
  -4 if is dropped, -3 if end of sentence, -2 if end of corpus, -1 if word not found or index value of the word
  
  抛出:
  
  IOException
- nextWord
```
public abstract String nextWord()
                         throws IOException
```
  Read the next word from the corpus
  
  返回:
  
  next word that is read from the corpus. null will be returned
  
  抛出:
  
  IOException
- close
```
public void close()
           throws IOException
```
  Close the corpus and it cannot be read any more.
  
  抛出:
  
  IOException
- shutdown
```
public void shutdown()
              throws IOException
```
  抛出:
  
  IOException

类 Corpus

字段概要

构造器概要

方法概要

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

字段详细资料

cacheFile

config

trainWords

vocabSize

vocabMaxSize

vocab

vocabIndexMap

eoc

encoding

table

构造器详细资料

Corpus

Corpus

方法详细资料

endOfCorpus

addWordToVocab

getTrainWords

getVocabSize

getVocab

getVocabIndexMap

rewind

readWordIndex

nextWord

close

shutdown