net.trialpc.sticktools.model
クラス AbstractLangModel

java.lang.Object
  上位を拡張 net.trialpc.sticktools.model.AbstractLangModel
すべての実装されたインタフェース:
LangModel
直系の既知のサブクラス:
BaseModel, MultiSmoothedModel, SmoothedModel, WrapModel

public abstract class AbstractLangModel
extends java.lang.Object
implements LangModel

言語モデルの実装を容易にするために提供される抽象クラスです。

このクラスではいくつかのメソッドの実装が提供されていますが、 もしサブクラスでパフォーマンスの改良が行えるようなら、積極的にオーバーライドすることを推奨します。 また、実装されているメソッドの多くは、getVocabulary()numOfTerms()termCount(String) メソッドに依存しています。 依存するメソッドについては、それぞれのメソッドのドキュメントを参照してください。

作成者:
tethon
関連項目:
LangModel

コンストラクタの概要
AbstractLangModel()
           
 
メソッドの概要
 boolean containsTerm(java.lang.String term)
          語 term が語彙に含まれるかどうかを返します。
 boolean containsTerms(java.util.Collection<java.lang.String> c)
          コレクション c に含まれる語が語彙に 1 つ以上含まれるかを返します。
 boolean contaisQueries(java.util.Collection<Query> q)
          コレクション q に含まれるクエリが語彙に 1 つ以上含まれるかを返します。
 boolean isModifiable()
          言語モデルに含まれる語を変更可能かどうかを返します。
 int numOfVocabulary()
          この言語モデルに含まれる語の種類数(語彙数)を返します。
 float termFrequency(java.lang.String term)
          語 term の相対頻度を返します。
 java.lang.String toString()
          言語モデルの文字列表現を返します。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
インタフェース net.trialpc.sticktools.model.LangModel から継承されたメソッド
getVocabulary, numOfTerms, termCount
 

コンストラクタの詳細

AbstractLangModel

public AbstractLangModel()
メソッドの詳細

isModifiable

public boolean isModifiable()

言語モデルに含まれる語を変更可能かどうかを返します。

変更可能とは、語の追加や削除の処理が含まれます。 変更可能でない場合は、LangModel で定義されているメソッドは、 引数に応じて常に一定の値、またはインスタンスを返します。

この実装では、常に true を返します。 具象クラスとして変更不可能な言語モデルクラスを作成する場合は、 必ずオーバーライドするようにしてください。

定義:
インタフェース LangModel 内の isModifiable
戻り値:
変更可能であれば true、変更不可能であれば false

containsTerms

public boolean containsTerms(java.util.Collection<java.lang.String> c)

コレクション c に含まれる語が語彙に 1 つ以上含まれるかを返します。 この実装は containsTerm(String) メソッドに依存しています。

定義:
インタフェース LangModel 内の containsTerms
パラメータ:
c - 語を含むコレクション
戻り値:
語が言語モデルの語彙に 1 つでも含まれる場合は true
例外:
java.lang.NullPointerException - cnull である場合
関連項目:
containsTerm(String)

contaisQueries

public boolean contaisQueries(java.util.Collection<Query> q)

コレクション q に含まれるクエリが語彙に 1 つ以上含まれるかを返します。 この実装は containsTerm(String) メソッドに依存しています。

パラメータ:
q - クエリを含むコレクション
戻り値:
クエリが語彙に 1 つでも含まれる場合は true
例外:
java.lang.NullPointerException - qnull である場合
関連項目:
containsTerm(String)

containsTerm

public boolean containsTerm(java.lang.String term)

term が語彙に含まれるかどうかを返します。 このメソッドでは、引数に null が与えられても基本的には NullPointerException をスローすることはありません。

また、この実装は getVocabulary() メソッドに依存しています。

定義:
インタフェース LangModel 内の containsTerm
パラメータ:
term - 語
戻り値:
term が含まれているなら true
関連項目:
LangModel.getVocabulary()

numOfVocabulary

public int numOfVocabulary()
この言語モデルに含まれる語の種類数(語彙数)を返します。 語の種類数は、語彙の異なり語数とも呼ばれます。 通常、このメソッドで返される値は 0 以上です。

この実装は、getVocabulary() メソッドに依存しています。

定義:
インタフェース LangModel 内の numOfVocabulary
戻り値:
語の種類数
関連項目:
LangModel.getVocabulary()

termFrequency

public float termFrequency(java.lang.String term)
term の相対頻度を返します。 相対頻度とは、全体を 1 とした時の term の頻度のことです。 通常、このメソッドで返される値は 0 以上です。

この実装では、numOfTerms()termCount(String) メソッドに依存しています。

定義:
インタフェース LangModel 内の termFrequency
パラメータ:
term - 語(通常は単語と同義)
戻り値:
term の相対頻度
例外:
java.lang.NullPointerException - ternCount メソッドの引数として null を許可せず、 かつ termnull である場合
関連項目:
LangModel.numOfTerms(), LangModel.termCount(String)

toString

public java.lang.String toString()

言語モデルの文字列表現を返します。

この実装では、getVocabulary() メソッドと termCount(String) メソッドが適切に実装されている必要があります。

オーバーライド:
クラス java.lang.Object 内の toString
戻り値:
言語モデルの文字列表現
関連項目:
LangModel.getVocabulary(), LangModel.termCount(String)