SFXHeap

ヒープを表すクラスです。

#include <SFXHeap.h.hpp>

class SFXHeap;

SFMTYPEDEFCLASS(SFXHeap)

継承図

協調図

解説

SFXHeap クラスと SFXClusterHeap クラス

SFXHeap クラスと SFXClusterHeap クラスは、動的なヒープ管理を提供するクラスです。

SFXClusterHeap クラスはブロックアロケーションを行いますが、SFXHeap クラスはブロックアロケーションを行いません。

ヒープサイズの変更頻度が少ない場合、SFXHeap クラスを使う方がメモリ効率が良くなります。

Attach 関数と Detach 関数

SFXHeap::Attach 関数は、指定した型のデータの動作と管理権限を SFXHeap クラスのインスタンスにデリゲート(委譲) します。 SFXHeap::Detach 関数はその逆の操作を行います。

デリゲートとは : オブジェクト指向プログラミングにおいて、あるオブジェクトの振る舞いを別のオブジェクトに肩代わりして振る舞ってもらうことです。日本語では、「委譲」と訳されます。

例 767. Attach 関数の使用方法

SFXHeap<SInt16> heap;
VoidPtr swap;

// メモリを割り当てる
swap = MemoryAllocate(10240); 
...

// Void 型データ swap の動作と管理権限を SFXHeap クラスのインスタンス heap にデリゲートする
heap.Attach(swap, 10240);
// 以降、Void 型データ swap を SFXHeap クラスのインスタンス heap として操作できる

･･･

// 使用後、割り当てたメモリは自動的に解放される

例 768. Detach 関数の使用方法

SFXHeap heap;
VoidPtr swap;
UInt32 length;

...

// SFXHeap クラスのインスタンス heap の動作と管理権限を Void 型データ swap にデリゲートする
swap = heap.Detach(&length);
// 以降、SFXHeap クラスのインスタンス を Void 型データ swap として操作する

...

// 使用後、Void 型データ swap のメモリを解放する必要がある
MemoryFree(swap);

参照

SFXClusterHeap | ヒープクラス

メンバ

コンストラクタ/デストラクタ
SFXHeap( `Void` ) SFXHeap クラスのコンストラクタです。

パブリック関数
`SFCError`	Attach( `VoidPtr` heap , `UInt32` size ) 指定したデータ型の動作と管理権限を SFXHeap クラスのインスタンスにデリゲート (委譲) します。
`Bool`	Contains( `VoidConstPtr` heap , `UInt32` size ) オブジェクト内部のヒープと指定したヒープの中に共通部分があるか判定します。
`VoidPtr`	Detach( `UInt32Ptr` size = null ) SFXHeap クラスのインスタンスの動作と管理権限を Void 型データにデリゲート(委譲) します。
static `SFXHeap< T > const &`	EmptyInstance( `Void` ) 空のヒープを取得します。
`Void`	Free( `Void` ) SFXHeap クラスのインスタンスが管理しているヒープを解放します。
`VoidPtr`	GetHeap( `Void` ) SFXHeap クラスのインスタンスが管理しているヒープへのポインタを取得します。
`VoidConstPtr`	GetHeap( `Void` ) SFXHeap クラスのインスタンスが管理しているヒープへのポインタを取得します。
`UInt32`	GetSize( `Void` ) ヒープサイズを取得します。
`VoidConstPtr`	Protect( `VoidConstPtr` heap , `UInt32` size ) 指定したヒープを安全に割り当てます。( SFXHeap オブジェクトが指定したヒープと共通部分を持つ場合は、指定したヒープの内容を別の場所に移動して割り当てます )
`SFCError`	Resize( `UInt32` size ) ヒープのサイズを設定します。
`Void`	Unprotect( `VoidConstPtr` protect , `VoidConstPtr` heap ) SFXHeap::Protect 関数で割り当てたヒープを解放します。
`Bool`	operator==( `SFXHeap< T > const &` left , `SFXHeap< M > const &` right ) operator==( `VoidConstPtr` left , `SFXHeap< T > const &` right ) operator==( `SFXHeap< T > const &` left , `VoidConstPtr` right ) == の関係を判定します。
`Bool`	operator>=( `SFXHeap< T > const &` left , `SFXHeap< M > const &` right ) operator>=( `VoidConstPtr` left , `SFXHeap< T > const &` right ) operator>=( `SFXHeap< T > const &` left , `VoidConstPtr` right ) >= の関係を判定します。
`Bool`	operator>( `SFXHeap< T > const &` left , `SFXHeap< M > const &` right ) operator>( `VoidConstPtr` left , `SFXHeap< T > const &` right ) operator>( `SFXHeap< T > const &` left , `VoidConstPtr` right ) > の関係を判定します。
`Bool`	operator<=( `SFXHeap< T > const &` left , `SFXHeap< M > const &` right ) operator<=( `VoidConstPtr` left , `SFXHeap< T > const &` right ) operator<=( `SFXHeap< T > const &` left , `VoidConstPtr` right ) <= の関係を判定します。
`Bool`	operator<( `SFXHeap< T > const &` left , `SFXHeap< M > const &` right ) operator<( `VoidConstPtr` left , `SFXHeap< T > const &` right ) operator<( `SFXHeap< T > const &` left , `VoidConstPtr` right ) < の関係を判定します。
`Bool`	operator!=( `SFXHeap< T > const &` left , `SFXHeap< M > const &` right ) operator!=( `VoidConstPtr` left , `SFXHeap< T > const &` right ) operator!=( `SFXHeap< T > const &` left , `VoidConstPtr` right ) != の関係を判定します。
`Bool`	operator==( `SFXHeap< T > const &` left , `SFXHeap< M > const &` right ) operator==( `VoidConstPtr` left , `SFXHeap< T > const &` right ) operator==( `SFXHeap< T > const &` left , `VoidConstPtr` right ) == の関係を判定します。

