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 wrap: on
line diff
--- a/viff/__init__.py	Thu Nov 06 14:57:50 2008 +0100
+++ b/viff/__init__.py	Thu Nov 06 15:03:17 2008 +0100
@@ -77,18 +77,20 @@
 Architecture
 ============
 
-VIFF consists of several modules. The L{runtime} module contains the
-L{Runtime} and L{Share} classes, in which the main functionality is
-implemented. The L{field} module contains implementations of finite
-fields --- these are the values inside the shares. Other modules
-provide support functions.
+VIFF consists of several modules. The L{passive} and L{active} modules
+contain the L{PassiveRuntime} and L{ActiveRuntime} classes in which
+the main functionality is implemented. The L{runtime} module contain
+the L{Share} class and other infrastructure for the two runtime
+classes. The L{field} module contains implementations of finite fields
+--- these are the values inside the shares. Other modules provide
+support functions.
 
 Layers
 ------
 
-The main functionality in VIFF is implemented in the L{Runtime} class.
-This class offers methods to do addition, multiplication, etc. These
-methods operate on L{Share} instances.
+The main functionality in VIFF is implemented in the L{PassiveRuntime}
+class. This class offers methods to do addition, multiplication, etc.
+These methods operate on L{Share} instances.
 
 Shares hold either L{field.GF} or L{GF256} elements and are created
 from the C{shamir_share} or C{prss_share} Runtime methods. Shares
@@ -116,9 +118,10 @@
 Getting into VIFF
 =================
 
-As explained above, the main functionality in VIFF is the L{Runtime}
-class, so please start there. Also, be sure to checkout the example
-applications distributed in the C{apps} directory.
+As explained above, the main functionality in VIFF is the
+L{PassiveRuntime} class, so please start there. Also, be sure to
+checkout the example applications distributed in the C{apps}
+directory.
 
 @authors: U{VIFF Development Team <mailto:viff-devel@viff.dk>}
 @see: U{http://viff.dk/}