viff

changeset 797:671ae0aec2ff

Comment touch ups.
author Martin Geisler <mg@daimi.au.dk>
date Wed, 28 May 2008 09:35:01 +0200
parents 73af810f6bb1
children 89f2dd066756
files viff/comparison.py
diffstat 1 files changed, 5 insertions(+), 5 deletions(-) [+]
line diff
     1.1 --- a/viff/comparison.py	Wed May 28 09:30:07 2008 +0200
     1.2 +++ b/viff/comparison.py	Wed May 28 09:35:01 2008 +0200
     1.3 @@ -160,7 +160,7 @@
     1.4  
     1.5      @increment_pc
     1.6      def convert_bit_share(self, share, dst_field):
     1.7 -        """Convert a 0/1 share into dst_field."""
     1.8 +        """Convert a 0/1 share into *dst_field*."""
     1.9          l = self.options.security_parameter + math.log(dst_field.modulus, 2)
    1.10          # TODO assert field sizes are OK...
    1.11  
    1.12 @@ -187,7 +187,7 @@
    1.13  
    1.14      @increment_pc
    1.15      def greater_than_equal_preproc(self, field, smallField=None):
    1.16 -        """Preprocessing for greater_than_equal."""
    1.17 +        """Preprocessing for :meth:`greater_than_equal`."""
    1.18          if smallField is None:
    1.19              smallField = field
    1.20  
    1.21 @@ -241,7 +241,7 @@
    1.22  
    1.23      @increment_pc
    1.24      def greater_than_equal_online(self, share_a, share_b, preproc, field):
    1.25 -        """Compute ``share_a >= share_b``. Result is shared."""
    1.26 +        """Compute ``share_a >= share_b``. Result is secret shared."""
    1.27          # increment l as a, b are increased
    1.28          l = self.options.bit_length + 1
    1.29          # a = 2a+1; b= 2b // ensures inputs not equal
    1.30 @@ -316,8 +316,8 @@
    1.31      def greater_than_equal(self, share_a, share_b):
    1.32          """Compute ``share_a >= share_b``.
    1.33  
    1.34 -        Both arguments must be of type field. The result is a
    1.35 -        field share.
    1.36 +        Both arguments must be shares from the same field. The result
    1.37 +        is a new 0/1 share from the field.
    1.38          """
    1.39          # TODO: Make all input-taking methods do coercion like this.
    1.40          field = getattr(share_a, "field", getattr(share_b, "field", None))