SFXList

双方向リンクリストを表すクラスです。

#include <SFXList.h.hpp>

class SFXList;

SFMTYPEDEFCLASS(SFXList)

継承図

協調図

解説

SFXList クラスは、双方向リストとして複数の要素を操作するためのデータ構造です。要素単位でメモリの確保と解放が行われます。

SFXList と SFXArray

	SFXList と SFXArray
`SFXList` クラスでは、要素の挿入と削除は、前後の要素と当該要素のポインタの付け替え操作だけです。一方、`SFXArray` クラスでは、要素の挿入や削除は当該要素以降の要素を内部バッファメモリ内で移動する必要があります。そのため、要素の挿入や削除は `SFXArray` クラスよりも高速に行えます。 `SFXList` クラスでは、要素の参照はリンクを辿る必要があります。一方、`SFXArray` クラスでは、インデックスを使用してダイレクトにアクセスできます。そのため、要素の参照は `SFXArray` クラスよりも低速に行われます。

SFXList クラスでは、要素の挿入と削除は、前後の要素と当該要素のポインタの付け替え操作だけです。一方、SFXArray クラスでは、要素の挿入や削除は当該要素以降の要素を内部バッファメモリ内で移動する必要があります。そのため、要素の挿入や削除は SFXArray クラスよりも高速に行えます。

SFXList クラスでは、要素の参照はリンクを辿る必要があります。一方、SFXArray クラスでは、インデックスを使用してダイレクトにアクセスできます。そのため、要素の参照は SFXArray クラスよりも低速に行われます。

SFXList の要素は 4 バイト以下のデータでなければいけません。 5 バイト以上の UInt64 型データや Float64 型データ、クラスのインスタンスを双方向リンクリストの要素として処理するにはポインタを使います。

// 5 バイト以上のデータやクラスインスタンスは、双方向リンクリストの要素に格納できない
// SFXList<SInt64> ar64;           NG
// SFXList<SFXAnsiString> arstr;   NG

// ポインタは双方向リンクリストの要素に格納できる
// 5 バイト以上のデータを双方向リンクリストの要素にしたい場合は、ポインタを利用する
SFXList<SInt64Ptr> ar64;        // OK
SFXList<SFXAnsiStringPtr> arstr;// OK

参照

SFXArray | SFXStack | リスト

メンバ

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