グローバル関数
`Bool`	operator>=( `SFXHeap< T > const &` left , `SFXHeap< M > const &` right ) operator>=( `VoidConstPtr` left , `SFXHeap< T > const &` right ) operator>=( `SFXHeap< T > const &` left , `VoidConstPtr` right ) >= の関係を判定します。
`Bool`	operator>( `SFXHeap< T > const &` left , `SFXHeap< M > const &` right ) operator>( `VoidConstPtr` left , `SFXHeap< T > const &` right ) operator>( `SFXHeap< T > const &` left , `VoidConstPtr` right ) > の関係を判定します。
`Bool`	operator<=( `SFXHeap< T > const &` left , `SFXHeap< M > const &` right ) operator<=( `VoidConstPtr` left , `SFXHeap< T > const &` right ) operator<=( `SFXHeap< T > const &` left , `VoidConstPtr` right ) <= の関係を判定します。
`Bool`	operator<( `SFXHeap< T > const &` left , `SFXHeap< M > const &` right ) operator<( `VoidConstPtr` left , `SFXHeap< T > const &` right ) operator<( `SFXHeap< T > const &` left , `VoidConstPtr` right ) < の関係を判定します。
`Bool`	operator!=( `SFXHeap< T > const &` left , `SFXHeap< M > const &` right ) operator!=( `VoidConstPtr` left , `SFXHeap< T > const &` right ) operator!=( `SFXHeap< T > const &` left , `VoidConstPtr` right ) != の関係を判定します。

SFXHeap::SFXHeap

SFXHeap クラスのコンストラクタです。

[ public, explicit ]
SFXHeap(Void);

SFXHeap::Attach

指定したデータ型の動作と管理権限を SFXHeap クラスのインスタンスにデリゲート (委譲) します。

[ public ]
SFCError Attach(
    VoidPtr heap   // ヒープへのポインタ
    UInt32 size    // ヒープのサイズ
);

戻り値

成功したとき : SFERR_NO_ERROR
オブジェクト内部のヒープと指定したヒープの中に共通部分があるとき : SFERR_INVALID_PARAM

使用例

SFXHeap<SInt16> heap;
VoidPtr swap;

// メモリを割り当てる
swap = MemoryAllocate(10240); 
...

