aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/cpp/unsignedint.rst
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-06-11 19:25:29 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2011-06-11 20:05:33 -0400
commit0c2b3c667bf157dc2344e3dbc2aae0e11e37387b (patch)
tree3008ee192c80f17f640ebdeb870442e78415ce6b /docs/source/lang/cpp/unsignedint.rst
parentd4b576fcadecf66b7b754af7d204bb6f3b4a9830 (diff)
downloadlibrambutan-0c2b3c667bf157dc2344e3dbc2aae0e11e37387b.tar.gz
librambutan-0c2b3c667bf157dc2344e3dbc2aae0e11e37387b.zip
Remove reST documentation, attendant updates.
The documentation covers topics not specifically relevant to libmaple, so it doesn't make sense for it to be part of the libmaple source distribution. Delete the docs/ tree, and prepare libmaple for use with the new leaflabs-docs repo, which will contain the docs from now on. * README: update to reflect this change * support/doxygen/Doxyfile: This is the old docs/Doxyfile * Makefile: Add a doxygen target * wirish/comm/HardwareSerial.h: fix reference to docs/. The comment informing maintainers that the HardwareSerial interface is documented by hand refers to the docs/ tree, which no longer exists. Update it to refer to the separate leaflabs-docs repository. * support/scripts/copy-to-ide: No longer build the documentation
Diffstat (limited to 'docs/source/lang/cpp/unsignedint.rst')
-rw-r--r--docs/source/lang/cpp/unsignedint.rst59
1 files changed, 0 insertions, 59 deletions
diff --git a/docs/source/lang/cpp/unsignedint.rst b/docs/source/lang/cpp/unsignedint.rst
deleted file mode 100644
index f8ea473..0000000
--- a/docs/source/lang/cpp/unsignedint.rst
+++ /dev/null
@@ -1,59 +0,0 @@
-.. highlight:: cpp
-
-.. _lang-unsignedint:
-
-``unsigned int``
-================
-
-An ``unsigned int`` (unsigned integer) is the same as an :ref:`int
-<lang-int>` in that it stores a 4 byte integer value. However,
-Instead of storing both negative and positive numbers, an ``unsigned
-int`` can only store nonnegative values, yielding a range of 0 to
-4,294,967,295 (the positive value is 2^32 - 1).
-
-The difference between an ``unsigned int`` and a (signed) ``int`` lies
-in the way the highest bit, sometimes referred to as the "sign" bit,
-is interpreted. In the case of the Maple ``int`` type (which is
-signed), if the high bit is a "1", the number is interpreted as a
-negative number, using a technique known as `two's complement math
-<http://en.wikipedia.org/wiki/Two%27s_complement#Explanation>`_. The
-bits in an an ``unsigned int`` are interpreted according to the usual
-rules for converting `binary to decimal
-<http://en.wikipedia.org/wiki/Binary_numeral_system#Counting_in_binary>`_.
-
-An ``unsigned int`` is subject to the same :ref:`overflow issues
-<lang-int-overflow>` as a regular ``int``; the only difference is
-that an ``unsigned int`` will "underflow" at 0, and "overflow" at
-4,294,967,295. Here is some example code which illustrates this::
-
- unsigned int x;
- x = 0;
- x--; // x now contains 4,294,967,295; rolled over "left to right"
- x++; // x now contains 0; rolled over "right to left"
-
-.. _lang-unsignedlong:
-
-The ``unsigned long`` type is a synonym for ``unsigned int``.
-
-Here is an example of declaring an ``unsigned int`` variable named
-``pin``, then giving it value 13::
-
- unsigned int pin = 13;
-
-The general syntax for declaring an ``unsigned int`` variable named
-``var``, then giving it value ``val``, looks like::
-
- unsigned int var = val;
-
-See Also
---------
-
-- :ref:`int <lang-int>`
-- :ref:`char <lang-char>`
-- :ref:`unsigned char <lang-unsignedchar>`
-- :ref:`long long <lang-longlong>`
-- :ref:`unsigned long long <lang-unsignedlonglong>`
-- :ref:`Integer Constants <lang-constants-integers>`
-- :ref:`Variables <lang-variables>`
-
-.. include:: /arduino-cc-attribution.txt