libbg1-doc 1.106-1 / usr / share / doc / libbg1-doc / latex / group__adt.tex

This file is indexed.

/usr/share/doc/libbg1-doc/latex/group__adt.tex is in libbg1-doc 1.106-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
\hypertarget{group__adt}{
\section{adt: Abstract Data Types.}
\label{group__adt}\index{adt: Abstract Data Types.@{adt: Abstract Data Types.}}
}
\subsection*{Typedefs}
\begin{CompactItemize}
\item 
typedef unsigned long \hyperlink{group__adt_gab1a0335d8d46afee323cf2b3d132145}{adt\_\-hash\_\-t}
\item 
typedef void \hyperlink{group__adt_g87ba7ca9dce36c22fe75a730a1d768a9}{adt\_\-free\_\-fn} (void $\ast$)
\item 
typedef int \hyperlink{group__adt_ga98f7f3499407a5dc1afdcbb20df2e15}{adt\_\-copy\_\-fn} (void $\ast$, const void $\ast$)
\item 
typedef int \hyperlink{group__adt_g03ed35b7331128b069dc77ab33798782}{adt\_\-cmp\_\-fn} (const void $\ast$, const void $\ast$)
\item 
typedef \hyperlink{group__adt_gab1a0335d8d46afee323cf2b3d132145}{adt\_\-hash\_\-t} \hyperlink{group__adt_gd6ce53fbc11dbf67ca1c126cd17ee81a}{adt\_\-hash\_\-fn} (const void $\ast$)
\end{CompactItemize}
\subsection*{Functions}
\begin{CompactItemize}
\item 
\hyperlink{group__adt_gab1a0335d8d46afee323cf2b3d132145}{adt\_\-hash\_\-t} \hyperlink{group__adt_gd9ce9e50c1be3b099d94315960807237}{adt\_\-hashb} (const unsigned char $\ast$, unsigned long)
\item 
\hyperlink{group__adt_gab1a0335d8d46afee323cf2b3d132145}{adt\_\-hash\_\-t} \hyperlink{group__adt_g9b98c9ab4f62ccca61ad6903a0ebd798}{adt\_\-hashs} (const unsigned char $\ast$)
\item 
\hyperlink{group__adt_gab1a0335d8d46afee323cf2b3d132145}{adt\_\-hash\_\-t} \hyperlink{group__adt_g7e68b73378693c9b0945a11f849f3063}{adt\_\-hashsp} (const char $\ast$const $\ast$)
\item 
int \hyperlink{group__adt_g84ea1556ed78318147cfc5d9a6674e13}{adt\_\-cmpsp} (const char $\ast$const $\ast$a, const char $\ast$const $\ast$b)
\item 
int \hyperlink{group__adt_g6fa5c9c6df55cb8f4b73cfede896ed66}{adt\_\-copysp} (const char $\ast$$\ast$a, const char $\ast$const $\ast$b)
\item 
void \hyperlink{group__adt_g28e2128b21e2a458f09423111ade4595}{adt\_\-freesp} (const char $\ast$$\ast$a)
\end{CompactItemize}


\subsection{Detailed Description}


\subsection{Typedef Documentation}
\hypertarget{group__adt_g03ed35b7331128b069dc77ab33798782}{
\index{adt@{adt}!adt\_\-cmp\_\-fn@{adt\_\-cmp\_\-fn}}
\index{adt\_\-cmp\_\-fn@{adt\_\-cmp\_\-fn}!adt@{adt}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef int {\bf adt\_\-cmp\_\-fn}(const void $\ast$, const void $\ast$)}}
\label{group__adt_g03ed35b7331128b069dc77ab33798782}


A function prototype for comparing two items. Such functions must return zero if the two items are identical, positive if the first is larger, and negative if the first is smaller. \hypertarget{group__adt_ga98f7f3499407a5dc1afdcbb20df2e15}{
\index{adt@{adt}!adt\_\-copy\_\-fn@{adt\_\-copy\_\-fn}}
\index{adt\_\-copy\_\-fn@{adt\_\-copy\_\-fn}!adt@{adt}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef int {\bf adt\_\-copy\_\-fn}(void $\ast$, const void $\ast$)}}
\label{group__adt_ga98f7f3499407a5dc1afdcbb20df2e15}


