Inheritance diagram

Collaboration diagram

Description

SFXStack is the data structure to store all its elements into the consecutive memory area(internal buffer) in which the last added element is removed first.

In the default settings, when the first element is inserted, the internal buffer will be allocated by the size set with the SFXStack::SetThreshold function(default: size for 4 elements). Then, in case memory becomes insufficient while elements are inserted one by one, the internal buffer will be expanded by the cluster size set with the SFXStack::SetCluster function(default: size for 8 elements). Here, the size of one element is 4 byte.

Caution

When the internal buffer is expanded, new consecutive memory area bigger than the current one by the cluster size will be allocated and all data of existing elements will be copied there. Therefore, if expansion is performed frequently, it may become the cause of performance deterioration If the number of the elements are known in advance, it is recommended to set the internal buffer size with the SFXStack::SetThreshold / SFXStack::SetCluster functions or to set the number of the elements with the SFXStack::SetSize function(*). * If the internal buffer is expanded with the SFXStack::SetSize function, each element in the expanded area will be set to 0.

Each element size of SFXStack 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 SFXStack instance ( stack ), a pointer should be used.

// data more than 4 byte or class instance cannot be an element of the SFXStack instance ( stack )

// SFXStack<SInt64> st64;           NG
// SFXStack<SFXAnsiString> ststr;   NG

// but a pointer to the data more than 4 byte or class instance can be an element of the SFXStack instance ( stack )

SFXStack<SInt64Ptr> st64;        // OK
SFXStack<SFXAnsiStringPtr> ststr;// OK

Reference

SFXArray | SFXList | Stack

Member

Description

It is possible to improve performance by specifying the minimum size of the internal buffer memory and the cluster size optimized for your application in order to minimize the occurrence of memory reallocation.

	Tip
	The minimum size of the internal buffer memory or the cluster size can be set with the SFXStack::SetThreshold or SFXStack::SetCluster function.

Reference

SFXStack::Set | SFXStack::SetThreshold | SFXStack::SetCluster

Return value

Description

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

Example

SFXStack<SInt08> stack;
SInt16 i;

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

Reference

SFXStack::Insert | SFXStack::InsertLast | SFXStack::Get | SFXStack::Push | SFXStack::Remove | SFXStack::Set

Description

This function clears this stack. All the internal buffer allocated to this stack will be released.

After this function is executed, the size of this stack 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 stack, 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 stack goes out of scope.

Example

SFXStack<SInt08> stack;
    
...
     
stack.Clear();    // clear the stack

Reference

SFXStack::Remove | SFXStack::SetCluster | SFXStack::SetThreshold | SFXStack::GetSize

Return value

Description

This function checks whether or not this stack 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

SFXStack<SInt08> stack;

