viff

changeset 1016:f02fd7888c44

Cleanup epydoc.
author Martin Geisler <mg@daimi.au.dk>
date Thu, 06 Nov 2008 15:03:17 +0100
parents aa37357b63aa
children ed614874c220
files viff/__init__.py
diffstat 1 files changed, 14 insertions(+), 11 deletions(-) [+]
line diff
     1.1 --- a/viff/__init__.py	Thu Nov 06 14:57:50 2008 +0100
     1.2 +++ b/viff/__init__.py	Thu Nov 06 15:03:17 2008 +0100
     1.3 @@ -77,18 +77,20 @@
     1.4  Architecture
     1.5  ============
     1.6  
     1.7 -VIFF consists of several modules. The L{runtime} module contains the
     1.8 -L{Runtime} and L{Share} classes, in which the main functionality is
     1.9 -implemented. The L{field} module contains implementations of finite
    1.10 -fields --- these are the values inside the shares. Other modules
    1.11 -provide support functions.
    1.12 +VIFF consists of several modules. The L{passive} and L{active} modules
    1.13 +contain the L{PassiveRuntime} and L{ActiveRuntime} classes in which
    1.14 +the main functionality is implemented. The L{runtime} module contain
    1.15 +the L{Share} class and other infrastructure for the two runtime
    1.16 +classes. The L{field} module contains implementations of finite fields
    1.17 +--- these are the values inside the shares. Other modules provide
    1.18 +support functions.
    1.19  
    1.20  Layers
    1.21  ------
    1.22  
    1.23 -The main functionality in VIFF is implemented in the L{Runtime} class.
    1.24 -This class offers methods to do addition, multiplication, etc. These
    1.25 -methods operate on L{Share} instances.
    1.26 +The main functionality in VIFF is implemented in the L{PassiveRuntime}
    1.27 +class. This class offers methods to do addition, multiplication, etc.
    1.28 +These methods operate on L{Share} instances.
    1.29  
    1.30  Shares hold either L{field.GF} or L{GF256} elements and are created
    1.31  from the C{shamir_share} or C{prss_share} Runtime methods. Shares
    1.32 @@ -116,9 +118,10 @@
    1.33  Getting into VIFF
    1.34  =================
    1.35  
    1.36 -As explained above, the main functionality in VIFF is the L{Runtime}
    1.37 -class, so please start there. Also, be sure to checkout the example
    1.38 -applications distributed in the C{apps} directory.
    1.39 +As explained above, the main functionality in VIFF is the
    1.40 +L{PassiveRuntime} class, so please start there. Also, be sure to
    1.41 +checkout the example applications distributed in the C{apps}
    1.42 +directory.
    1.43  
    1.44  @authors: U{VIFF Development Team <mailto:viff-devel@viff.dk>}
    1.45  @see: U{http://viff.dk/}