viff

changeset 1238:199782817963

Added documentation for constants.py.
author Janus Dam Nielsen <janus.nielsen@alexandra.dk>
date Thu, 08 Oct 2009 11:51:56 +0200
parents 4b6f9e4db99e
children 61dfbce77505
files doc/constants.txt doc/implementation.txt doc/runtime.txt
diffstat 3 files changed, 25 insertions(+), 10 deletions(-) [+]
line diff
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/doc/constants.txt	Thu Oct 08 11:51:56 2009 +0200
     1.3 @@ -0,0 +1,24 @@
     1.4 +Constants Module
     1.5 +================
     1.6 +
     1.7 +.. automodule:: viff.constants
     1.8 +
     1.9 +   .. attribute:: SHARE
    1.10 +                  ECHO
    1.11 +                  READY
    1.12 +                  SEND
    1.13 +                  PAILLIER
    1.14 +                  TEXT
    1.15 +
    1.16 +      Constants used by :class:`ShareExchanger` and others when sending 
    1.17 +      shares and other messages. They serve to distinguish messages sent 
    1.18 +      with the same program counter from one another.
    1.19 +
    1.20 +   .. attribute::INCONSISTENTHASH
    1.21 +                  OK
    1.22 +                  HASH
    1.23 +                  SIGNAL
    1.24 +
    1.25 +      Constants used by :class:`HashBroadcastMixin` when sending shares
    1.26 +      and other messages. They serve to distinguish messages sent with
    1.27 +      the same program counter from one another.
     2.1 --- a/doc/implementation.txt	Wed Oct 07 12:03:06 2009 +0200
     2.2 +++ b/doc/implementation.txt	Thu Oct 08 11:51:56 2009 +0200
     2.3 @@ -19,3 +19,4 @@
     2.4     prss
     2.5     config
     2.6     aes
     2.7 +   constants
     3.1 --- a/doc/runtime.txt	Wed Oct 07 12:03:06 2009 +0200
     3.2 +++ b/doc/runtime.txt	Thu Oct 08 11:51:56 2009 +0200
     3.3 @@ -21,16 +21,6 @@
     3.4           or the data itself if data is received from the other player
     3.5           before we are ready to use it.
     3.6  
     3.7 -   .. attribute:: SHARE
     3.8 -                  ECHO
     3.9 -                  READY
    3.10 -                  SEND
    3.11 -                  PAILLIER
    3.12 -
    3.13 -      Constants used by :class:`ShareExchanger` when sending shares
    3.14 -      and other messages. They serve to distinguish messages sent with
    3.15 -      the same program counter from one another.
    3.16 -
    3.17     .. autofunction:: preprocess
    3.18  
    3.19        See also :ref:`preprocessing` for more background information.