viff

changeset 744:e0f9090cf95c

Added viff.comparison to the documentation.
author Martin Geisler <mg@daimi.au.dk>
date Wed, 30 Apr 2008 10:06:55 +0200
parents 57ce422feb55
children eae84e78682e
files doc/comparison.txt doc/implementation.txt
diffstat 2 files changed, 24 insertions(+), 0 deletions(-) [+]
line diff
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/doc/comparison.txt	Wed Apr 30 10:06:55 2008 +0200
     1.3 @@ -0,0 +1,23 @@
     1.4 +
     1.5 +Comparison protocols
     1.6 +====================
     1.7 +
     1.8 +Two comparison protocols have been implemented in VIFF. They are
     1.9 +available in the classes :class:`ComparisonToft05Mixin` and
    1.10 +:class:`ComparisonToft07Mixin`. Both protocols have been designed by
    1.11 +Tomas Toft.
    1.12 +
    1.13 +The classes are *mixin* classes which means that they are meant to be
    1.14 +used ("mixed") with other classes to build a finished usable class.
    1.15 +Two standard "flavors" are provided in the :class:`Toft05Runtime` and
    1.16 +:class:`Toft07Runtime`.
    1.17 +
    1.18 +.. autoclass:: viff.comparison.ComparisonToft05Mixin
    1.19 +   :members: greater_than_equal
    1.20 +
    1.21 +.. autoclass:: viff.comparison.Toft05Runtime
    1.22 +
    1.23 +.. autoclass:: viff.comparison.ComparisonToft07Mixin
    1.24 +   :members: greater_than_equal
    1.25 +
    1.26 +.. autoclass:: viff.comparison.Toft07Runtime
     2.1 --- a/doc/implementation.txt	Wed Apr 30 10:05:34 2008 +0200
     2.2 +++ b/doc/implementation.txt	Wed Apr 30 10:06:55 2008 +0200
     2.3 @@ -12,6 +12,7 @@
     2.4     shamir
     2.5     matrix
     2.6     runtime
     2.7 +   comparison
     2.8     prss
     2.9     config
    2.10     program-counters