KDE 3.5 API Reference kviewshell
ArrayBase Class Reference
Dynamic array base class. More...
#include <Arrays.h>
Public Member Functions | |
| virtual | ~ArrayBase (void) |
Protected Member Functions | |
| ArrayBase (void) | |
Arrays.h | |
| Files #"Arrays.h"# and #"Arrays.cpp"# implement three array template classes. Class {TArray} implements an array of objects of trivial types such as char#, int#, float#, etc. It is faster than general implementation for any type done in {DArray} because it does not cope with element's constructors, destructors and copy operators. Although implemented as a template, which makes it possible to incorrectly use {TArray} with non-trivial classes, it should not be done. A lot of things is shared by these three arrays. That is why there are more base classes: {itemize} {ArrayBase} defines functions independent of the elements type {ArrayBaseT} template class defining functions shared by {DArray} and {TArray} {itemize} The main difference between {GArray} (now obsolete) and these ones is the copy-on-demand strategy, which allows you to copy array objects without copying the real data. It's the same thing, which has been implemented in {GString} long ago: as long as you don't try to modify the underlying data, it may be shared between several copies of array objects. As soon as you attempt to make any changes, a private copy is created automatically and transparently for you - the procedure, that we call "copy-on-demand". Also, please note that now there is no separate class, which does fast sorting. Both {TArray} (dynamic array for trivial types) and {DArray} (dynamic array for arbitrary types) can sort their elements. { Historical comments} --- Leon chose to implement his own arrays because the STL classes were not universally available and the compilers were rarely able to deal with such a template galore. Later it became clear that there is no really good reason why arrays should be derived from containers. It was also suggested to create separate arrays implementation for simple classes and do the copy-on-demand strategy, which would allow to assign array objects without immediate copying of their elements. At this point {DArray} and {TArray} should only be used when it is critical to have the copy-on-demand feature. The {GArray} implementation is a lot more efficient. Template array classes.
| |
| void | check (void) |
| void | detach (void) |
| void | del (int n, unsigned int howmany=1) |
| void | empty () |
| int | hbound () const |
| int | lbound () const |
| void | resize (int lobound, int hibound) |
| void | resize (int hibound) |
| void | shift (int disp) |
| int | size () const |
| void | touch (int n) |
Detailed Description
Dynamic array base class.This is an auxiliary base class for {DArray} and {TArray} implementing some shared functions independent of the type of array elements. It's not supposed to be constructed by hands. Use {DArray} and {TArray} instead.
Definition at line 305 of file Arrays.h.
Constructor & Destructor Documentation
Member Function Documentation
| void ArrayBase::del | ( | int | n, | |
| unsigned int | howmany = 1 | |||
| ) | [inline] |
Deletes array elements.
The array elements corresponding to subscripts n#...n+howmany-1# are destroyed. All array elements previously located at subscripts greater or equal to n+howmany# are moved to subscripts starting with n#. The new subscript upper bound is reduced in order to account for this shift.
- Parameters:
-
n subscript of the first element to delete. howmany number of elements to delete.
| void ArrayBase::empty | ( | ) | [inline] |
| int ArrayBase::hbound | ( | ) | const [inline] |
| int ArrayBase::lbound | ( | ) | const [inline] |
| void ArrayBase::resize | ( | int | lobound, | |
| int | hibound | |||
| ) | [inline] |
Resets the valid subscript range to lobound#---hibound#.
This function may destroy some array elements and may construct new array elements with the null constructor. Setting lobound# to #0# and hibound# to #-1# resets the valid subscript range to the empty range.
- Parameters:
-
lobound lower bound of the new subscript range. hibound upper bound of the new subscript range.
| void ArrayBase::resize | ( | int | hibound | ) | [inline] |
Resets the valid subscript range to #0#---hibound#.
This function may destroy some array elements and may construct new array elements with the null constructor. Setting hibound# to #-1# resets the valid subscript range to the empty range.
- Parameters:
-
hibound upper bound of the new subscript range.
| void ArrayBase::shift | ( | int | disp | ) | [inline] |
| int ArrayBase::size | ( | ) | const [inline] |
| void ArrayBase::touch | ( | int | n | ) | [inline] |
Extends the subscript range so that is contains n#.
This function does nothing if n# is already int the valid subscript range. If the valid range was empty, both the lower bound and the upper bound are set to n#. Otherwise the valid subscript range is extended to encompass n#. This function is very handy when called before setting an array element: {verbatim} int lineno=1; DArray<GString> a; while (! end_of_file()) { a.touch[lineno]; a[lineno++] = read_a_line(); } {verbatim}
The documentation for this class was generated from the following file:
