SFXList

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

#include <SFXList.h.hpp>

class SFXList;

SFMTYPEDEFCLASS(SFXList)

継承図

協調図

解説

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

// 5 バイト以上のデータやクラスのインスタンスは 
// 双方向リンク リスト ( SFXArray クラスのインスタンス ) の要素にできない 

// SFXList<SInt64> ar64;           NG
// SFXList<SFXAnsiString> arstr;   NG

// しかし、5 バイト以上のデータやクラスのインスタンスへのポインタは双方向リンク リストの要素にできる

SFXList<SInt64Ptr> ar64;        // OK
SFXList<SFXAnsiStringPtr> arstr;// OK

参照

SFXArray

メンバ

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

パブリック関数
`SFCError`	Append( `SFXList< V > const &` collection ) Append( `V` value ) [非推奨 API ( 廃止予定 API )] 要素を追加します。
`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 ) Insert( `SInt32` index , `V` value ) 要素を挿入します。
`SFCError`	InsertFirst( `SFXList< V > const &` collection ) InsertFirst( `V` value ) 最初に要素を挿入します。
`SFCError`	InsertLast( `SFXList< V > const &` collection ) 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 ) Remove( `SInt32` begin , `SInt32` end ) 指定した位置または範囲の要素を消去します。
`Void`	RemoveFirst( `Void` ) 最初の要素を消去します。
`Void`	RemoveLast( `Void` ) 最後の要素を消去します。
`SFCError`	Set( `SFXList< V > const &` collection ) Set( `SInt32` index , `V` value ) 要素に値を設定します。またはリストを設定します。
`SFCError`	SetFirst( `V` value ) 最初の要素に値を設定します。
`SFCError`	SetLast( `V` value ) 最後の要素に値を設定します。
`SFCError`	Swap( `SInt32` destination , `SInt32` source ) 要素を交換します。
`SFCError`	SwapFirst( `SInt32` source ) 最初の要素と交換します。
`SFCError`	SwapLast( `SInt32` source ) 最後の要素と交換します。

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

SFXList::SFXList

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

[ public, explicit ]
SFXList(Void);

SFXList::Append

[非推奨 API ( 廃止予定 API )] 要素を追加します。

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

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

戻り値

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

解説

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

	非推奨 API ( 廃止予定 API )
	この API は、SophiaFramework UNIVERSE 6.0 では廃止される予定です。この API の替わりに `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);

解説

格納されている要素がクラスのインスタンスへのポインタの場合、そのインスタンスは自動的に解放されません。

使用例

SFXList<SInt32> list;
    
...
     
list.Clear();    // すべてのデータと管理用メモリを解放する

参照

SFXList::Remove

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::EmptyInstance

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

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

解説

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

SFXList::Equals

リストが等しいか比較します。

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

戻り値

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

解説

2 つのリストに同じ要素が同じ順で格納されているか調べます。

格納されている要素がクラスのインスタンスへのポインタの場合、アドレスを比較します。

SFXList::FirstIndexOf

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

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

戻り値

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

解説

要素を先頭から末尾に向かって検索し、最初に見つかった位置のインデックスを取得します。

検索開始位置を指定することで、先頭以外の位置から検索できます。

格納されている要素がクラスのインスタンスへのポインタの場合、アドレスを比較します。

使用例

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   // 取得する要素の位置
);

参照

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

SFXList::GetEnumerator

リストの列挙子を取得します。

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

参照

SFXList::GetIterator | SFXList::Enumerator

SFXList::GetFirst

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

[ public, const ]
V GetFirst(Void);

参照

SFXList::Get | SFXList::GetLast

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::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::GetFirstEnumerator | SFXList::Iterator

SFXList::GetIterator

リストの反復子を取得します。

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

参照

SFXList::GetEnumerator | SFXList::Iterator

SFXList::GetLast

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

[ public, const ]
V GetLast(Void);

参照

SFXList::Get | SFXList::GetFirst

SFXList::GetLastEnumerator

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

[ public, const ]
Enumerator GetLastEnumerator(Void);

参照

SFXList::GetLastIterator | SFXList::Enumerator

SFXList::GetLastIterator

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

[ public ]
Iterator GetLastIterator(Void);

参照

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
失敗したとき : SFERR_FAILED

解説

指定した位置に、要素を挿入します。

挿入する位置が有効でない場合は、自動的に有効な範囲に修正されます。

使用例

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::Get | SFXList::InsertFirst | SFXList::InsertLast | SFXList::Remove | SFXList::Set

SFXList::InsertFirst

最初に要素を挿入します。

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

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

戻り値

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

参照

SFXList::Insert | SFXList::InsertLast

SFXList::InsertLast

最後に要素を挿入します。

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

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

戻り値

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

参照

SFXList::Insert | SFXList::InsertFirst

SFXList::IsEmpty

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

[ public, const ]
Bool IsEmpty(Void);

戻り値

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

SFXList::LastIndexOf

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

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

戻り値

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

解説

要素を末尾から先頭に向かって検索し、最初に見つかった位置のインデックスを取得します

検索開始位置を指定することで、末尾以外の位置から検索できます。

格納されている要素がクラスのインスタンスへのポインタの場合、アドレスを比較します。

使用例

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     // 消去終了位置
);

参照

SFXList::Insert | SFXList::Get | SFXList::Set

SFXList::RemoveFirst

最初の要素を消去します。

[ public ]
Void RemoveFirst(Void);

参照

SFXList::Remove | SFXList::RemoveLast

SFXList::RemoveLast

最後の要素を消去します。

[ public ]
Void RemoveLast(Void);

参照

SFXList::Remove | SFXList::RemoveFirst

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
失敗したとき : SFERR_INVALID_STATE

使用例

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::Insert | SFXList::Remove

SFXList::SetFirst

最初の要素に値を設定します。

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

戻り値

成功したとき : SFERR_NO_ERROR
失敗したとき : SFERR_INVALID_STATE

参照

SFXList::GetFirst

SFXList::SetLast

最後の要素に値を設定します。

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

戻り値

成功したとき : SFERR_NO_ERROR
失敗したとき : SFERR_INVALID_STATE

参照

SFXList::GetLast

SFXList::Swap

要素を交換します。

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

戻り値

成功したとき : SFERR_NO_ERROR
引数が不正なとき : SFERR_INVALID_PARAM

参照

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;
};

解説

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

以下のメンバ関数を持ちます。

GetNext	次の要素を取得します。要素がない場合 null を返します。
GetPrevious	前の要素を取得します。要素がない場合 null を返します。
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;
};

解説

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

以下のメンバ関数を持ちます。

Set	反復子が指す要素に値を設定します。
GetNext	次の要素を取得します。要素がない場合 null を返します。
GetPrevious	前の要素を取得します。要素がない場合 null を返します。
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