// push an element
if (stack.Push(2) == SFERR_NO_ERROR) {

    // push an element
    if (stack.InsertLast(5) == SFERR_NO_ERROR) {

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

Reference

SFXStack::FirstIndexOf | SFXStack::LastIndexOf

Description

Get an instance that represents an empty stack.

Return value

Description

This function checks whether or not this stack equals the specified stack (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 stack 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

SFXStack<SInt08> stack;

// push an element onto the stack
if (stack.Push(2) == SFERR_NO_ERROR) {

    // push an element onto the stack
    if (stack.Push(5) == SFERR_NO_ERROR) {

        // get the first index of the element that equals the specified value, searching from the head to the tail
        TRACE("FirstIndexOf(1) = %d", stack.FirstIndexOf(1));  // firstIndexOf(1) = -1
        TRACE("FirstIndexOf(2) = %d", stack.FirstIndexOf(2));  // firstIndexOf(2) = 0
        TRACE("FirstIndexOf(5) = %d", stack.FirstIndexOf(5));  // firstIndexOf(5) = 1
    }
}

Reference

SFXStack::Contains | SFXStack::LastIndexOf

Return value

Element at the index specified in the argument. 0 or null will be returned if no element exists at the specified index.

Description

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

SFXStack::GetFirst | SFXStack::GetLast | SFXStack::Insert | SFXStack::Remove | SFXStack::Set

Return value

Cluster size of the internal buffer memory [in bytes]

Description

This function gets the cluster size, by which the size of the internal buffer memory increases. [in bytes]

Reference

SFXStack::SetCluster

Return value

Enumerator that points to the element at the specified index

Description

This function gets the enumerator of this stack 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 SFXStack::GetFirstEnumerator function. If the specified index is more than or equals the size of this stack, this function is same as the SFXStack::GetLastEnumerator function.

Reference

SFXStack::GetFirstEnumerator | SFXStack::GetLastEnumerator | SFXStack::GetIterator | SFXStack::Enumerator

Return value

Element at the head. 0 or null will be returned if no element exists in this stack.

Description

This function gets the element at the head.

	Caution
	In case no element exists in this stack, no error will occur but this function will return 0 or null.

Reference

SFXStack::Get | SFXStack::GetLast | SFXStack::InsertFirst | SFXStack::RemoveFirst

Return value

Enumerator that points to the first element

Description

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

Example

SFXStack<SInt08> stack;
SFXStack<SInt08>::Enumerator en;

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

Reference

SFXStack::GetEnumerator | SFXStack::GetFirstIterator | SFXStack::Enumerator

Return value

Iterator that points to the first element

Description

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

Example

SFXStack<SInt08> stack;
SFXStack<SInt08>::Iterator it;

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

Reference

SFXStack::GetIterator | SFXStack::GetFirstEnumerator | SFXStack::Iterator

Return value

Iterator that points to the element at the specified index

Description

This function gets the iterator of this stack 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 SFXStack::GetFirstIterator function. If the specified index is more than or equals the size of this stack, this function is same as the SFXStack::GetLastIterator function.

Reference

SFXStack::GetFirstIterator | SFXStack::GetLastIterator | SFXStack::GetEnumerator | SFXStack::Iterator

Return value

Element at the tail. 0 or null will be returned if no element exists in this stack.

Description

This function gets the element at the tail.

	Caution
	In case no element exists in this stack, no error will occur but this function will return 0 or null.

Reference

SFXStack::Get | SFXStack::GetFirst | SFXStack::Peek | SFXStack::InsertLast | SFXStack::RemoveLast

Return value

Enumerator that points to the last element

Description

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

Reference

SFXStack::GetEnumerator | SFXStack::GetLastIterator | SFXStack::Enumerator

Return value

Iterator that points to the last element

Description

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

Reference

SFXStack::GetIterator | SFXStack::GetLastEnumerator | SFXStack::Iterator

Example

SFXStack<SInt08> stack;
SInt16 i;

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

Reference

SFXStack::SetSize

Return value

Minimum size of the internal buffer memory. [in bytes]

Description

This function gets the minimum size of the internal buffer memory. [in bytes]

Reference

SFXStack::SetThreshold

Return value

Description

This function inserts the specified element or stack 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

SFXStack<SInt08> stack;
SInt16 i;

// insert an element at the tail
if (stack.InsertLast(2) == SFERR_NO_ERROR) {
    // insert an element at the tail
    if (stack.InsertLast(5) == SFERR_NO_ERROR) {
        // insert an element at the head
        if (stack.Insert(0, 3) == SFERR_NO_ERROR) {
            // insert an element before 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 (stack.Insert(10, 4) == SFERR_NO_ERROR) {

                // remove from stack[1] to stack[2]
                stack.Remove(1, 3);

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

Reference

SFXStack::InsertFirst | SFXStack::InsertLast | SFXStack::Set | SFXStack::Get | SFXStack::Remove

Return value

Description

This function the specified element or stack at the head.

Reference

SFXStack::Insert | SFXStack::InsertLast | SFXStack::RemoveFirst | SFXStack::GetFirst

Return value

Description

This function inserts the specified element or stack at the tail.

Reference

SFXStack::Insert | SFXStack::InsertFirst | SFXStack::Push | SFXStack::GetLast | SFXStack::RemoveLast

Return value

Description

This function checks whether or not this stack is empty.

Return value

Description

This function gets the last index of the element of this stack 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

SFXStack<SInt08> stack;

// push an element onto the stack
if (stack.Push(2) == SFERR_NO_ERROR) {

    // push an element onto the stack
    if (stack.Push(5) == SFERR_NO_ERROR) {

        // get the last index of the element that equals the specified value, searching from the tail to the head
        TRACE("LastIndexOf(1) = %d", stack.LastIndexOf(1));  // lastIndexOf(1) = -1
        TRACE("LastIndexOf(2) = %d", stack.LastIndexOf(2));  // lastIndexOf(2) = 0
        TRACE("LastIndexOf(5) = %d", stack.LastIndexOf(5));  // lastIndexOf(5) = 1
    }
}

Reference

SFXStack::Contains | SFXStack::FirstIndexOf | SFXStack::Search

Return value

Description

This function moves the element at the specified index to the specified index.

Reference

SFXStack::MoveFirst | SFXStack::MoveLast

Return value

Description

This function moves the element at the specified index to the head.

Reference

SFXStack::Move | SFXStack::MoveLast

Return value

Description

This function moves the element at the specified index to the tail.

Reference

SFXStack::Move | SFXStack::MoveFirst

Return value

Top element of this stack (Last pushed element)

Description

This function gets the the top element from this stack, which is the last pushed element.

	Caution
	If this stack is empty, no error will occur, and 0 or null will be returned depending on the type of the element.

	Note
	After this function is executed, the contents of this stack will remain the same as before.

Example

SFXStack<SInt08> stack;

// push an element onto the stack
if (stack.Push(1) == SFERR_NO_ERROR) {    

    // get the top element from the stack
    TRACE("%d", stack.Peek());  // 1

    // push an element onto the stack
    if (stack.Push(2) == SFERR_NO_ERROR) { 
    
    	// get the top element from the stack
        TRACE("%d", stack.Peek());  // 2
        
        // push an element onto the stack
        if (stack.Push(3) == SFERR_NO_ERROR) {
        
            // get the top element from the stack
            TRACE("%d", stack.Peek());  // 3
        }
    }
}

Reference

SFXStack::Push | SFXStack::Pop | SFXStack::Get | SFXStack::GetFirst | SFXStack::GetLast

Return value

Top element of this stack. If this stack is empty, no error will occur and 0 will be returned.

Description

This function gets the top element of this stack and remove it.

	Caution
	If this stack is empty, no error will occur, and 0 or null will be returned depending on the type of the element.

Example

SFXStack<SInt08> stack;

// append an element onto the stack
if (stack.Push(1) == SFERR_NO_ERROR) {    

    // append an element onto the stack
    if (stack.Push(2) == SFERR_NO_ERROR) { 
         
        // append an element onto the stack
        if (stack.Push(3) == SFERR_NO_ERROR) {
  
            // get the top element of stack and remove it
            TRACE("%d", stack.Pop());  // 3
            TRACE("%d", stack.Pop());  // 2
            TRACE("%d", stack.Pop());  // 1
        }
    }
}

Reference

SFXStack::Peek | SFXStack::Push| SFXStack::IsEmpty | SFXStack::Get | SFXStack::GetFirst | SFXStack::GetLast | SFXStack::Remove | SFXStack::RemoveFirst | SFXStack::RemoveLast

Return value

Description

Inside the Push function, the SFXStack::InsertLast function is called.

Example

SFXStack<SInt08> stack;

// append an element onto the stack
if (stack.Push(1) == SFERR_NO_ERROR) {    

    // get the top element of stack, but don't remove it
    TRACE("%d", stack.Peek());  // 1

    // append an element onto the stack
    if (stack.Push(2) == SFERR_NO_ERROR) { 
    
    	// get the top element of stack, but don't remove it
        TRACE("%d", stack.Peek());  // 2
        
        // append an element onto the stack
        if (stack.Push(3) == SFERR_NO_ERROR) {
        
            // get the top element of stack, but don't remove it
            TRACE("%d", stack.Peek());  // 3
        }
    }
}

Reference

SFXStack::Insert | SFXStack::InsertLast | SFXStack::Set | SFXStack::Pop | SFXStack::Peek

Description

This function removes the element at the specified index or the 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.

	Caution
	If no element exists at the specified index or range, no error will occur and nothing will happen.

Example

SFXStack<SInt08> stack;
SInt16 i;

// insert an element at the tail
if (stack.InsertLast(2) == SFERR_NO_ERROR) {

    // insert an element at the tail
    if (stack.InsertLast(5) == SFERR_NO_ERROR) {

        // insert an element at the head
        if (stack.Insert(0, 3) == SFERR_NO_ERROR) {

            // insert an element before 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 (stack.Insert(10, 4) == SFERR_NO_ERROR) {

                // remove from stack[1] to stack[2]
                stack.Remove(1, 3);

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

                    TRACE("%d", stack[i]);  // 3 4
               }
           }
       }
    }
}

Reference

SFXStack::RemoveFirst | SFXStack::RemoveLast | SFXStack::Insert | SFXStack::Get | SFXStack::Set

Description

This function removes the element at the head.

	Caution
	If no element exists in this stack, no error will occur and nothing will happen.

Reference

SFXStack::Remove | SFXStack::RemoveLast | SFXStack::GetFirst | SFXStack::InsertFirst

Description

This function removes the element at the tail.

	Caution
	If no element exists in this stack, no error will occur and nothing will happen.

Reference

SFXStack::Remove | SFXStack::RemoveFirst | SFXStack::GetLast | SFXStack::InsertLast | SFXStack::Pop

Return value

Description

This function gets the first index of the element of this stack that equals the specified value, searching from the top of this stack. (The index of the top is 1.)

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

Example

SFXStack<SInt08> stack;

// append an element onto the stack
if (stack.Push(1) == SFERR_NO_ERROR) {    

    // append an element onto the stack
    if (stack.Push(2) == SFERR_NO_ERROR) { 
         
        // append an element onto the stack
        if (stack.Push(3) == SFERR_NO_ERROR) {
  
            // search from the top of stack
            TRACE("Search(3) = %d", stack.Search(3));  // 1
            TRACE("Search(5) = %d", stack.Search(5));  // -1
        }
    }
}

Reference

SFXStack::Contains | SFXStack::FirstIndexOf | SFXStack::LastIndexOf

Return value

Description

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

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

Example

SFXStack<SInt08> stack;
SInt16 i;

// append an element
if (stack.Push(2) == SFERR_NO_ERROR) {

    // append an element
    if (stack.Push(5) == SFERR_NO_ERROR) {

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

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

                TRACE("%d", stack[i]);  // 2 10
           }
       }
    }
}

Reference

SFXStack::Get | SFXStack::SetFirst | SFXStack::SetLast | SFXStack::Insert | SFXStack::Remove

Description

This function sets the minimum unit to allocate the internal buffer memory(SFXClusterHeap). [in bytes]

Default: SFXStack::DEFAULT_CLUSTER bytes

For the value of SFXStack::DEFAULT_CLUSTER, refer to SFXStack::DefaultEnum.

	Tip
	Since the size of one element is 4 byte, a multiple of four should be specified in the size argument.

Internal buffer memory

In the SFXStack class, an element will be stored into the internal buffer memory when appended. Initially, the size set with the SFXStack::SetThreshold function will be allocated as the internal buffer memory. If an element cannot be stored into the internal buffer memory when tried to be appended, the size added by the cluster size set with the SFXStack::SetCluster function will be re-allocated as the internal buffer memory. To minimize the re-allocation of the the internal buffer memory, it is recommended to optimize the size set with the SFXStack::SetThreshold / SFXStack::SetCluster function depending on the application characteristics.

Reference

SFXStack::GetCluster | SFXStack::SetThreshold | SFXStack::DefaultEnum | SFXClusterHeap::SetCluster | SFXClusterHeap

Return value

Description

This function sets the element at the head to the specified value.

Reference

SFXStack::GetFirst | SFXStack::Set | SFXStack::SetLast

Return value

Description

This function sets the element at the tail to the specified value.

Reference

SFXStack::GetLast | SFXStack::Set | SFXStack::SetFirst

Return value

Description

This function sets the size of this stack to the specified value.

	Note
	If the specified size is smaller than the current size of this stack, elements after the specified size will be removed. On the contrary, if it is bigger than the current size of this stack, each of the expanded elements will be set to 0.

Reference

SFXStack::GetSize

Description

This function sets the minimum memory of the internal buffer memory(SFXClusterHeap). [in bytes]

Default: SFXStack::DEFAULT_THRESHOLD bytes

For the value of SFXStack::DEFAULT_THRESHOLD, refer to SFXStack::DefaultEnum.

	Tip
	Since the size of one element is 4 byte, a multiple of four should be specified in the size argument.

Internal buffer memory

In the SFXStack class, an element will be stored into the internal buffer memory when appended. Initially, the size set with the SFXStack::SetThreshold function will be allocated as the internal buffer memory. If an element cannot be stored into the internal buffer memory when tried to be appended, the size added by the cluster size set with the SFXStack::SetCluster function will be re-allocated as the internal buffer memory. To minimize the re-allocation of the the internal buffer memory, it is recommended to optimize the size set with the SFXStack::SetThreshold / SFXStack::SetCluster function depending on the application characteristics.

Reference

SFXStack::GetThreshold | SFXStack::SetCluster | SFXStack::DefaultEnum | SFXClusterHeap::SetThreshold | SFXClusterHeap

Return value

Description

This function swaps two elements at the specified indexes.

Reference

SFXStack::SwapFirst | SFXStack::SwapLast

Return value

Description

This function swaps the element at the specified index for the element at the head.

Reference

SFXStack::Swap | SFXStack::SwapLast

Return value

Description

This function swaps the element at the specified index for the element at the tail.

Reference

SFXStack::Swap | SFXStack::SwapFirst

Reference

SFXStack::Get | SFXStack::Set

Description

DEFAULT_THRESHOLD and DEFAULT_CLUSTER are the constants that represent the default values for the minimum size and the cluster size of the internal buffer memory(SFXClusterHeap). [in bytes]

Reference

SFXStack::SetCluster | SFXStack::SetThreshold | SFXClusterHeap

Description

This class is for managing the enumerator of this stack.

This class has the following member functions.

Example

SFXStack<SInt08> stack;
SFXStack<SInt08>::Enumerator en;

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

    // append an element
    if (stack.InsertLast(5) == SFERR_NO_ERROR) {
        
        // get the enumerator that points to the first element
        en = stack.GetFirstEnumerator();
        
        // check whether the next element exists or not
        while(en.HasNext()) {

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

Reference

SFXStack::Iterator

Description

This class is for managing the iterator of this stack.

This class has the following member functions.

Example

SFXStack<SInt08> stack;
SFXStack<SInt08>::Iterator it;

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

Reference

SFXStack::Enumerator