// Void 型データ swap の動作と管理権限を SFXHeap クラスのインスタンス heap にデリゲートする
heap.Attach(swap, 10240);
// 以降、Void 型データ swap を SFXHeap クラスのインスタンス heap として操作できる

･･･

// 使用後、割り当てたメモリは自動的に解放される

参照

SFXHeap::Detach

SFXHeap::Contains

オブジェクト内部のヒープと指定したヒープの中に共通部分があるか判定します。

[ public, const ]
Bool Contains(
    VoidConstPtr heap   // 比較するヒープへのポインタ
    UInt32 size         // 比較するヒープのサイズ(バイト単位)
);

戻り値

あるとき : true
ないとき : false

使用例

SFXHeap<SInt16> heap1;
heap1.Resize(sizeof(SInt16) * 128);  // heap1 のサイズを 256 バイトに設定する
SFXHeap<SInt16> heap2;

// heap2 は heap1 の両端を 10 バイトずつ削ったもの
heap2.Attach(static_cast<BytePtr>(heap1.GetHeap()) + 10, heap1.GetSize() - 20);

if (heap2.Contains(heap1.GetHeap(), heap1.GetSize())) {
  // 共通部分があるので、ここが実行される
  ...
} else {
  // ここは実行されない
  ...
}

SFXHeap::Detach

SFXHeap クラスのインスタンスの動作と管理権限を Void 型データにデリゲート(委譲) します。

[ public ]
VoidPtr Detach(
    UInt32Ptr size = null   // 持っていたヒープのサイズを格納する UInt32 型変数へのポインタ
);

戻り値

SFXHeap クラスのインスタンスが持っていたヒープへのポインタを返します。

解説

SFXHeap クラスのインスタンスが持つヒープはコピーされません。

size パラメータには SFXHeap クラスのインスタンスが持っていたヒープサイズが返されます。

使用例

SFXHeap heap;
VoidPtr swap;
UInt32 length;

...

// SFXHeap クラスのインスタンス heap の動作と管理権限を Void 型データ swap にデリゲートする
swap = heap.Detach(&length);
// 以降、SFXHeap クラスのインスタンス を Void 型データ swap として操作する

...

// 使用後、Void 型データ swap のメモリを解放する必要がある
MemoryFree(swap);

参照

SFXHeap::Attach

SFXHeap::EmptyInstance

空のヒープを取得します。

[ public, static ]
SFXHeap< T > const & EmptyInstance(Void);

解説

空のヒープを表すインスタンスを取得します。

SFXHeap::Free

SFXHeap クラスのインスタンスが管理しているヒープを解放します。

[ public ]
Void Free(Void);

使用例

SFXHeap<SInt16> heap;

...

heap.Free();   // 明示的にヒープを解放する

SFXHeap::GetHeap

SFXHeap クラスのインスタンスが管理しているヒープへのポインタを取得します。

[ public ]
VoidPtr GetHeap(Void);

[ public, const ]
VoidConstPtr GetHeap(Void);

戻り値

SFXHeap クラスのインスタンスが管理しているヒープへのポインタを返します。

使用例

SFXHeap<SInt16> heap;

// ヒープのサイズ設定する 
if (heap.Resize(sizeof(SInt16) * 128) == SFERR_NO_ERROR) {
    TRACE("addr = 0x%08X", heap.GetHeap());  // addr = 0x0686FF80
}

SFXHeap::GetSize

ヒープサイズを取得します。

[ public, const ]
UInt32 GetSize(Void);

戻り値

ヒープサイズを返します。

使用例

SFXHeap<SInt16> heap;

// ヒープのサイズを設定する
if (heap.Resize(sizeof(SInt16) * 128) == SFERR_NO_ERROR) {
    TRACE("size = %d", heap.GetSize());  // size = 256
}

参照

SFXHeap::Resize

SFXHeap::Protect

指定したヒープを安全に割り当てます。( SFXHeap オブジェクトが指定したヒープと共通部分を持つ場合は、指定したヒープの内容を別の場所に移動して割り当てます )

[ public, const ]
VoidConstPtr Protect(
    VoidConstPtr heap   // ヒープへのポインタ
    UInt32 size         // ヒープのサイズ
);