パブリック関数
`SFCError`	Append( `SFXList< V > const &` collection ) [廃止予定] 要素を追加します。
`SFCError`	Append( `V` value ) [廃止予定] 要素を追加します。
`Void`	Clear( `Void` ) リストを空にします。
`Bool`	Contains( `V` value ) 指定された値と同じ要素が含まれるか判定します。
static `SFXList< V > const &`	EmptyInstance( `Void` ) 空のリストを取得します。
`Bool`	Equals( `SFXList< V > const &` collection ) 指定されたリストと等しいか判定します。
`SInt32`	FirstIndexOf( `V` value , `SInt32` index = SINT32_MINIMUM ) 先頭から検索して、指定された値と一致する最初の要素のインデックスを取得します。
`V`	Get( `SInt32` index ) 指定された位置にある要素を取得します。
`Enumerator`	GetEnumerator( `SInt32` index ) 列挙子を取得します。
`V`	GetFirst( `Void` ) 先頭の要素を取得します。
`Enumerator`	GetFirstEnumerator( `Void` ) 最初の要素に対応する列挙子を取得します。
`Iterator`	GetFirstIterator( `Void` ) 最初の要素に対応する反復子を取得します。
`Iterator`	GetIterator( `SInt32` index ) 反復子を取得します。
`V`	GetLast( `Void` ) 最後の要素を取得します。
`Enumerator`	GetLastEnumerator( `Void` ) 最後の要素に対応する列挙子を取得します。
`Iterator`	GetLastIterator( `Void` ) 最後の要素に対応する反復子を取得します。
`SInt32`	GetSize( `Void` ) リストのサイズを取得します。
`SFCError`	Insert( `SInt32` index , `SFXList< V > const &` collection ) 要素またはリストを挿入します。
`SFCError`	Insert( `SInt32` index , `V` value ) 要素またはリストを挿入します。
`SFCError`	InsertFirst( `SFXList< V > const &` collection ) 先頭に要素またはリストを挿入します。
`SFCError`	InsertFirst( `V` value ) 先頭に要素またはリストを挿入します。
`SFCError`	InsertLast( `SFXList< V > const &` collection ) 末尾に要素またはリストを挿入します。
`SFCError`	InsertLast( `V` value ) 末尾に要素またはリストを挿入します。
`Bool`	IsEmpty( `Void` ) リストが空であるか判定します。
`SInt32`	LastIndexOf( `V` value , `SInt32` index = SINT32_MAXIMUM ) 末尾から検索して、指定された値と一致する最後の要素のインデックスを取得します。
`SFCError`	Move( `SInt32` destination , `SInt32` source ) 要素を移動します。
`SFCError`	MoveFirst( `SInt32` source ) 要素を最初に移動します。
`SFCError`	MoveLast( `SInt32` source ) 要素を最後に移動します。
`Void`	Remove( `SInt32` index ) 指定されたインデックスの位置または範囲の要素を削除します。
`Void`	Remove( `SInt32` begin , `SInt32` end ) 指定されたインデックスの位置または範囲の要素を削除します。
`Void`	RemoveFirst( `Void` ) 先頭の要素を削除します。
`Void`	RemoveLast( `Void` ) 末尾の要素を削除します。
`SFCError`	Set( `SFXList< V > const &` collection ) 要素に値を設定します。またはリストを設定します。
`SFCError`	Set( `SInt32` index , `V` value ) 要素に値を設定します。またはリストを設定します。
`SFCError`	SetFirst( `V` value ) 先頭の要素に指定された値を設定します。
`SFCError`	SetLast( `V` value ) 末尾の要素に指定された値を設定します。
`SFCError`	Swap( `SInt32` destination , `SInt32` source ) 指定された 2 つの要素を交換します。
`SFCError`	SwapFirst( `SInt32` source ) 指定された要素と先頭の要素を交換します。
`SFCError`	SwapLast( `SInt32` source ) 指定された要素と末尾の要素を交換します。

型
Enumerator 列挙子を保持するクラスです。
Iterator 反復子を保持するクラスです。

SFXList::SFXList

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

[ public, explicit ]
SFXList(Void);

SFXList::Append

[廃止予定] 要素を追加します。

[ public ]
SFCError Append(
    SFXList< V > const & collection   // 追加するリスト
);

[ public ]
SFCError Append(
    V value   // 追加する要素
);

戻り値

成功したとき: SFERR_NO_ERROR
メモリ不足のとき: SFERR_NO_MEMOERY
失敗したとき: SFERR_FAILED

解説

リストの最後に要素を追加します。この関数は非推奨関数です。替わりに SFXList::InsertLast 関数を使用してください。

	廃止予定
	この関数は、SophiaFramework UNIVERSE 6.0 で廃止される予定です。この関数の代わりに `SFXList::InsertLast` 関数を利用することを推奨します。

使用例

SFXList<SInt32> list;
SInt16 i;

// 要素を追加する
if (list.Append(2) == SFERR_NO_ERROR) {
    // 要素を追加する
    if (list.Append(5) == SFERR_NO_ERROR) {
        // インデックスを元にデータを列挙する
        for (i = 0; i < list.GetSize(); ++i) {
            TRACE("%d", list.Get(i));  // 2 5 
        }
    }
}

参照

SFXList::Insert | SFXList::InsertLast | SFXList::Get | SFXList::Remove | SFXList::Set

SFXList::Clear

リストを空にします。

[ public ]
Void Clear(Void);

解説

この関数は、リストを空にします。リストの各要素に割り当てられていたメモリ領域はすべて解放されます。

この関数を実行した後、リストのサイズは 0 になります。

	注意
要素がクラスインスタンスや 4 バイトよりも大きなデータへのポインタの場合、ポインタが指すメモリ領域は解放されません。リストをクリアする前に、 delete 文を使用して明示的にその領域を解放する必要があります。さもなければ、メモリリークが発生します。

注意

