From c2052f3353f5b41bc7288313cf70a3b8fed659ae Mon Sep 17 00:00:00 2001 From: schnetter Date: Wed, 15 Jul 2009 21:08:52 +0000 Subject: Correct description of return values git-svn-id: http://svn.cactuscode.org/arrangements/CactusNumerical/SpaceMask/trunk@64 a491c6a4-70bf-4b89-8b36-d6c0cb1f094e --- doc/documentation.tex | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/documentation.tex b/doc/documentation.tex index c616bbd..7a137f9 100644 --- a/doc/documentation.tex +++ b/doc/documentation.tex @@ -206,7 +206,8 @@ bitmask corresponding to the given type or state. For example, if a given type uses three bits of the mask, the returned value could be the integer corresponding to the bitfield $001110000$\ldots, where the location of $1$s indicates the bits which have been allocated to the -given type. A return value of $0$ indicates that the bitmask could +given type. A return value of $0$ (GetTypeBits) or $-1$ (GetStateBits) +indicates that the bitmask could not be determined for some reason (for example, the requested state was not previously registered). -- cgit v1.2.3