戻り値

割り当てたヒープへのポインタを返します。

解説

SFXHeap オブジェクトのヒープと指定したヒープとの間に共通部分がある場合、新たなヒープを確保し指定したヒープの内容を移動します。共通部分がない場合は、指定したヒープをそのまま割り当てます。

SFXHeap::Protect 関数で割り当てたヒープを解放するには、Unprotect 関数を使います。

使用例

SFXHeap<SInt16> heap1;
SFXHeap<SInt16> heap2;
VoidConstPtr protect;

heap1.Resize(sizeof(UInt32) * 128);  // ヒープのサイズを 512 バイトに設定する
heap2.Resize(sizeof(UInt32) * 128);  // ヒープのサイズを 512 バイトに設定する

// 自分自身と演算するときに競合しないように値を保存する
VoidConstPtr sa(heap2.GetHeap());
UInt32 ss(heap2.GetSize());
UInt32 ds(heap1.GetSize());

TRACE("addr = 0x%08X", heap1.GetHeap());      // addr = 0x06871C84 

// 別のヒープを割り当てる
if ((protect = heap1.Protect(sa, ss)) != null) {
    TRACE("addr = 0x%08X", protect);          // addr = 0x06871EB8
    // ヒープを解放する
    heap1.Unprotect(protect, sa);
}

参照

SFXHeap::Attach | SFXHeap::Contains

SFXHeap::Resize

ヒープのサイズを設定します。

[ public ]
SFCError Resize(
    UInt32 size   // 新しいヒープサイズ(バイト単位)
);

戻り値

成功したとき : SFERR_NO_ERROR
メモリ不足のとき : SFERR_NO_MEMORY

使用例

SFXHeap<SInt16> heap;

heap.Resize(sizeof(UInt32) * 128);  // ヒープのサイズを 512 バイトに設定する

SFXHeap::Unprotect

SFXHeap::Protect 関数で割り当てたヒープを解放します。

[ public, const ]
Void Unprotect(
    VoidConstPtr protect   //  が返したポインタ
    VoidConstPtr heap      //  の割り当てたヒープへのポインタ
);

解説

SFXHeap::Protect 関数で設定したヒープを解放します。

使用例

SFXHeap<SInt16> heap1;
SFXHeap<SInt16> heap2;
VoidConstPtr protect;

heap1.Resize(sizeof(UInt32) * 128);  // ヒープのサイズを 512 バイトに設定する
heap2.Resize(sizeof(UInt32) * 128);  // ヒープのサイズを 512 バイトに設定する

// 自分自身と演算するときに競合しないように値を保存する
VoidConstPtr sa(heap2.GetHeap());
UInt32 ss(heap2.GetSize());
UInt32 ds(heap1.GetSize());

TRACE("addr = 0x%08X", heap1.GetHeap());      // addr = 0x06871C84 

// 別のヒープを割り当てる
if ((protect = heap1.Protect(sa, ss)) != null) {
    TRACE("addr = 0x%08X", protect);          // addr = 0x06871EB8
   
    heap1.Unprotect(protect, sa);      // ヒープを解放する
                                       // Unprotect の第 2 引数は Protect の第 1 引数と同じ値にする
}

参照

SFXHeap::Protect

SFXHeap::operator T *

T * 型に変換します。

[ public, const ]
operator T *(Void);

戻り値

ヒープが割り当てられている場合はそのヒープへのポインタを、割り当てられていない場合は空ポインタを返します。

operator==

== の関係を判定します。

[ public, friend ]
Bool operator==(
    SFXHeap< T > const & left    // 比較する SFXHeap 型オブジェクト
    SFXHeap< M > const & right   // 比較する SFXHeap 型オブジェクト
);

[ public, friend ]
Bool operator==(
    SFXHeap< T > const & left   // 比較する SFXHeap 型オブジェクト
    VoidConstPtr right          // 比較するヒープへのポインタ
);

[ public, friend ]
Bool operator==(
    VoidConstPtr left            // 比較するヒープへのポインタ
    SFXHeap< T > const & right   // 比較する SFXHeap 型オブジェクト
);