要素がクラスインスタンスや 4 バイトよりも大きなデータへのポインタの場合、ポインタが指すメモリ領域は解放されません。

リストをクリアする前に、 delete 文を使用して明示的にその領域を解放する必要があります。さもなければ、メモリリークが発生します。

	注意
	この関数は、このリストがスコープから外れるタイミングで自動的に呼び出されます。

使用例

SFXList<SInt32> list;
    
...
     
list.Clear();    // リストを空にする

参照

SFXList::Remove | SFXList::GetSize

SFXList::Contains

指定された値と同じ要素が含まれるか判定します。

[ public, const ]
Bool Contains(
    V value   // 含まれるか調べる値
);

戻り値

含まれるとき: true
含まれないとき: false

解説

この関数は、このリストに指定された値と同じ要素が含まれるか判定します。

	注意
	要素がポインタの場合、アドレスを比較します。

使用例

SFXList<SInt32> list;

// 要素を追加する
if (list.InsertLast(2) == SFERR_NO_ERROR) {

    // 要素を追加する
    if (list.InsertLast(5) == SFERR_NO_ERROR) {

        // 指定した値と同じ要素が含まれるか判定する
        TRACE("Contains(2) = %s", (list.Contains(2)) ? ("true") : ("false"));  // Contains(2) = true
        TRACE("Contains(4) = %s", (list.Contains(4)) ? ("true") : ("false"));  // Contains(4) = false
    }
}

参照

SFXList::FirstIndexOf | SFXList::LastIndexOf

SFXList::EmptyInstance

空のリストを取得します。

[ public, static ]
SFXList< V > const & EmptyInstance(Void);

解説

空のリストを表すインスタンスを取得します。

SFXList::Equals

指定されたリストと等しいか判定します。

[ public, const ]
Bool Equals(
    SFXList< V > const & collection   // 比較するリスト
);

戻り値

等しいとき: true
異なるとき: false

解説

この関数は、このリストが指定されたリストと等しいか（同じ要素が同じ順で格納されているか）を判定します。

	注意
	要素がポインタの場合、アドレスを比較します。

SFXList::FirstIndexOf

先頭から検索して、指定された値と一致する最初の要素のインデックスを取得します。

[ public, const ]
SInt32 FirstIndexOf(
    V value                         // 検索する値
    SInt32 index = SINT32_MINIMUM   // 検索開始位置
);

戻り値

成功したとき: 見つかった位置のインデックス
失敗したとき: -1

解説

この関数は、先頭から検索して、指定された値と一致する最初の要素のインデックスを取得します。

開始位置を指定することで、先頭以外の任意の位置から検索できます（先頭のインデックスは 0 です）。

	注意
	要素がポインタである場合、アドレスを比較します。

使用例

SFXList<SInt32> list;

// 要素を追加する
if (list.InsertLast(2) == SFERR_NO_ERROR) {

    // 要素を追加する
    if (list.InsertLast(5) == SFERR_NO_ERROR) {

        // 先頭から検索して、指定した値と一致する最初の要素のインデックスを取得する
        TRACE("FirstIndexOf(1) = %d", list.FirstIndexOf(1));  // FirstIndexOf(1) = -1
        TRACE("FirstIndexOf(2) = %d", list.FirstIndexOf(2));  // FirstIndexOf(2) = 0
        TRACE("FirstIndexOf(5) = %d", list.FirstIndexOf(5));  // FirstIndexOf(5) = 1
    }
}

参照

SFXList::Contains | SFXList::LastIndexOf

SFXList::Get

指定された位置にある要素を取得します。

[ public, const ]
V Get(
    SInt32 index   // 取得する要素の位置
);

戻り値

指定された位置にある要素。要素が存在しない場合は、0 または null。

解説

この関数は、指定された位置にある要素を取得します。

	注意
	指定された位置に要素が存在しない場合、エラーは発生せず、この関数は 0 または null を返します。

参照

SFXList::GetFirst | SFXList::GetLast | SFXList::Insert | SFXList::Remove | SFXList::Set

SFXList::GetEnumerator

列挙子を取得します。

[ public, const ]
Enumerator GetEnumerator(
    SInt32 index   // 開始位置
);

