HashAndBinaryTreeSearch (LHA Library for Java)

java.lang.Object
- jp.gr.java_conf.dangan.util.lha.HashAndBinaryTreeSearch

All Implemented Interfaces:: LzssSearchMethod

public class HashAndBinaryTreeSearch
extends java.lang.Object
implements LzssSearchMethod

ハッシュと二分木を使った LzssSearchMethod の実装。

 データ圧縮ハンドブック[改定第二版]
        M.ネルソン/J.-L.ゲィリー 著
                萩原剛志・山口英 訳
                  ISBN4-8101-8605-9
                             5728円(税抜き,当方の購入当時の価格)

を参考にした。
二分木では、最長一致を見つけることはできるが、最も近い一致を見つけられるとは限らないため、 LZSSで一致位置が近い場所に偏る事を利用するような -lh5- のような圧縮法では、圧縮率はいくらか低下する。

 -- revision history --
 $Log: HashAndBinaryTreeSearch.java,v $
 Revision 1.0  2002/08/05 00:00:00  dangan
 add to version control
 [change]
     LzssSearchMethod のインタフェイス変更にあわせてインタフェイス変更
 [maintenance]
     ソース整備
     タブ廃止
     ライセンス文の修正

Version:: $Revision: 1.0 $
Author:: $Author: dangan $

Constructor Summary

Constructors
Constructor and Description
`HashAndBinaryTreeSearch(int DictionarySize, int MaxMatch, int Threshold, byte[] TextBuffer)` ハッシュと二分木を使用した検索機構を構築する。ハッシュ関数はデフォルトのものを使用する。
`HashAndBinaryTreeSearch(int DictionarySize, int MaxMatch, int Threshold, byte[] TextBuffer, java.lang.String HashMethodClassName)` ハッシュと二分木を使用した LzssSearchMethod を構築する。

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`put(int position)` position から始まるデータパタンをハッシュと二分木を使用した検索機構に登録する。
`int`	`putRequires()` put() または searchAndPut() を使用してデータパタンを二分木に登録する際に必要とするデータ量を得る。二分木は登録の際にデータパタンを構成する全て(MaxMatchバイト)のデータを必要とする。
`int`	`search(int position, int lastPutPos)` ハッシュと二分木を使用した検索機構に登録されたデータパタンを検索し position から始まるデータパタンと最長の一致を持つものを得る。 TextBuffer.length < position + MaxMatch となるような position では、二分木を完全に走査しないため最長一致を得られるとは限らない。
`int`	`searchAndPut(int position)` ハッシュと二分木を使用した検索機構に登録されたデータパタンから position から始まるデータパタンと最長の一致を持つものを検索し、同時に position から始まるデータパタンをハッシュと二分木を使用した検索機構に登録する。
`void`	`slide()` TextBuffer内の position までのデータを前方へ移動する際、それに応じてハッシュと二分木を使用した検索機構を構成するデータも TextBuffer内のデータと矛盾しないように前方へ移動する処理を行う。

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HashAndBinaryTreeSearch
```
public HashAndBinaryTreeSearch(int DictionarySize,
                               int MaxMatch,
                               int Threshold,
                               byte[] TextBuffer)
```
    ハッシュと二分木を使用した検索機構を構築する。
    ハッシュ関数はデフォルトのものを使用する。
    
    Parameters:
    
    DictionarySize - 辞書サイズ
    
    MaxMatch - 最長一致長
    
    Threshold - 圧縮、非圧縮の閾値
    
    TextBuffer - LZSS圧縮を施すためのバッファ
  - HashAndBinaryTreeSearch
```
public HashAndBinaryTreeSearch(int DictionarySize,
                               int MaxMatch,
                               int Threshold,
                               byte[] TextBuffer,
                               java.lang.String HashMethodClassName)
```
    ハッシュと二分木を使用した LzssSearchMethod を構築する。
    
    Parameters:
    
    DictionarySize - 辞書サイズ
    
    MaxMatch - 最長一致長
    
    Threshold - 圧縮、非圧縮の閾値
    
    TextBuffer - LZSS圧縮を施すためのバッファ
    
    HashMethodClassName - Hash関数を提供するクラス名
    
    Throws:
    
    java.lang.NoClassDefFoundError - HashMethodClassName で与えられたクラスが見つからない場合。
    
    java.lang.InstantiationError - HashMethodClassName で与えられたクラスが abstract class であるためインスタンスを生成できない場合。
    
    java.lang.NoSuchMethodError - HashMethodClassName で与えられたクラスがコンストラクタ HashMethod( byte[] ) を持たない場合
- Method Detail
  - put
```
public void put(int position)
```
    position から始まるデータパタンをハッシュと二分木を使用した検索機構に登録する。
    
    Specified by:
    
    put in interface LzssSearchMethod
    
    Parameters:
    
    position - TextBuffer内のデータパタンの開始位置
  - searchAndPut
```
public int searchAndPut(int position)
```
    ハッシュと二分木を使用した検索機構に登録されたデータパタンから position から始まるデータパタンと最長の一致を持つものを検索し、同時に position から始まるデータパタンをハッシュと二分木を使用した検索機構に登録する。
    
    Specified by:
    
    searchAndPut in interface LzssSearchMethod
    
    Parameters:
    
    position - TextBuffer内のデータパタンの開始位置。
    
    Returns:
    
    一致が見つかった場合は LzssOutputStream.createSearchReturn によって生成された一致位置と一致長の情報を持つ値、一致が見つからなかった場合は LzssOutputStream.NOMATCH。
    
    See Also:
    
    LzssOutputStream.createSearchReturn(int,int), LzssOutputStream.NOMATCH
  - search
```
public int search(int position,
                  int lastPutPos)
```
    ハッシュと二分木を使用した検索機構に登録されたデータパタンを検索し position から始まるデータパタンと最長の一致を持つものを得る。
    TextBuffer.length < position + MaxMatch となるような position では、二分木を完全に走査しないため最長一致を得られるとは限らない。
    
    Specified by:
    
    search in interface LzssSearchMethod
    
    Parameters:
    
    position - TextBuffer内のデータパタンの開始位置。
    
    lastPutPos - 最後に登録したデータパタンの開始位置。
    
    Returns:
    
    一致が見つかった場合は LzssOutputStream.createSearchReturn によって生成された一致位置と一致長の情報を持つ値、一致が見つからなかった場合は LzssOutputStream.NOMATCH。
    
    See Also:
    
    LzssOutputStream.createSearchReturn(int,int), LzssOutputStream.NOMATCH
  - slide
```
public void slide()
```
    TextBuffer内の position までのデータを前方へ移動する際、それに応じてハッシュと二分木を使用した検索機構を構成するデータも TextBuffer内のデータと矛盾しないように前方へ移動する処理を行う。
    
    Specified by:
    
    slide in interface LzssSearchMethod
  - putRequires
```
public int putRequires()
```
    put() または searchAndPut() を使用してデータパタンを二分木に登録する際に必要とするデータ量を得る。
    二分木は登録の際にデータパタンを構成する全て(MaxMatchバイト)のデータを必要とする。
    
    Specified by:
    
    putRequires in interface LzssSearchMethod
    
    Returns:
    
    コンストラクタで与えた MaxMatch

When you found typographical errors or omissions, Please mail to cqw10305@nifty.com
The company name and product name which are used in this document, it is the trademark or registered trademark of each company generally.
Copyright © 2001-2002 Michel Ishizuka. All Rights Reserved.

Class HashAndBinaryTreeSearch

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HashAndBinaryTreeSearch

HashAndBinaryTreeSearch

Method Detail

put

searchAndPut

search

slide

putRequires