Inheritance diagram

Collaboration diagram

Description

Each element size of SFXList needs to be less than or equal 4 byte. In order to process data more than 4 byte ( such as UInt64 type, Float64 type, and so on ) or class instance as an element of the SFXList instance ( bidirectional linked list ), a pointer should be used.

// data more than 4 byte or class instance cannot be an element of the SFXList instance ( bidirectional linked list ) 

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


// but a pointer to the data more than 4 byte or class instance can be an element of the SFXList instance ( bidirectional linked list )

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

Reference

SFXArray

Member

Return value

Description

Append an element at the end of list. This function is deprecated, use the SFXList::InsertLast function.

Example

SFXList<SInt32> list;
SInt16 i;

// append an element
if (list.Append(2) == SFERR_NO_ERROR) {
    // append an element
    if (list.Append(5) == SFERR_NO_ERROR) {
        // enumerate by index
        for (i = 0; i < list.GetSize(); ++i) {
            TRACE("%d", list.Get(i));  // 2 5 
        }
    }
}

Reference

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

Description

This function clears this list. All the memory areas allocated to the elements of this list will be released.

After this function is executed, the size of this list will become 0.

	Caution
	If the type of the element is a pointer to a class instance or data bigger than 4 bytes, memory area that the pointer points to will not be released automatically. Before clearing this list, it is necessary to release that area explicitly using the delete statement. Otherwise, memory leakage will occur.

	Note
	This function will be called automatically when this list goes out of scope.

Example

SFXList<SInt32> list;
    
...
     
list.Clear();    // clear the list

Reference

SFXList::Remove

Return value

Description

This function checks whether or not this list contains the specified value.

	Note
	If the type of the element is a pointer to a class instance or data bigger than 4 bytes, their addresses will be compared with.

Example

SFXList<SInt32> list;

// append an element
if (list.InsertLast(2) == SFERR_NO_ERROR) {

    // append an element
    if (list.InsertLast(5) == SFERR_NO_ERROR) {

        // check whether or not the stack contains the elements below
        TRACE("Contains(2) = %s", (list.Contains(2)) ? ("true") : ("false"));  // contains(2) = true
        TRACE("Contains(4) = %s", (list.Contains(4)) ? ("true") : ("false"));  // contains(4) = false
    }
}

Reference

SFXList::FirstIndexOf | SFXList::LastIndexOf

Description

Get an instance that represents an empty list.

Return value

Description

This function checks whether or not this list equals the specified list (whether or not the same elements are saved in the same order).

	Note
	If the type of the element is a pointer, its address will be compared.

Return value

Description

This function gets the first index of the element of this list that equals the specified value, searching from the head to the tail.

By specifying the beginning index in the argument, you can search from any position other than the head. (The index of the head is 0.)

	Note
	If the type of the element is a pointer, its address will be compared.

Example

SFXList<SInt32> list;

// append an element
if (list.InsertLast(2) == SFERR_NO_ERROR) {

    // append an element
    if (list.InsertLast(5) == SFERR_NO_ERROR) {

        // get the first index of the element that equals the specified value, searching from the beginning
        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
    }
}

Reference

SFXList::Contains | SFXList::LastIndexOf

Return value

This function gets the element at the index specified in the argument.

	Caution
	In case no element exists at the specified index, no error will occur but this function will return 0 or null.

Reference

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

Return value

Enumerator that points to the element at the specified index

Description

This function gets the enumerator of this list that points to the element at the specified index.

	Note
	If the specified index is less than or equals 0, this function is same as the SFXList::GetFirstEnumerator function. If the specified index is more than or equals the size of this list, this function is same as the SFXList::GetLastEnumerator function.

Reference

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

Reference

SFXList::Get | SFXList::GetLast

Return value

Enumerator that points to the first element

Description

This function gets the enumerator of this list that points to the first element.

Example

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

// append an element
if (list.InsertLast(2) == SFERR_NO_ERROR) {
    // append an element
    if (list.InsertLast(5) == SFERR_NO_ERROR) {
        
        // get the enumerator that points to the first element
        en = list.GetFirstEnumerator();
        
        // check whether the next element exists or not
        while(en.HasNext()) {
            TRACE("%d", en.GetNext());  // 2 5 
        }
    }
}

Reference

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

Return value

Iterator that points to the first element

Description

This function gets the iterator of this list that points to the first element.

Example

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

// append an element
if (list.InsertLast(2) == SFERR_NO_ERROR) {
    // append an element
    if (list.InsertLast(5) == SFERR_NO_ERROR) {
        
        // get the iterator that points to the first element
        it = list.GetFirstIterator();
        
        // check whether the next element exists or not
        while(it.HasNext()) {
            TRACE("%d", it.GetNext());  // 2 5 
        }
    }
}

Reference

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

Return value

Iterator that points to the element at the specified index

Description

This function gets the iterator of this list that points to the element at the specified index.

	Note
	If the specified index is less than or equals 0, this function is same as the SFXList::GetFirstIterator function. If the specified index is more than or equals the size of this list, this function is same as the SFXList::GetLastIterator function.

Reference

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

Reference

SFXList::Get | SFXList::GetFirst

Return value

Enumerator that points to the last element

Description

This function gets the enumerator of this list that points to the last element.

Reference

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

Return value

Iterator that points to the last element

Description

This function gets the iterator of this list that points to the last element.

Reference

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

Example

SFXList<SInt32> list;
SInt16 i;

// append an element
if (list.InsertLast(2) == SFERR_NO_ERROR) {
    // append an element
    if (list.InsertLast(5) == SFERR_NO_ERROR) {
        // display the size(the number of the elements)
        TRACE("%d", list.GetSize());  // 2
    }
}