戻り値

指定された要素に対応する列挙子

解説

この関数は、このリストの指定された要素に対応する列挙子を取得します。

注意

	注意
引数に 0 以下の値を指定した場合、この関数は `SFXList::GetFirstEnumerator` 関数と同等です。引数にこのリストのサイズ以上の値を指定した場合、この関数は `SFXList::GetLastEnumerator` 関数と同等です。

引数に 0 以下の値を指定した場合、この関数は SFXList::GetFirstEnumerator 関数と同等です。

引数にこのリストのサイズ以上の値を指定した場合、この関数は SFXList::GetLastEnumerator 関数と同等です。

参照

SFXList::GetFirstEnumerator | SFXList::GetLastEnumerator | SFXList::GetIterator | SFXList::Enumerator

SFXList::GetFirst

先頭の要素を取得します。

[ public, const ]
V GetFirst(Void);

戻り値

最初の位置にある要素。要素が存在しない場合は、0 または null。

解説

この関数は、先頭の要素を取得します。

	注意
	要素が存在しない場合、エラーは発生せず、この関数は 0 または null を返します。

参照

SFXList::Get | SFXList::GetLast | SFXList::InsertFirst | SFXList::RemoveFirst

SFXList::GetFirstEnumerator

最初の要素に対応する列挙子を取得します。

[ public, const ]
Enumerator GetFirstEnumerator(Void);

戻り値

最初の要素に対応する列挙子。

解説

この関数は、このリストの最初の要素に対応する列挙子を取得します。

使用例

SFXList<SInt32> list;
SFXList<SInt32>::Enumerator en;

// 要素を追加する
if (list.InsertLast(2) == SFERR_NO_ERROR) {
    // 要素を追加する
    if (list.InsertLast(5) == SFERR_NO_ERROR) {
        
        // 最初の要素に対応する列挙子を取得する
        en = list.GetFirstEnumerator();
        
        // 次の要素があるか判定する
        while(en.HasNext()) {
            TRACE("%d", en.GetNext());  // 2 5 
        }
    }
}

参照

SFXList::GetEnumerator | SFXList::GetFirstIterator | SFXList::Enumerator

SFXList::GetFirstIterator

最初の要素に対応する反復子を取得します。

[ public ]
Iterator GetFirstIterator(Void);

戻り値

最初の要素に対応する反復子。

解説

この関数は、このリストの最初の要素に対応する反復子を取得します。

使用例

SFXList<SInt32> list;
SFXList<SInt32>::Iterator it;

// 要素を追加する
if (list.InsertLast(2) == SFERR_NO_ERROR) {
    // 要素を追加する
    if (list.InsertLast(5) == SFERR_NO_ERROR) {
        
        // 最初の要素に対応する反復子を取得する
        it = list.GetFirstIterator();
        
        // 次の要素があるか判定する
        while(it.HasNext()) {
            TRACE("%d", it.GetNext());  // 2 5 
        }
    }
}

参照

SFXList::GetIterator | SFXList::GetFirstEnumerator | SFXList::Iterator

SFXList::GetIterator

反復子を取得します。

[ public ]
Iterator GetIterator(
    SInt32 index   // 開始位置
);

戻り値

指定された要素に対応する反復子

解説

この関数は、このリストの指定された要素に対応する反復子を取得します。

注意

	注意
引数に 0 以下の値を指定した場合、この関数は `SFXList::GetFirstIterator` 関数と同等です。引数にこのリストのサイズ以上の値を指定した場合、この関数は `SFXList::GetLastIterator` 関数と同等です。

引数に 0 以下の値を指定した場合、この関数は SFXList::GetFirstIterator 関数と同等です。

引数にこのリストのサイズ以上の値を指定した場合、この関数は SFXList::GetLastIterator 関数と同等です。

参照

SFXList::GetFirstIterator | SFXList::GetLastIterator | SFXList::GetEnumerator | SFXList::Iterator

SFXList::GetLast

最後の要素を取得します。

[ public, const ]
V GetLast(Void);

戻り値

最後の位置にある要素。要素が存在しない場合は、0 または null。

解説