戻り値

先頭アドレスが等しいとき : true
異なるとき : false

解説

ヒープの先頭アドレスを比較します。

operator>=

>= の関係を判定します。

[ public, friend ]
Bool operator>=(
    SFXHeap< T > const & left    // 比較する SFXHeap 型オブジェクト
    SFXHeap< M > const & right   // 比較する SFXHeap 型オブジェクト
);

[ public, friend ]
Bool operator>=(
    SFXHeap< T > const & left   // 比較する SFXHeap 型オブジェクト
    VoidConstPtr right          // 比較するヒープへのポインタ
);

[ public, friend ]
Bool operator>=(
    VoidConstPtr left            // 比較するヒープへのポインタ
    SFXHeap< T > const & right   // 比較する SFXHeap 型オブジェクト
);

戻り値

left のアドレスが right 以上のとき : true
それ以外のとき : false

解説

ヒープの先頭アドレスを比較します。

operator>

> の関係を判定します。

[ public, friend ]
Bool operator>(
    SFXHeap< T > const & left    // 比較する SFXHeap 型のオブジェクト
    SFXHeap< M > const & right   // 比較する SFXHeap 型のオブジェクト
);

[ public, friend ]
Bool operator>(
    SFXHeap< T > const & left   // 比較する SFXHeap 型のオブジェクト
    VoidConstPtr right          // 比較するヒープへのポインタ
);

[ public, friend ]
Bool operator>(
    VoidConstPtr left            // 比較するヒープへのポインタ
    SFXHeap< T > const & right   // 比較する SFXHeap 型のオブジェクト
);

戻り値

left のアドレスが大きいとき : true
それ以外のとき : false

解説

ヒープの先頭アドレスを比較します。

operator<=

<= の関係を判定します。

[ public, friend ]
Bool operator<=(
    SFXHeap< T > const & left    // 比較する SFXHeap 型オブジェクト
    SFXHeap< M > const & right   // 比較する SFXHeap 型オブジェクト
);

[ public, friend ]
Bool operator<=(
    SFXHeap< T > const & left   // 比較する SFXHeap 型オブジェクト
    VoidConstPtr right          // 比較するヒープへのポインタ
);

[ public, friend ]
Bool operator<=(
    VoidConstPtr left            // 比較するヒープへのポインタ
    SFXHeap< T > const & right   // 比較する SFXHeap 型オブジェクト
);

戻り値

left のアドレスが right 以下のとき : true
それ以外のとき : false

解説

ヒープの先頭アドレスを比較します。

operator<

< の関係を判定します。

[ public, friend ]
Bool operator<(
    SFXHeap< T > const & left    // 比較する SFXHeap 型オブジェクト
    SFXHeap< M > const & right   // 比較する SFXHeap 型オブジェクト
);

[ public, friend ]
Bool operator<(
    SFXHeap< T > const & left   // 比較する SFXHeap 型オブジェクト
    VoidConstPtr right          // 比較するヒープへのポインタ
);

[ public, friend ]
Bool operator<(
    VoidConstPtr left            // 比較するヒープへのポインタ
    SFXHeap< T > const & right   // 比較する SFXHeap 型オブジェクト
);

戻り値

left のアドレスが小さいとき : true
それ以外のとき : false

解説

ヒープの先頭アドレスを比較します。

operator!=

!= の関係を判定します。

[ public, friend ]
Bool operator!=(
    SFXHeap< T > const & left    // 比較する SFXHeap 型オブジェクト
    SFXHeap< M > const & right   // 比較する SFXHeap 型オブジェクト
);

[ public, friend ]
Bool operator!=(
    SFXHeap< T > const & left   // 比較する SFXHeap 型オブジェクト
    VoidConstPtr right          // 比較するヒープへのポインタ 
);

[ public, friend ]
Bool operator!=(
    VoidConstPtr left            // 比較するヒープへのポインタ
    SFXHeap< T > const & right   // 比較する SFXHeap 型オブジェクト
);

戻り値

先頭アドレスが異なるとき : true
等しいとき : false

解説

ヒープの先頭アドレスを比較します。