diff options
Diffstat (limited to 'doc/documentation.tex')
| -rw-r--r-- | doc/documentation.tex | 40 |
1 files changed, 23 insertions, 17 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex index b754047..28df841 100644 --- a/doc/documentation.tex +++ b/doc/documentation.tex @@ -75,9 +75,10 @@ Bits of the mask are allocated to a new type using the function: \indent\parbox{\linewidth}{ \vspace{\baselineskip}\noindent\texttt{ -int SpaceMask\_RegisterType(char* \emph{type\_name}, int \emph{nstates}, - char** \emph{state\_list}) -} +int SpaceMask\_RegisterType(const char* \emph{type\_name}, + \\\hspace*{10mm} + int \emph{nstates}, const char* const \emph{state\_list}[]) +}\\ \hspace*{10mm}\parbox{\linewidth}{ \begin{description} \item[\emph{type\_name}] The name of the new type to be registered; @@ -95,9 +96,10 @@ states can be added to an already allocated type using the function: \indent\parbox{\linewidth}{ \vspace{\baselineskip}\noindent\texttt{ - int SpaceMask\_AppendStatesToType(char* \emph{type\_name}, - int \emph{nstates}, char** \emph{state\_list}) -} +int SpaceMask\_AppendStatesToType(const char* \emph{type\_name}, + \\\hspace*{10mm} + int \emph{nstates}, const char* const \emph{state\_list}[]) +}\\ \hspace*{10mm}\parbox{\linewidth}{ \begin{description} \item[\emph{type\_name}] The name of an already registered type; @@ -118,8 +120,9 @@ The state of the mask at a given point is set using the function: \indent\parbox{\linewidth}{ \vspace{\baselineskip}\noindent\texttt{ void SpaceMask\_SetState(CCTK\_INT* \emph{mask}, int \emph{point}, - char* \emph{type\_name}, char* \emph{state}) -} + \\\hspace*{10mm} + const char* \emph{type\_name}, const char* \emph{state}) +}\\ \hspace*{10mm}\parbox{\linewidth}{ \begin{description} \item[\emph{mask}] A pointer to the mask grid function; @@ -134,9 +137,10 @@ The state of the mask at a given point can be checked using: \indent\parbox{\linewidth}{ \vspace{\baselineskip}\noindent\texttt{ -int SpaceMask\_CheckState(CCTK\_INT* \emph{mask}, int \emph{point}, - char* \emph{type\_name}, char* \emph{state}) -} +int SpaceMask\_CheckState(const CCTK\_INT* \emph{mask}, int \emph{point}, + \\\hspace*{10mm} + const char* \emph{type\_name}, const char* \emph{state}) +}\\ \hspace*{10mm}\parbox{\linewidth}{ \begin{description} \item[\emph{mask}] A pointer to the mask grid function; @@ -161,7 +165,7 @@ states need to be obtained using the following functions: \indent\parbox{\linewidth}{ \vspace{\baselineskip}\noindent\texttt{ -CCTK\_INT SpaceMask\_GetTypeBits(char* \emph{type\_name}) +CCTK\_INT SpaceMask\_GetTypeBits(const char* \emph{type\_name}) }\\ \hspace*{10mm}\parbox{\linewidth}{ \begin{description} @@ -172,8 +176,8 @@ CCTK\_INT SpaceMask\_GetTypeBits(char* \emph{type\_name}) \indent\parbox{\linewidth}{ \vspace{\baselineskip}\noindent\texttt{ -CCTK\_INT SpaceMask\_GetStateBits(char* \emph{type\_name}, - char* \emph{state\_name}) +CCTK\_INT SpaceMask\_GetStateBits(const char* \emph{type\_name}, + const char* \emph{state\_name}) } \hspace*{10mm}\parbox{\linewidth}{ \begin{description} @@ -195,7 +199,8 @@ of the mask by direct bitwise operations: \indent\parbox{\linewidth}{ \vspace{\baselineskip}\noindent\texttt{ void SpaceMask\_SetStateBits(CCTK\_INT* \emph{mask}, int \emph{point}, - CCTK\_INT \emph{type\_bits},\\\hspace*{10mm} CCTK\_INT \emph{state\_bits}) + \\\hspace*{10mm} + CCTK\_INT \emph{type\_bits}, CCTK\_INT \emph{state\_bits}) }\\ \hspace*{10mm}\parbox{\linewidth}{ \begin{description} @@ -211,8 +216,9 @@ void SpaceMask\_SetStateBits(CCTK\_INT* \emph{mask}, int \emph{point}, \indent\parbox{\linewidth}{ \vspace{\baselineskip}\noindent\texttt{ -int SpaceMask\_CheckStateBits(CCTK\_INT* \emph{mask}, int \emph{point}, - CCTK\_INT \emph{type\_bits},\\\hspace*{10mm} CCTK\_INT \emph{state\_bits}) +int SpaceMask\_CheckStateBits(const CCTK\_INT* \emph{mask}, int \emph{point}, + \\\hspace*{10mm} + CCTK\_INT \emph{type\_bits}, CCTK\_INT \emph{state\_bits}) }\\ \hspace*{10mm}\parbox{\linewidth}{ \begin{description} |