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 wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/comparison.txt	Wed Apr 30 10:06:55 2008 +0200
@@ -0,0 +1,23 @@
+
+Comparison protocols
+====================
+
+Two comparison protocols have been implemented in VIFF. They are
+available in the classes :class:`ComparisonToft05Mixin` and
+:class:`ComparisonToft07Mixin`. Both protocols have been designed by
+Tomas Toft.
+
+The classes are *mixin* classes which means that they are meant to be
+used ("mixed") with other classes to build a finished usable class.
+Two standard "flavors" are provided in the :class:`Toft05Runtime` and
+:class:`Toft07Runtime`.
+
+.. autoclass:: viff.comparison.ComparisonToft05Mixin
+   :members: greater_than_equal
+
+.. autoclass:: viff.comparison.Toft05Runtime
+
+.. autoclass:: viff.comparison.ComparisonToft07Mixin
+   :members: greater_than_equal
+
+.. autoclass:: viff.comparison.Toft07Runtime
--- a/doc/implementation.txt	Wed Apr 30 10:05:34 2008 +0200
+++ b/doc/implementation.txt	Wed Apr 30 10:06:55 2008 +0200
@@ -12,6 +12,7 @@
    shamir
    matrix
    runtime
+   comparison
    prss
    config
    program-counters