この関数は、最後の位置にある要素を取得します。

	注意
	要素が存在しない場合、エラーは発生せず、この関数は 0 または null を返します。

参照

SFXList::Get | SFXList::GetFirst | SFXList::InsertLast | SFXList::RemoveLast

SFXList::GetLastEnumerator

最後の要素に対応する列挙子を取得します。

[ public, const ]
Enumerator GetLastEnumerator(Void);

戻り値

最後の要素に対応する列挙子。

解説

この関数は、このリストの最後の要素に対応する列挙子を取得します。

参照

SFXList::GetEnumerator | SFXList::GetLastIterator | SFXList::Enumerator

SFXList::GetLastIterator

最後の要素に対応する反復子を取得します。

[ public ]
Iterator GetLastIterator(Void);

戻り値

最後の要素に対応する列挙子。

解説

この関数は、このリストの最後の要素に対応する反復子を取得します。

参照

SFXList::GetIterator | SFXList::GetLastEnumerator | SFXList::Iterator

SFXList::GetSize

リストのサイズを取得します。

[ public, const ]
SInt32 GetSize(Void);

戻り値

このリストのサイズ(要素数)

解説

この関数は、このリストのサイズ(要素数)を取得します。

使用例

SFXList<SInt32> list;
SInt16 i;

// 要素を追加する
if (list.InsertLast(2) == SFERR_NO_ERROR) {
    // 要素を追加する
    if (list.InsertLast(5) == SFERR_NO_ERROR) {
        // サイズ(要素数)を表示する
        TRACE("%d", list.GetSize());  // 2
    }
}

SFXList::Insert

要素またはリストを挿入します。

[ public ]
SFCError Insert(
    SInt32 index                      // 挿入する位置
    SFXList< V > const & collection   // 挿入するリスト
);

[ public ]
SFCError Insert(
    SInt32 index   // 挿入する位置
    V value        // 挿入する要素の値
);

戻り値

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

解説

この関数は、指定されたインデックスの位置に指定した値の要素または指定したリストを挿入します。

インデックスが 0 以下の場合は最初に挿入されます。

インデックスが要素数以上の場合は最後に挿入されます。

使用例

SFXList<SInt32> list;
SInt16 i;

// 要素を追加する
if (list.InsertLast(2) == SFERR_NO_ERROR) {

    // 要素を追加する
    if (list.InsertLast(5) == SFERR_NO_ERROR) {

        // 最初の位置に要素を挿入する
        if (list.Insert(0, 3) == SFERR_NO_ERROR) {

            // 要素を挿入する
            // 指定したインデックスが有効でない場合、要素は有効な位置に挿入される
            if (list.Insert(10, 4) == SFERR_NO_ERROR) {

                // インデックスを元に要素を列挙する
                for (i = 0; i < list.GetSize(); ++i) {

                    TRACE("%d", list.Get(i));  // 3 2 5 4
               }
           }
       }
    }
}

参照

SFXList::InsertFirst | SFXList::InsertLast | SFXList::Set | SFXList::Get | SFXList::Remove

SFXList::InsertFirst

先頭に要素またはリストを挿入します。

[ public ]
SFCError InsertFirst(
    SFXList< V > const & collection   // 挿入するリスト
);

[ public ]
SFCError InsertFirst(
    V value   // 挿入する要素の値
);

戻り値

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

解説

この関数は、先頭に指定された要素またはリストを挿入します。

参照

SFXList::Insert | SFXList::InsertLast | SFXList::RemoveFirst | SFXList::GetFirst

SFXList::InsertLast

末尾に要素またはリストを挿入します。

[ public ]
SFCError InsertLast(
    SFXList< V > const & collection   // 挿入するリスト
);

[ public ]
SFCError InsertLast(
    V value   // 挿入する要素の値
);

戻り値

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

解説

この関数は、末尾に指定された要素またはリストを挿入します。

参照

SFXList::Insert | SFXList::InsertFirst | SFXList::GetLast | SFXList::RemoveLast

SFXList::IsEmpty

リストが空であるか判定します。

[ public, const ]
Bool IsEmpty(Void);

戻り値

空のとき: true
空でないとき: false

解説

この関数は、このリストが空であるか判定します。