Return value

Description

This function inserts elements before the specified index.

If the value of the specified index is less than or equals 0, the element will be inserted at the head.

If the value of the specified index is greater than or equals the number of the elements, the element will be inserted at the tail.

Example

SFXList<SInt16> list;
SInt16 i;

// insert an element at the tail
if (list.InsertLast(2) == SFERR_NO_ERROR) {
    // insert an element at the tail
    if (list.InsertLast(5) == SFERR_NO_ERROR) {
        // insert an element at the head
        if (list.Insert(0, 3) == SFERR_NO_ERROR) {
            // insert an element at the specified index
            // if the value of the specified index is less than or equals 0, an element will be inserted at head
            // if the value of the specified index is greater than or equals the number of the elements, an element will be inserted at the tail
            if (list.Insert(10, 4) == SFERR_NO_ERROR) {

                // remove elements from the 1st index to the 2nd index
                list.Remove(1, 3);

                // enumerate elements by index
                for (i = 0; i < list.GetSize(); ++i) {
                    TRACE("%d", list.Get(i));  // 3 4
               }
           }
       }
    }
}

Reference

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

Return value

Description

This function inserts elements at the head.

Reference

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

Return value

Description

This function inserts elements at the tail.

Reference

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

Return value

Description

This function checks whether or not this list is empty.

Return value

Description

This function gets the last index of the element of this list that equals the specified value, searching from the tail to the head.

By specifying the beginning index in the argument, you can search from any position other than the tail. (The index of the head is 0.)

	Note
	If the type of the element is a pointer, its address will be compared.

Example

SFXList<SInt32> list;

// append an element
if (list.InsertLast(2) == SFERR_NO_ERROR) {

    // append an element
    if (list.InsertLast(5) == SFERR_NO_ERROR) {

        // get the last index of the element that equals the specified value, searching from the end
        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
    }
}

Reference

SFXList::Contains | SFXList::FirstIndexOf

Return value

Reference

SFXList::MoveFirst | SFXList::MoveLast

Return value

Reference

SFXList::Move | SFXList::MoveLast

Return value

Reference

SFXList::Move | SFXList::MoveFirst

Description

This function removes an element at the specified index or elements in the specified index range.

If the specified index is less than 0 or greater than or equals the number of the elements, no element will be removed

If the beginning index to remove is greater than or equals the number of the elements or the ending index to remove is less than or equals 0, no element will be removed

If the beginning index to remove is less than or equals 0, it will be reset to 0.

If the ending index to remove is greater than the number of the elements, it will be reset to the number of the elements.

Example

SFXList<SInt16> list;
SInt16 i;

// insert an element at the tail
if (list.InsertLast(2) == SFERR_NO_ERROR) {
    // insert an element at the tail
    if (list.InsertLast(5) == SFERR_NO_ERROR) {
        // insert an element at the head
        if (list.Insert(0, 3) == SFERR_NO_ERROR) {
            // insert an element at the specified index
            // if the value of the specified index is less than or equals 0, an element will be inserted at head
            // if the value of the specified index is greater than or equals the number of the elements, an element will be inserted at the tail
            if (list.Insert(10, 4) == SFERR_NO_ERROR) {

                // remove elements from the 1st index to the 2nd index
                list.Remove(1, 3);

                // enumerate elements by index
                for (i = 0; i < list.GetSize(); ++i) {
                    TRACE("%d", list.Get(i));  // 3 4
               }
           }
       }
    }
}

Reference

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

Description

This function removes the first element.

Reference

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

Description

This function removes the last element.

Reference

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

Return value

Description

This function sets the element at the specified index of this list to the specified value, or sets this list to the specified list.

* In case an error occurs during processing, this list will be restored.

Example

SFXList<SInt32> list;
SInt16 i;

// append an element
if (list.InsertLast(2) == SFERR_NO_ERROR) {

    // append an element
    if (list.InsertLast(5) == SFERR_NO_ERROR) {

        // set a value to the element
        if (list.Set(1, 10) == SFERR_NO_ERROR) {

            // enumerate elements by index
            for (i = 0; i < list.GetSize(); ++i) {

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

Reference

SFXList::Get | SFXList::Insert | SFXList::Remove

Return value

Reference

SFXList::GetFirst

Return value

Reference

SFXList::GetLast

Return value

Reference

SFXList::SwapFirst | SFXList::SwapLast

Return value

Reference

SFXList::Swap | SFXList::SwapLast

Return value

Reference

SFXList::Swap | SFXList::SwapFirst

Description

The Enumerator class is a class that manages an enumerator.

The Enumerator class has the following member functions.

Example

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

// append an element
if (list.InsertLast(2) == SFERR_NO_ERROR) {
    // append an element
    if (list.InsertLast(5) == SFERR_NO_ERROR) {
        
        // get the enumerator that points to the first element
        en = list.GetFirstEnumerator();
        
        // check whether the next element exists or not
        while(en.HasNext()) {
            TRACE("%d", en.GetNext());  // 2 5 
        }
    }
}

Reference

SFXList::Iterator

Description

The Iterator class is a class that manages an iterator.

The Iterator class has the following member functions.

Example

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

// append an element
if (list.InsertLast(2) == SFERR_NO_ERROR) {
    // append an element
    if (list.InsertLast(5) == SFERR_NO_ERROR) {
        
        // get the iterator that points to the first element
        it = list.GetFirstIterator();
        
        // check whether the next element exists or not
        while(it.HasNext()) {
            TRACE("%d", it.GetNext());  // 2 5 
        }
    }
}

Reference

SFXList::Enumerator