Changeset 55f5c59

Timestamp:

May 30, 2017, 11:44:48 AM (7 years ago)

Author:

Peter A. Buhr <pabuhr@…>

Branches:

ADT, aaron-thesis, arm-eh, ast-experimental, cleanup-dtors, deferred_resn, demangler, enum, forall-pointer-decay, jacob/cs343-translation, jenkins-sandbox, master, new-ast, new-ast-unique-expr, new-env, no_list, persistent-indexer, pthread-emulation, qualifiedEnum, resolv-new, with_gc

Children:

d6fb3c7

Parents:

bff607e

Message:

more explanation of storage management options

File:

• doc/user/user.tex (modified) (4 diffs)

doc/user/user.tex

@@ -11 +11 @@
 %% Created On       : Wed Apr  6 14:53:29 2016
 %% Last Modified By : Peter A. Buhr
-%% Last Modified On : Tue May 30 09:08:16 2017
-%% Update Count     : 2072
+%% Last Modified On : Tue May 30 11:42:47 2017
+%% Update Count     : 2097
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
@@ -5238 +5238 @@
 
 The storage-management routines extend their C equivalents by overloading, alternate names, providing shallow type-safety, and removing the need to specify the allocation size for non-array types.
+
+Storage management provides the following capabilities:
+\begin{description}
+\item[fill]
+after allocation the storage is or is not filled with a specified character.
+\item[resize]
+an existing allocation is decreased or increased in size.
+In either case, new storage may or may not be allocated and, if there is a new allocation, as much data from the existing allocation is copied.
+For an increase in storage size, new storage after the copied data may or may not be filled.
+\item[alignment]
+an allocation starts on a specified memory boundary, e.g., an address multiple of 64 or 128 for cache-line purposes.
+\item[array]
+the allocation size is scaled to the specified number of array elements.
+An array may or not be filled, resized, or aligned.
+\end{description}
+
+The following table show the allocation routines supporting different combinations of storage-management capabilities:
 \begin{center}
 \begin{tabular}{@{}r|l|l|l|l@{}}
@@ -5252 +5269 @@
 \end{tabular}
 \end{center}
-When ©amalloc© resizes and fills, the space after the copied data from the source is set to the fill character.
+% When ©amalloc© resizes and fills, the space after the copied data from the source is set to the fill character.
 It is impossible to resize with alignment because the underlying ©realloc© allocates storage if more space is needed, and it does not honour alignment from the original allocation.
 
@@ -5338 +5355 @@
 \begin{cfa}[aboveskip=0pt,belowskip=0pt]
 forall( otype T | { int ?<?( T, T ); } )        §\C{// location}§
-T * bsearch( T key, const T * arr, size_t dimension );§\indexc{bsearch}§
+T * bsearch( T key, const T * arr, size_t dim );§\indexc{bsearch}§
 
 forall( otype T | { int ?<?( T, T ); } )        §\C{// position}§
-unsigned int bsearch( T key, const T * arr, size_t dimension );
+unsigned int bsearch( T key, const T * arr, size_t dim );
 
 forall( otype T | { int ?<?( T, T ); } )
-void qsort( const T * arr, size_t dimension );§\indexc{qsort}§
+void qsort( const T * arr, size_t dim );§\indexc{qsort}§
 \end{cfa}