SFXList::LastIndexOf

末尾から検索して、指定された値と一致する最後の要素のインデックスを取得します。

[ public, const ]
SInt32 LastIndexOf(
    V value                         // 検索する値
    SInt32 index = SINT32_MAXIMUM   // 検索開始位置
);

戻り値

成功したとき: 見つかった位置のインデックス
失敗したとき: -1

解説

この関数は、末尾から検索して、指定された値と一致する最後の要素のインデックスを取得します。

開始位置を指定することで、末尾以外の任意の位置から検索できます（先頭のインデックスは 0 です）。

	注意
	要素がポインタである場合、アドレスを比較します。

使用例

SFXList<SInt32> list;

// 要素を追加する
if (list.InsertLast(2) == SFERR_NO_ERROR) {

    // 要素を追加する
    if (list.InsertLast(5) == SFERR_NO_ERROR) {

        // 末尾から検索して、指定した値と一致する最後の要素のインデックスを取得する
        TRACE("LastIndexOf(1) = %d", list.LastIndexOf(1));  // LastIndexOf(1) = -1
        TRACE("LastIndexOf(2) = %d", list.LastIndexOf(2));  // LastIndexOf(2) = 0
        TRACE("LastIndexOf(5) = %d", list.LastIndexOf(5));  // LastIndexOf(5) = 1
    }
}

参照

SFXList::Contains | SFXList::FirstIndexOf

SFXList::Move

要素を移動します。

[ public ]
SFCError Move(
    SInt32 destination   // 移動先の位置
    SInt32 source        // 移動元の位置
);

戻り値

成功したとき: SFERR_NO_ERROR
指定した位置に要素が存在しないとき: SFERR_INVALID_PARAM

解説

この関数は、指定された位置にある要素を指定した位置に移動します。

参照

SFXList::MoveFirst | SFXList::MoveLast

SFXList::MoveFirst

要素を最初に移動します。

[ public ]
SFCError MoveFirst(
    SInt32 source   // 移動元の位置
);

戻り値

成功したとき: SFERR_NO_ERROR
リストが空のとき: SFERR_INVALID_STATE
指定した位置に要素が存在しないとき: SFERR_INVALID_PARAM

解説

この関数は、指定された位置にある要素を最初に移動します。

参照

SFXList::Move | SFXList::MoveLast

SFXList::MoveLast

要素を最後に移動します。

[ public ]
SFCError MoveLast(
    SInt32 source   // 移動元の位置
);

戻り値

成功したとき: SFERR_NO_ERROR
リストが空のとき: SFERR_INVALID_STATE
指定した位置に要素が存在しないとき: SFERR_INVALID_PARAM

解説

この関数は、指定された位置にある要素を最後に移動します。

参照

SFXList::Move | SFXList::MoveFirst

SFXList::Remove

指定されたインデックスの位置または範囲の要素を削除します。

[ public ]
Void Remove(
    SInt32 index   // 削除する要素の位置
);

[ public ]
Void Remove(
    SInt32 begin   // 削除開始位置（この位置を含む）
    SInt32 end     // 削除終了位置（この位置を含まない）
);

解説

この関数は、指定されたインデックスの位置または範囲にある要素を削除します。

削除する要素の位置が 0 より小さい場合、または要素数以上の場合、要素の削除は行われません。

削除開始位置が要素数以上の場合、または削除終了位置が 0 以下の場合、要素の削除は行われません。

削除開始位置が 0 より小さい場合、削除開始位置は 0 に再設定されます。

削除終了位置が要素数より大きい場合、削除終了位置は要素数に再設定されます。

	注意
	指定した要素が存在しない場合、エラーは発生せず、何も起こりません。

使用例

SFXList<SInt16> list;
SInt16 i;

