viff

changeset 732:44d6ac417bca

Fixed indention and collapsed automethod directives.
author Martin Geisler <mg@daimi.au.dk>
date Thu, 24 Apr 2008 14:52:16 +0200
parents e5c8d22434d4
children 1f206d21e988
files doc/field.txt
diffstat 1 files changed, 11 insertions(+), 30 deletions(-) [+]
line diff
     1.1 --- a/doc/field.txt	Thu Apr 24 14:47:49 2008 +0200
     1.2 +++ b/doc/field.txt	Thu Apr 24 14:52:16 2008 +0200
     1.3 @@ -4,39 +4,20 @@
     1.4  
     1.5  .. automodule:: viff.field
     1.6  
     1.7 -.. autoclass:: viff.field.FieldElement
     1.8 +   .. autoclass:: FieldElement
     1.9  
    1.10 -.. autoclass:: viff.field.GF256
    1.11 +   .. autoclass:: GF256
    1.12 +      :members: __add__, __mul__, __pow__, __div__, __neg__, __invert__, __eq__, __nonzero__
    1.13  
    1.14 -   .. attribute:: GF256.modulus
    1.15 +      .. attribute:: GF256.modulus
    1.16  
    1.17 -      Field modulus, always 256.
    1.18 +         Field modulus, always 256.
    1.19  
    1.20 -   .. automethod:: GF256.__add__
    1.21 +      .. method:: GF256.__sub__(other)
    1.22 +                  GF256.__xor__(other)
    1.23  
    1.24 -   .. method:: GF256.__sub__(other)
    1.25 -               GF256.__xor__(other)
    1.26 +         Subtraction and exclusive-or. Since GF(2^8) has
    1.27 +         characteristic 2, these two operations are identical to
    1.28 +         addition.
    1.29  
    1.30 -      Subtraction and exclusive-or. Since GF(2^8) has characteristic
    1.31 -      2, these two operations are identical to addition.
    1.32 -
    1.33 -   .. automethod:: GF256.__mul__
    1.34 -
    1.35 -   .. automethod:: GF256.__pow__
    1.36 -
    1.37 -   .. automethod:: GF256.__div__
    1.38 -
    1.39 -   .. automethod:: GF256.__neg__
    1.40 -
    1.41 -   .. automethod:: GF256.__invert__
    1.42 -
    1.43 -   .. automethod:: GF256.__str__
    1.44 -
    1.45 -   .. automethod:: GF256.__eq__
    1.46 -
    1.47 -   .. automethod:: GF256.__hash__
    1.48 -
    1.49 -   .. automethod:: GF256.__nonzero__
    1.50 -
    1.51 -
    1.52 -.. autofunction:: viff.field.GF
    1.53 +   .. autofunction:: GF