remove C++ comment

[wxWidgets.git] / docs / latex / wx / array.tex

diff --git a/docs/latex/wx/array.tex b/docs/latex/wx/array.tex
index d86b20c15da04b77500a90a2456e0043a1e28fa8..e73da13ebd110bc4bf25edb2b8d6b676d2935d44 100644 (file)
--- a/docs/latex/wx/array.tex
+++ b/docs/latex/wx/array.tex
@@ -1,7 +1,18 @@
-\section{\class{wxArray}}\label{wxarray}
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name:        array.tex
+%% Purpose:     wxArray
+%% Author:      wxWidgets Team
+%% Modified by:
+%% Created:
+%% RCS-ID:      $Id$
+%% Copyright:   (c) wxWidgets Team
+%% License:     wxWindows license
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\section{\class{wxArray<T>}}\label{wxarray}

 
 This section describes the so called {\it dynamic arrays}. This is a C
 
 This section describes the so called {\it dynamic arrays}. This is a C

-array-like data structure i.e. the member access time is constant (and not
+array-like type safe data structure i.e. the member access time is constant (and not

 linear according to the number of container elements as for linked lists). However, these
 arrays are dynamic in the sense that they will automatically allocate more
 memory if there is not enough of it for adding a new element. They also perform
 linear according to the number of container elements as for linked lists). However, these
 arrays are dynamic in the sense that they will automatically allocate more
 memory if there is not enough of it for adding a new element. They also perform


@@ -45,13 +56,12 @@ int, long and their unsigned variants) or pointers (of any kind). An attempt
 to use with objects of sizeof() greater than sizeof(long) will provoke a
 runtime assertion failure, however declaring a wxArray of floats will not (on
 the machines where sizeof(float) <= sizeof(long)), yet it will {\bf not} work,
 to use with objects of sizeof() greater than sizeof(long) will provoke a
 runtime assertion failure, however declaring a wxArray of floats will not (on
 the machines where sizeof(float) <= sizeof(long)), yet it will {\bf not} work,

-please use wxObjArray for storing floats and doubles (NB: a more efficient
-wxArrayDouble class is scheduled for the next release of wxWidgets).
+please use wxObjArray for storing floats and doubles.

 
 wxSortedArray is a wxArray variant which should be used when searching in the
 array is a frequently used operation. It requires you to define an additional
 function for comparing two elements of the array element type and always stores
 
 wxSortedArray is a wxArray variant which should be used when searching in the
 array is a frequently used operation. It requires you to define an additional
 function for comparing two elements of the array element type and always stores