// 要素を追加する
if (list.InsertLast(2) == SFERR_NO_ERROR) {

    // 要素を追加する
    if (list.InsertLast(5) == SFERR_NO_ERROR) {

        // 最初の位置に要素を挿入する
        if (list.Insert(0, 3) == SFERR_NO_ERROR) {

            // 要素を挿入する
            // 指定したインデックスが有効でない場合、要素は有効な位置に挿入される
            if (list.Insert(10, 4) == SFERR_NO_ERROR) {

                // 2 番目から 3 番目までの要素を削除する
                list.Remove(1, 3);

                // インデックスを元に要素を列挙する
                for (i = 0; i < list.GetSize(); ++i) {

                    TRACE("%d", list.Get(i));  // 3 4
               }
           }
       }
    }
}

参照

SFXList::RemoveFirst | SFXList::RemoveLast | SFXList::Insert | SFXList::Get | SFXList::Set

SFXList::RemoveFirst

先頭の要素を削除します。

[ public ]
Void RemoveFirst(Void);

解説

この関数は、先頭の要素を削除します。

	注意
	このリストに要素が存在しない場合、エラーは発生せず、何も起こりません。

参照

SFXList::Remove | SFXList::RemoveLast | SFXList::GetFirst | SFXList::InsertFirst

SFXList::RemoveLast

末尾の要素を削除します。

[ public ]
Void RemoveLast(Void);

解説

この関数は、末尾の要素を削除します。

	注意
	このリストに要素が存在しない場合、エラーは発生せず、何も起こりません。

参照

SFXList::Remove | SFXList::RemoveFirst | SFXList::InsertLast | SFXList::GetLast

SFXList::Set

要素に値を設定します。またはリストを設定します。

[ public ]
SFCError Set(
    SFXList< V > const & collection   // 設定するリスト
);

[ public ]
SFCError Set(
    SInt32 index   // 設定する位置
    V value        // 設定する値
);

戻り値

成功したとき: SFERR_NO_ERROR
メモリ不足のとき: SFERR_NO_MEMOERY
指定した位置に要素が存在しないとき: SFERR_INVALID_PARAM

解説

この関数は、指定された位置にある要素の値を設定します。またはこのリストを指定されたリストに設定します。

※処理中にエラーが発生した場合は、元の状態に戻します。

使用例

SFXList<SInt32> list;
SInt16 i;

// 要素を追加する
if (list.InsertLast(2) == SFERR_NO_ERROR) {

    // 要素を追加する
    if (list.InsertLast(5) == SFERR_NO_ERROR) {

        // 要素の値を設定する
        if (list.Set(1, 10) == SFERR_NO_ERROR) {

            // インデックスを元に要素を列挙する
            for (i = 0; i < list.GetSize(); ++i) {

                TRACE("%d", list.Get(i));  // 2 10
           }
       }
    }
}

参照

SFXList::Get | SFXList::SetFirst | SFXList::SetLast | SFXList::Insert | SFXList::Remove

SFXList::SetFirst

先頭の要素に指定された値を設定します。

[ public ]
SFCError SetFirst(
    V value   // 設定する値
);

戻り値

成功したとき: SFERR_NO_ERROR
リストが空のとき: SFERR_INVALID_STATE

解説

この関数は、先頭の要素に指定された値を設定します。

※処理中にエラーが発生した場合は、元の状態に戻します。

参照

SFXList::GetFirst | SFXList::Set | SFXList::SetLast

SFXList::SetLast

末尾の要素に指定された値を設定します。

[ public ]
SFCError SetLast(
    V value   // 設定する値
);

戻り値

成功したとき: SFERR_NO_ERROR
リストが空のとき: SFERR_INVALID_STATE

解説

この関数は、末尾の要素に指定された値を設定します。

※処理中にエラーが発生した場合は、元の状態に戻します。

参照

SFXList::GetLast | SFXList::Set | SFXList::SetFirst

SFXList::Swap

指定された 2 つの要素を交換します。

[ public ]
SFCError Swap(
    SInt32 destination   // 交換先の位置
    SInt32 source        // 交換元の位置
);

戻り値

成功したとき: SFERR_NO_ERROR
指定された位置に要素が存在しないとき: SFERR_INVALID_PARAM

解説

この関数は、指定された 2 つの要素を交換します。

参照

SFXList::SwapFirst | SFXList::SwapLast

SFXList::SwapFirst

指定された要素と先頭の要素を交換します。

[ public ]
SFCError SwapFirst(
    SInt32 source   // 交換元の位置
);

