X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/06ad863606966ceee6e7eea537f8d427f0d891a9..0180dad680ecbe4cb5cf8e6e45ce569f7a1029f7:/docs/latex/wx/array.tex

diff --git a/docs/latex/wx/array.tex b/docs/latex/wx/array.tex
index 0cd2f78b5b..7f16a2a273 100644
--- a/docs/latex/wx/array.tex
+++ b/docs/latex/wx/array.tex
@@ -39,7 +39,14 @@ deleted when the element is removed from the array. It should be noted that
 all of wxArray's functions are inline, so it costs strictly nothing to define as
 many array types as you want (either in terms of the executable size or the
 speed) as long as at least one of them is defined and this is always the case
-because wxArrays are used by wxWindows internally.
+because wxArrays are used by wxWindows internally. This class has one serious
+limitation: it can only be used for storing integral types (bool, char, short,
+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,
+please use wxObjArray for storing floats and doubles (NB: a more efficient
+wxArrayDouble class is scheduled for the next release of wxWindows).
 
 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
@@ -51,9 +58,8 @@ slower: it is $O(log(N))$ instead of constant time (neglecting time spent in
 memory allocation routine). However, in a usual situation elements are added to
 an array much less often than searched inside it, so wxSortedArray may lead to
 huge performance improvements compared to wxArray. Finally, it should be
-noticed that, as wxArray, wxSortedArray can not be used to store anything of
-sizeof() larger than max(sizeof(long), sizeof(void *)) - an assertion failure
-will be raised from the constructor otherwise.
+noticed that, as wxArray, wxSortedArray can be only used for storing integral
+types or pointers.
 
 wxObjArray class treats its elements like "objects". It may delete them when
 they are removed from the array (invoking the correct destructor) and copies
@@ -304,7 +310,7 @@ WX_DEFINE_OBJARRAY(wxArrayOfMyClass);
 
 \membersection{WX\_CLEAR\_ARRAY}\label{wxcleararray}
 
-\func{\void}{WX\_CLEAR\_ARRAY}{\param{wxArray\& }{array}}
+\func{void}{WX\_CLEAR\_ARRAY}{\param{wxArray\& }{array}}
 
 This macro may be used to delete all elements of the array before emptying it.
 It can not be used with wxObjArrays - but they will delete their elements anyhow
@@ -312,9 +318,9 @@ when you call Empty().
 
 \membersection{Default constructors}\label{wxarrayctordef}
 
-\func{}{wxArray}{}
+\func{}{wxArray}{\void}
 
-\func{}{wxObjArray}{}
+\func{}{wxObjArray}{\void}
 
 Default constructor initializes an empty array object.
 
@@ -359,17 +365,17 @@ done by wxArray and wxSortedArray versions - you may use
 
 \membersection{wxArray::Add}\label{wxarrayadd}
 
-\func{\void}{Add}{\param{T }{item}}
+\func{void}{Add}{\param{T }{item}}
 
-\func{\void}{Add}{\param{T *}{item}}
+\func{void}{Add}{\param{T *}{item}}
 
-\func{\void}{Add}{\param{T \&}{item}}
+\func{void}{Add}{\param{T \&}{item}}
 
 Appends a new element to the array (where {\it T} is the type of the array
 elements.)
 
 The first version is used with wxArray and wxSortedArray. The second and the
-third are used with wxObjArray. There is an {\bf important difference} between
+third are used with wxObjArray. There is an important difference between
 them: if you give a pointer to the array, it will take ownership of it, i.e.
 will delete it when the item is deleted from the array. If you give a reference
 to the array, however, the array will make a copy of the item and will not take
@@ -378,7 +384,7 @@ because the other array types never take ownership of their elements.
 
 \membersection{wxArray::Alloc}\label{wxarrayalloc}
 
-\func{\void}{Alloc}{\param{size\_t }{count}}
+\func{void}{Alloc}{\param{size\_t }{count}}
 
 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
@@ -387,7 +393,7 @@ has enough memory for the given number of items, nothing happens.
 
 \membersection{wxArray::Clear}\label{wxarrayclear}
 
-\func{\void}{Clear}{\void}
+\func{void}{Clear}{\void}
 
 This function does the same as \helpref{Empty()}{wxarrayempty} and additionally
 frees the memory allocated to the array.
@@ -410,11 +416,11 @@ pointer to the removed element.
 
 \membersection{wxArray::Empty}\label{wxarrayempty}
 
-\func{\void}{Empty}{\void}
+\func{void}{Empty}{\void}
 
 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}
@@ -443,14 +449,14 @@ parameter doesn't make sense for it).
 
 \membersection{wxArray::Insert}\label{wxarrayinsert}
 
-\func{\void}{Insert}{\param{T }{item}, \param{size\_t }{n}}
+\func{void}{Insert}{\param{T }{item}, \param{size\_t }{n}}
 
-\func{\void}{Insert}{\param{T *}{item}, \param{size\_t }{n}}
+\func{void}{Insert}{\param{T *}{item}, \param{size\_t }{n}}
 
-\func{\void}{Insert}{\param{T \&}{item}, \param{size\_t }{n}}
+\func{void}{Insert}{\param{T \&}{item}, \param{size\_t }{n}}
 
-Insert a new item into the array before the item {\it n} - thus, {\it
-Insert(something, 0u}} will insert an item in such way that it will become the
+Insert a new item into the array before the item {\it n} - thus, {\it Insert(something, 0u)} will
+insert an item in such way that it will become the
 first array element.
 
 Please see \helpref{Add()}{wxarrayadd} for explanation of the differences
@@ -458,7 +464,7 @@ between the overloaded versions of this function.
 
 \membersection{wxArray::IsEmpty}\label{wxarrayisempty}
 
-\constfunc{bool}{IsEmpty}{}
+\constfunc{bool}{IsEmpty}{\void}
 
 Returns TRUE if the array is empty, FALSE otherwise.
 
@@ -506,7 +512,7 @@ elements of a wxArray (supposed to contain pointers).
 
 \membersection{wxArray::Shrink}\label{wxarrayshrink}
 
-\func{\void}{Shrink}{\void}
+\func{void}{Shrink}{\void}
 
 Frees all memory unused by the array. If the program knows that no new items
 will be added to the array it may call Shrink() to reduce its memory usage.
@@ -515,7 +521,7 @@ allocated again.
 
 \membersection{wxArray::Sort}\label{wxarraysort}
 
-\func{\void}{Sort}{\param{CMPFUNC<T> }{compareFunction}}
+\func{void}{Sort}{\param{CMPFUNC<T> }{compareFunction}}
 
 The notation CMPFUNC<T> should be read as if we had the following declaration:
 
@@ -523,7 +529,7 @@ The notation CMPFUNC<T> should be read as if we had the following declaration:
 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