A function prototype for copying something. The function is expected to return false (zero) if the copy failed for any reason (ie could not allocate memory). \hypertarget{group__adt_g87ba7ca9dce36c22fe75a730a1d768a9}{
\index{adt@{adt}!adt\_\-free\_\-fn@{adt\_\-free\_\-fn}}
\index{adt\_\-free\_\-fn@{adt\_\-free\_\-fn}!adt@{adt}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef void {\bf adt\_\-free\_\-fn}(void $\ast$)}}
\label{group__adt_g87ba7ca9dce36c22fe75a730a1d768a9}


A function prototype used for freeing something. \hypertarget{group__adt_gd6ce53fbc11dbf67ca1c126cd17ee81a}{
\index{adt@{adt}!adt\_\-hash\_\-fn@{adt\_\-hash\_\-fn}}
\index{adt\_\-hash\_\-fn@{adt\_\-hash\_\-fn}!adt@{adt}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef {\bf adt\_\-hash\_\-t} {\bf adt\_\-hash\_\-fn}(const void $\ast$)}}
\label{group__adt_gd6ce53fbc11dbf67ca1c126cd17ee81a}


A function prototype for hasing an item (typically a key). \hypertarget{group__adt_gab1a0335d8d46afee323cf2b3d132145}{
\index{adt@{adt}!adt\_\-hash\_\-t@{adt\_\-hash\_\-t}}
\index{adt\_\-hash\_\-t@{adt\_\-hash\_\-t}!adt@{adt}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef unsigned long {\bf adt\_\-hash\_\-t}}}
\label{group__adt_gab1a0335d8d46afee323cf2b3d132145}


The hash value type. All hash functions must output a value of this type, and all functions that use a hash store it in this type. 

\subsection{Function Documentation}
\hypertarget{group__adt_g84ea1556ed78318147cfc5d9a6674e13}{
\index{adt@{adt}!adt\_\-cmpsp@{adt\_\-cmpsp}}
\index{adt\_\-cmpsp@{adt\_\-cmpsp}!adt@{adt}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int adt\_\-cmpsp (const char $\ast$const $\ast$ {\em a}, const char $\ast$const $\ast$ {\em b})}}
\label{group__adt_g84ea1556ed78318147cfc5d9a6674e13}


A sample function for comparing two C string pointers. \hypertarget{group__adt_g6fa5c9c6df55cb8f4b73cfede896ed66}{
\index{adt@{adt}!adt\_\-copysp@{adt\_\-copysp}}
\index{adt\_\-copysp@{adt\_\-copysp}!adt@{adt}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int adt\_\-copysp (const char $\ast$$\ast$ {\em a}, const char $\ast$const $\ast$ {\em b})}}
\label{group__adt_g6fa5c9c6df55cb8f4b73cfede896ed66}


A sample function for copying a C string pointer. \hypertarget{group__adt_g28e2128b21e2a458f09423111ade4595}{
\index{adt@{adt}!adt\_\-freesp@{adt\_\-freesp}}
\index{adt\_\-freesp@{adt\_\-freesp}!adt@{adt}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void adt\_\-freesp (const char $\ast$$\ast$ {\em a})}}
\label{group__adt_g28e2128b21e2a458f09423111ade4595}


A sample function for freeing a C string pointer. \hypertarget{group__adt_gd9ce9e50c1be3b099d94315960807237}{
\index{adt@{adt}!adt\_\-hashb@{adt\_\-hashb}}
\index{adt\_\-hashb@{adt\_\-hashb}!adt@{adt}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf adt\_\-hash\_\-t} adt\_\-hashb (const unsigned char $\ast$, unsigned {\em long})}}
\label{group__adt_gd9ce9e50c1be3b099d94315960807237}


A sample function for hasing a block of memory. \hypertarget{group__adt_g9b98c9ab4f62ccca61ad6903a0ebd798}{
\index{adt@{adt}!adt\_\-hashs@{adt\_\-hashs}}
\index{adt\_\-hashs@{adt\_\-hashs}!adt@{adt}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf adt\_\-hash\_\-t} adt\_\-hashs (const unsigned char $\ast$)}}
\label{group__adt_g9b98c9ab4f62ccca61ad6903a0ebd798}


A sample function for hashing a C string. \hypertarget{group__adt_g7e68b73378693c9b0945a11f849f3063}{
\index{adt@{adt}!adt\_\-hashsp@{adt\_\-hashsp}}
\index{adt\_\-hashsp@{adt\_\-hashsp}!adt@{adt}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf adt\_\-hash\_\-t} adt\_\-hashsp (const char $\ast$const $\ast$)}}
\label{group__adt_g7e68b73378693c9b0945a11f849f3063}


A sample function for hashing a C string pointer.

APT Browse - Built by Thomas Orozco.