戻り値

成功したとき: SFERR_NO_ERROR
リストが空のとき: SFERR_INVALID_STATE
指定された位置に要素が存在しないとき: SFERR_INVALID_PARAM

解説

この関数は、指定された要素と先頭の要素を交換します。

参照

SFXList::Swap | SFXList::SwapLast

SFXList::SwapLast

指定された要素と末尾の要素を交換します。

[ public ]
SFCError SwapLast(
    SInt32 source   // 交換元の位置
);

戻り値

成功したとき: SFERR_NO_ERROR
リストが空のとき: SFERR_INVALID_STATE
指定された位置に要素が存在しないとき: SFERR_INVALID_PARAM

解説

この関数は、指定された要素と末尾の要素を交換します。

参照

SFXList::Swap | SFXList::SwapFirst

SFXList::Enumerator

列挙子を保持するクラスです。

[ public ]

SFMTYPEDEFCLASS(Enumerator)
friend class Enumerator;
class Enumerator {
    public:
        explicit            Enumerator          (Void) : Enumeratoa();
                            Enumerator          (IteratorConstRef iterator) : Enumeratoa(iterator);
        EnumeratorRef       operator=           (IteratorConstRef iterator);
        V                   GetNext             (Void);
        V                   GetPrevious         (Void);
        Bool                HasNext             (Void) const;
        Bool                HasPrevious         (Void) const;
        Bool                IsValid             (Void) const;
};

解説

このクラスは、列挙子を保持するクラスです。

このクラスは、以下のメンバ関数を持ちます。

GetNext	次の要素を取得します。要素がない場合 null または 0 を返します。
GetPrevious	前の要素を取得します。要素がない場合 null または 0 を返します。
HasNext	次の要素があるか調べます。
HasPrevious	前の要素があるか調べます。
IsValid	列挙子が有効であるか判定します。

使用例

SFXList<SInt32> list;
SFXList<SInt32>::Enumerator en;

// 要素を追加する
if (list.InsertLast(2) == SFERR_NO_ERROR) {

    // 要素を追加する
    if (list.InsertLast(5) == SFERR_NO_ERROR) {
        
        // リストの最初の要素に対応する列挙子を取得する
        en = list.GetFirstEnumerator();
        
        // 次の要素があるか判定する
        while(en.HasNext()) {

            TRACE("%d", en.GetNext());  // 2 5 
        }
    }
}

参照

SFXList::Iterator

SFXList::Iterator

反復子を保持するクラスです。

[ public ]

SFMTYPEDEFCLASS(Iterator)
friend class Iterator;
class Iterator  {
    public:
        explicit            Iterator            (Void) : Iteratoa();
        SFCError            Set                 (V value);
        V                   GetNext             (Void);
        V                   GetPrevious         (Void);
        Bool                HasNext             (Void) const;
        Bool                HasPrevious         (Void) const;
        Bool                IsValid             (Void) const;
        SFCError            Insert              (V value);
        Void                Remove              (Void);

    friend      class               Enumerator;
};

解説

このクラスは、反復子を保持するクラスです。

このクラスは、以下のメンバ関数を持ちます。

Set	反復子が指す要素に値を設定します。
GetNext	次の要素を取得します。要素がない場合 null または 0 を返します。
GetPrevious	前の要素を取得します。要素がない場合 null または 0 を返します。
HasNext	次の要素があるか調べます。
HasPrevious	前の要素があるか調べます。
IsValid	反復子が有効であるか判定します。
Insert	反復子が指す要素の次に要素を挿入します。
Remove	反復子が指す要素を削除します。

使用例

SFXList<SInt32> list;
SFXList<SInt32>::Iterator it;

// 要素を追加する
if (list.InsertLast(2) == SFERR_NO_ERROR) {

    // 要素を追加する
    if (list.InsertLast(5) == SFERR_NO_ERROR) {
        
        // リストの最初の要素に対応する反復子を取得する
        it = list.GetFirstIterator();
        
        // 次の要素があるか判定する
        while(it.HasNext()) {

            TRACE("%d", it.GetNext());  // 2 5 
        }
    }
}

参照

SFXList::Enumerator