-its items in the sorted order (according to this function). Thus, it is 
+its items in the sorted order (according to this function). Thus, it is

  \helpref{Index()}{wxarrayindex} function execution time is $O(log(N))$ instead of
 $O(N)$ for the usual arrays but the \helpref{Add()}{wxarrayadd} method is
 slower: it is $O(log(N))$ instead of constant time (neglecting time spent in
  \helpref{Index()}{wxarrayindex} function execution time is $O(log(N))$ instead of
 $O(N)$ for the usual arrays but the \helpref{Add()}{wxarrayadd} method is
 slower: it is $O(log(N))$ instead of constant time (neglecting time spent in


@@ -106,7 +116,7 @@ WX_DEFINE_OBJARRAY(ArrayOfDirectories);
 
 It is not as elegant as writing
 
 
 It is not as elegant as writing
 

-\begin{verbatim} 
+\begin{verbatim}

 typedef std::vector<MyDirectory> ArrayOfDirectories;
 \end{verbatim}
 
 typedef std::vector<MyDirectory> ArrayOfDirectories;
 \end{verbatim}
 


@@ -116,24 +126,37 @@ dumb, C++ compiler in the world.
 Things are much simpler for wxArray and wxSortedArray however: it is enough
 just to write
 
 Things are much simpler for wxArray and wxSortedArray however: it is enough
 just to write
 

-\begin{verbatim} 
-WX_DEFINE_ARRAY(int, ArrayOfDirectories);
-WX_DEFINE_SORTED_ARRAY(int, ArrayOfFiles);
+\begin{verbatim}
+WX_DEFINE_ARRAY_INT(int, ArrayOfInts);
+WX_DEFINE_SORTED_ARRAY_INT(int, ArrayOfSortedInts);

 \end{verbatim}
 
 \end{verbatim}
 

-i.e. there is only one {\tt DEFINE} macro and no need for separate 
-{\tt DECLARE} one.
+i.e. there is only one {\tt DEFINE} macro and no need for separate
+{\tt DECLARE} one. For the arrays of the primitive types, the macros 
+{\tt WX\_DEFINE\_ARRAY\_CHAR/SHORT/INT/SIZE\_T/LONG/DOUBLE} should be used
+depending on the sizeof of the values (notice that storing values of smaller
+type, e.g. shorts, in an array of larger one, e.g. {\tt ARRAY\_INT}, does
+\emph{not} work on all architectures!).

 
 
 
 

-\wxheading{See also:}
+\wxheading{See also}

 
 

-\helpref{Container classes overview}{wxcontaineroverview}, \helpref{wxList}{wxlist}
+\helpref{Container classes overview}{wxcontaineroverview}, 
+\helpref{wxList<T>}{wxlist},
+\helpref{wxVector<T>}{wxvector}

 
 \wxheading{Include files}
 
 <wx/dynarray.h> for wxArray and wxSortedArray and additionally <wx/arrimpl.cpp>
 for wxObjArray.
 
 
 \wxheading{Include files}
 
 <wx/dynarray.h> for wxArray and wxSortedArray and additionally <wx/arrimpl.cpp>
 for wxObjArray.
 

+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
+
+
+

 \latexignore{\rtfignore{\wxheading{Function groups}}}
 
 \membersection{Macros for template array definition}\label{arraymacros}
 \latexignore{\rtfignore{\wxheading{Function groups}}}
 
 \membersection{Macros for template array definition}\label{arraymacros}


@@ -159,18 +182,22 @@ WX\_DEFINE\_OBJARRAY macro.
 To slightly complicate the matters even further, the operator $->$ defined by
 default for the array iterators by these macros only makes sense if the array
 element type is not a pointer itself and, although it still works, this
 To slightly complicate the matters even further, the operator $->$ defined by
 default for the array iterators by these macros only makes sense if the array
 element type is not a pointer itself and, although it still works, this

-provokes warnings from some compilers and to avoid them you should use the 
+provokes warnings from some compilers and to avoid them you should use the

 {\tt \_PTR} versions of the macros above. For example, to define an array of
 {\tt \_PTR} versions of the macros above. For example, to define an array of

-pointers to {\tt double} you should use.
+pointers to {\tt double} you should use:
+
+\begin{verbatim}
+WX_DEFINE_ARRAY_PTR(double *, MyArrayOfDoublePointers);
+\end{verbatim}

 
 

-Note that the above macros are generally only useful for 
-wxObject types.  There are seperate macros for declaring an array of a simple type, 
+Note that the above macros are generally only useful for
+wxObject types.  There are separate macros for declaring an array of a simple type,

 such as an int.
 
 The following simple types are supported:\\
 int\\
 long\\
 such as an int.
 
 The following simple types are supported:\\
 int\\
 long\\

-size_t\\
+size\_t\\

 double
 
 To create an array of a simple type, simply append the type you want in CAPS to
 double
 
 To create an array of a simple type, simply append the type you want in CAPS to


@@ -185,10 +212,6 @@ For example, for an integer array, you'd use one of the following variants:
 \helpref{WX\_DEFINE\_SORTED\_EXPORTED\_ARRAY\_INT}{wxdefinesortedarray}\\
 \helpref{WX\_DEFINE\_SORTED\_USER\_EXPORTED\_ARRAY\_INT}{wxdefinesortedarray}\\
 
 \helpref{WX\_DEFINE\_SORTED\_EXPORTED\_ARRAY\_INT}{wxdefinesortedarray}\\
 \helpref{WX\_DEFINE\_SORTED\_USER\_EXPORTED\_ARRAY\_INT}{wxdefinesortedarray}\\
 

-\begin{verbatim} 
-WX_DEFINE_ARRAY_PTR(double *, MyArrayOfDoublePointers);
-\end{verbatim}
-

 \membersection{Constructors and destructors}\label{arrayconstructorsdestructors}
 
 Array classes are 100\% C++ objects and as such they have the appropriate copy
 \membersection{Constructors and destructors}\label{arrayconstructorsdestructors}
 
 Array classes are 100\% C++ objects and as such they have the appropriate copy


@@ -214,7 +237,7 @@ amount, but no more than some maximal number which is defined by
 ARRAY\_MAXSIZE\_INCREMENT constant. Of course, this may lead to some memory
 being wasted (ARRAY\_MAXSIZE\_INCREMENT in the worst case, i.e. 4Kb in the
 current implementation), so the \helpref{Shrink()}{wxarrayshrink} function is
 ARRAY\_MAXSIZE\_INCREMENT constant. Of course, this may lead to some memory
 being wasted (ARRAY\_MAXSIZE\_INCREMENT in the worst case, i.e. 4Kb in the
 current implementation), so the \helpref{Shrink()}{wxarrayshrink} function is

-provided to deallocate the extra memory. The \helpref{Alloc()}{wxarrayalloc} 
+provided to deallocate the extra memory. The \helpref{Alloc()}{wxarrayalloc}

 function can also be quite useful if you know in advance how many items you are
 going to put in the array and will prevent the array code from reallocating the
 memory more times than needed.
 function can also be quite useful if you know in advance how many items you are
 going to put in the array and will prevent the array code from reallocating the
 memory more times than needed.


@@ -228,7 +251,6 @@ Functions in this section return the total number of array elements and allow to
 retrieve them - possibly using just the C array indexing $[]$ operator which
 does exactly the same as \helpref{Item()}{wxarrayitem} method.
 
 retrieve them - possibly using just the C array indexing $[]$ operator which
 does exactly the same as \helpref{Item()}{wxarrayitem} method.
 

-\helpref{Count}{wxarraycount}\\

 \helpref{GetCount}{wxarraygetcount}\\
 \helpref{IsEmpty}{wxarrayisempty}\\
 \helpref{Item}{wxarrayitem}\\
 \helpref{GetCount}{wxarraygetcount}\\
 \helpref{IsEmpty}{wxarrayisempty}\\
 \helpref{Item}{wxarrayitem}\\


@@ -239,7 +261,8 @@ does exactly the same as \helpref{Item()}{wxarrayitem} method.
 \helpref{Add}{wxarrayadd}\\
 \helpref{Insert}{wxarrayinsert}\\
 \helpref{SetCount}{wxarraysetcount}\\
 \helpref{Add}{wxarrayadd}\\
 \helpref{Insert}{wxarrayinsert}\\
 \helpref{SetCount}{wxarraysetcount}\\

-\helpref{WX\_APPEND\_ARRAY}{wxappendarray}
+\helpref{WX\_APPEND\_ARRAY}{wxappendarray}\\
+\helpref{WX\_PREPEND\_ARRAY}{wxprependarray}

 
 \membersection{Removing items}\label{arrayremoving}
 
 
 \membersection{Removing items}\label{arrayremoving}
 


@@ -277,14 +300,15 @@ needed for exporting an array from a user DLL.
 Example:
 
 \begin{verbatim}
 Example:
 
 \begin{verbatim}

-WX_DEFINE_ARRAY_INT(wxArrayInt);
+WX_DEFINE_ARRAY_INT(int, MyArrayInt);

 
 class MyClass;
 
 class MyClass;

-WX_DEFINE_ARRAY(MyClass *, wxArrayOfMyClass);
+WX_DEFINE_ARRAY(MyClass *, ArrayOfMyClass);

 \end{verbatim}
 
 \end{verbatim}
 

-Note that wxWidgets predefines the following standard array classes: wxArrayInt,
-wxArrayLong and wxArrayPtrVoid.
+Note that wxWidgets predefines the following standard array classes: {\bf wxArrayInt},
+{\bf wxArrayLong}, {\bf wxArrayShort}, {\bf wxArrayDouble},  {\bf wxArrayPtrVoid}.
+

 
 \membersection{WX\_DEFINE\_SORTED\_ARRAY}\label{wxdefinesortedarray}
 
 
 \membersection{WX\_DEFINE\_SORTED\_ARRAY}\label{wxdefinesortedarray}
 


@@ -302,10 +326,10 @@ needed for exporting an array from a user DLL.
 Example:
 
 \begin{verbatim}
 Example:
 
 \begin{verbatim}

-WX_DEFINE_SORTED_ARRAY_INT(wxSortedArrayInt);
+WX_DEFINE_SORTED_ARRAY_INT(int, MySortedArrayInt);

 
 class MyClass;
 
 class MyClass;

-WX_DEFINE_SORTED_ARRAY(MyClass *, wxArrayOfMyClass);
+WX_DEFINE_SORTED_ARRAY(MyClass *, ArrayOfMyClass);

 \end{verbatim}
 
 You will have to initialize the objects of this class by passing a comparison
 \end{verbatim}
 
 You will have to initialize the objects of this class by passing a comparison


@@ -359,10 +383,10 @@ the array class - otherwise you would get link errors.
 
 \func{}{WX\_DEFINE\_USER\_EXPORTED\_OBJARRAY}{\param{}{name}}
 
 
 \func{}{WX\_DEFINE\_USER\_EXPORTED\_OBJARRAY}{\param{}{name}}
 

-This macro defines the methods of the array class {\it name} not defined by the 
+This macro defines the methods of the array class {\it name} not defined by the

 \helpref{WX\_DECLARE\_OBJARRAY()}{wxdeclareobjarray} macro. You must include the
 file <wx/arrimpl.cpp> before using this macro and you must have the full
 \helpref{WX\_DECLARE\_OBJARRAY()}{wxdeclareobjarray} macro. You must include the
 file <wx/arrimpl.cpp> before using this macro and you must have the full

-declaration of the class of array elements in scope! If you forget to do the 
+declaration of the class of array elements in scope! If you forget to do the

 first, the error will be caught by the compiler, but, unfortunately, many
 compilers will not give any warnings if you forget to do the second - but the
 objects of the class will not be copied correctly and their real destructor will
 first, the error will be caught by the compiler, but, unfortunately, many
 compilers will not give any warnings if you forget to do the second - but the
 objects of the class will not be copied correctly and their real destructor will


@@ -391,7 +415,14 @@ WX_DEFINE_OBJARRAY(wxArrayOfMyClass);
 
 \func{void}{WX\_APPEND\_ARRAY}{\param{wxArray\& }{array}, \param{wxArray\& }{other}}
 
 
 \func{void}{WX\_APPEND\_ARRAY}{\param{wxArray\& }{array}, \param{wxArray\& }{other}}
 

-This macro may be used to append all elements of the {\it other} array to the 
+This macro may be used to append all elements of the {\it other} array to the
+{\it array}. The two arrays must be of the same type.
+
+\membersection{WX\_PREPEND\_ARRAY}\label{wxprependarray}
+
+\func{void}{WX\_PREPEND\_ARRAY}{\param{wxArray\& }{array}, \param{wxArray\& }{other}}
+
+This macro may be used to prepend all elements of the {\it other} array to the

 {\it array}. The two arrays must be of the same type.
 
 \membersection{WX\_CLEAR\_ARRAY}\label{wxcleararray}
 {\it array}. The two arrays must be of the same type.
 
 \membersection{WX\_CLEAR\_ARRAY}\label{wxcleararray}


@@ -446,7 +477,7 @@ the array element are copied too) for wxObjArray.
 \func{}{\destruct{wxObjArray}}{\void}
 
 The wxObjArray destructor deletes all the items owned by the array. This is not
 \func{}{\destruct{wxObjArray}}{\void}
 
 The wxObjArray destructor deletes all the items owned by the array. This is not

-done by wxArray and wxSortedArray versions - you may use 
+done by wxArray and wxSortedArray versions - you may use

 \helpref{WX\_CLEAR\_ARRAY}{wxcleararray} macro for this.
 
 \membersection{wxArray::Add}\label{wxarrayadd}
 \helpref{WX\_CLEAR\_ARRAY}{wxcleararray} macro for this.
 
 \membersection{wxArray::Add}\label{wxarrayadd}


@@ -471,7 +502,7 @@ that you cannot append more than one pointer as reusing it would lead to
 deleting it twice (or more) and hence to a crash.
 
 You may also use \helpref{WX\_APPEND\_ARRAY}{wxappendarray} macro to append all
 deleting it twice (or more) and hence to a crash.
 
 You may also use \helpref{WX\_APPEND\_ARRAY}{wxappendarray} macro to append all

-elements of one array to another one but it is more efficient to use 
+elements of one array to another one but it is more efficient to use

 {\it copies} parameter and modify the elements in place later if you plan to
 append a lot of items.
 
 {\it copies} parameter and modify the elements in place later if you plan to
 append a lot of items.
 


@@ -482,7 +513,8 @@ append a lot of items.
 Preallocates memory for a given number of array elements. It is worth calling
 when the number of items which are going to be added to the array is known in
 advance because it will save unneeded memory reallocation. If the array already
 Preallocates memory for a given number of array elements. It is worth calling
 when the number of items which are going to be added to the array is known in
 advance because it will save unneeded memory reallocation. If the array already

-has enough memory for the given number of items, nothing happens.
+has enough memory for the given number of items, nothing happens. In any case,
+the existing contents of the array is not modified.

 
 \membersection{wxArray::Clear}\label{wxarrayclear}
 
 
 \membersection{wxArray::Clear}\label{wxarrayclear}
 


@@ -491,18 +523,11 @@ has enough memory for the given number of items, nothing happens.
 This function does the same as \helpref{Empty()}{wxarrayempty} and additionally
 frees the memory allocated to the array.
 
 This function does the same as \helpref{Empty()}{wxarrayempty} and additionally
 frees the memory allocated to the array.
 

-\membersection{wxArray::Count}\label{wxarraycount}
-
-\constfunc{size\_t}{Count}{\void}
-
-Same as \helpref{GetCount()}{wxarraygetcount}. This function is deprecated -
-it exists only for compatibility.
-

 \membersection{wxObjArray::Detach}\label{wxobjarraydetach}
 
 \func{T *}{Detach}{\param{size\_t }{index}}
 
 \membersection{wxObjArray::Detach}\label{wxobjarraydetach}
 
 \func{T *}{Detach}{\param{size\_t }{index}}
 

-Removes the element from the array, but, unlike, 
+Removes the element from the array, but, unlike,

 \helpref{Remove()}{wxarrayremove} doesn't delete it. The function returns the
 pointer to the removed element.
 
 \helpref{Remove()}{wxarrayremove} doesn't delete it. The function returns the
 pointer to the removed element.
 


@@ -512,7 +537,7 @@ pointer to the removed element.
 
 Empties the array. For wxObjArray classes, this destroys all of the array
 elements. For wxArray and wxSortedArray this does nothing except marking the
 
 Empties the array. For wxObjArray classes, this destroys all of the array
 elements. For wxArray and wxSortedArray this does nothing except marking the

-array of being empty - this function does not free the allocated memory, use 
+array of being empty - this function does not free the allocated memory, use

 \helpref{Clear()}{wxarrayclear} for this.
 
 \membersection{wxArray::GetCount}\label{wxarraygetcount}
 \helpref{Clear()}{wxarrayclear} for this.
 
 \membersection{wxArray::GetCount}\label{wxarraygetcount}


@@ -523,15 +548,15 @@ Return the number of items in the array.
 
 \membersection{wxArray::Index}\label{wxarrayindex}
 
 
 \membersection{wxArray::Index}\label{wxarrayindex}
 

-\func{int}{Index}{\param{T\& }{item}, \param{bool }{searchFromEnd = false}}
+\constfunc{int}{Index}{\param{T\& }{item}, \param{bool }{searchFromEnd = false}}

 
 

-\func{int}{Index}{\param{T\& }{item}}
+\constfunc{int}{Index}{\param{T\& }{item}}

 
 The first version of the function is for wxArray and wxObjArray, the second is
 for wxSortedArray only.
 
 Searches the element in the array, starting from either beginning or the end
 
 The first version of the function is for wxArray and wxObjArray, the second is
 for wxSortedArray only.
 
 Searches the element in the array, starting from either beginning or the end

-depending on the value of {\it searchFromEnd} parameter. wxNOT\_FOUND is
+depending on the value of {\it searchFromEnd} parameter. {\tt wxNOT\_FOUND} is

 returned if the element is not found, otherwise the index of the element is
 returned.
 
 returned if the element is not found, otherwise the index of the element is
 returned.
 


@@ -595,7 +620,7 @@ Removes an element from the array by value: the first item of the
 array equal to {\it item} is removed, an assert failure will result from an
 attempt to remove an item which doesn't exist in the array.
 
 array equal to {\it item} is removed, an assert failure will result from an
 attempt to remove an item which doesn't exist in the array.
 

-When an element is removed from wxObjArray it is deleted by the array - use 
+When an element is removed from wxObjArray it is deleted by the array - use

 \helpref{Detach()}{wxobjarraydetach} if you don't want this to happen. On the
 other hand, when an object is removed from a wxArray nothing happens - you
 should delete it manually if required:
 \helpref{Detach()}{wxobjarraydetach} if you don't want this to happen. On the
 other hand, when an object is removed from a wxArray nothing happens - you
 should delete it manually if required:


@@ -632,8 +657,8 @@ elements of a wxArray (supposed to contain pointers).
 
 \func{void}{SetCount}{\param{size\_t }{count}, \param{T }{defval = T($0$)}}
 
 
 \func{void}{SetCount}{\param{size\_t }{count}, \param{T }{defval = T($0$)}}
 

-This function ensures that the number of array elements is at least 
-{\it count}. If the array has already {\it count} or mroe items, nothing is
+This function ensures that the number of array elements is at least
+{\it count}. If the array has already {\it count} or more items, nothing is

 done. Otherwise, {\tt count - GetCount()} elements are added and initialized to
 the value {\it defval}.
 
 done. Otherwise, {\tt count - GetCount()} elements are added and initialized to
 the value {\it defval}.
 


@@ -660,7 +685,7 @@ The notation CMPFUNC<T> should be read as if we had the following declaration:
 template int CMPFUNC(T *first, T *second);
 \end{verbatim}
 
 template int CMPFUNC(T *first, T *second);
 \end{verbatim}
 

-where {\it T} is the type of the array elements. I.e. it is a function returning 
+where {\it T} is the type of the array elements. I.e. it is a function returning

 {\it int} which is passed two arguments of type {\it T *}.
 
 Sorts the array using the specified compare function: this function should
 {\it int} which is passed two arguments of type {\it T *}.
 
 Sorts the array using the specified compare function: this function should