changeset 1404:0504115641a3

doc: fix a ton of broken links
author Martin Geisler <mg@cs.au.dk>
date Thu, 10 Dec 2009 13:39:00 +0100
parents aa82aa9b79aa
children 1a1ff80f026c
files doc/bibliography.txt doc/comparison.txt doc/constants.txt doc/overview.txt doc/program-counters.txt doc/runtime.txt viff/comparison.py viff/orlandi.py viff/passive.py viff/runtime.py
diffstat 10 files changed, 76 insertions(+), 69 deletions(-) [+]
line wrap: on
line diff
--- a/doc/bibliography.txt	Thu Dec 10 13:21:18 2009 +0100
+++ b/doc/bibliography.txt	Thu Dec 10 13:39:00 2009 +0100
@@ -30,8 +30,8 @@
 
 * The pseudo-random secret sharing (PRSS) in ``viff.prss`` is
   described in [CDI05]_. The
-  :meth:`~viff.runtime.Runtime.prss_share_bit_double` method uses a
-  protocol described in [Damgård08]_.
+  :meth:`~viff.passive.PassiveRuntime.prss_share_bit_double` method
+  uses a protocol described in [Damgård08]_.
 
 * The protocol for equality testing with secret shared result is from
   [Nishide07]_.
--- a/doc/comparison.txt	Thu Dec 10 13:21:18 2009 +0100
+++ b/doc/comparison.txt	Thu Dec 10 13:39:00 2009 +0100
@@ -3,14 +3,16 @@
 ====================
 
 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.
+available in the classes
+:class:`~viff.comparison.ComparisonToft05Mixin` and
+:class:`~viff.comparison.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`.
+Two standard "flavors" are provided in the
+:class:`~viff.comparison.Toft05Runtime` and
+:class:`~viff.comparison.Toft07Runtime`.
 
 .. autoclass:: viff.comparison.ComparisonToft05Mixin
    :members: greater_than_equal
--- a/doc/constants.txt	Thu Dec 10 13:21:18 2009 +0100
+++ b/doc/constants.txt	Thu Dec 10 13:39:00 2009 +0100
@@ -10,15 +10,17 @@
                   PAILLIER
                   TEXT
 
-      Constants used by :class:`ShareExchanger` and others when sending 
-      shares and other messages. They serve to distinguish messages sent 
-      with the same program counter from one another.
+      Constants used by :class:`~viff.runtime.ShareExchanger` and
+      others when sending shares and other messages. They serve to
+      distinguish messages sent with the same program counter from one
+      another.
 
    .. attribute::INCONSISTENTHASH
                   OK
                   HASH
                   SIGNAL
 
-      Constants used by :class:`HashBroadcastMixin` when sending shares
-      and other messages. They serve to distinguish messages sent with
-      the same program counter from one another.
+      Constants used by
+      :class:`~viff.hash_broadcast.HashBroadcastMixin` when sending
+      shares and other messages. They serve to distinguish messages
+      sent with the same program counter from one another.
--- a/doc/overview.txt	Thu Dec 10 13:21:18 2009 +0100
+++ b/doc/overview.txt	Thu Dec 10 13:39:00 2009 +0100
@@ -71,15 +71,15 @@
 addition, multiplication, etc. These methods operate on :class:`Share
 <viff.runtime.Share>` instances.
 
-Shares hold either :class:`GFElement <viff.field.GF>` or :class:`GF256
-<viff.field.GF256>` elements and are created from the
-:meth:`shamir_share <viff.runtime.Runtime.shamir_share>` or
-:meth:`prss_share <viff.runtime.Runtime.prss_share>` :class:`Runtime
-<viff.runtime.Runtime>` methods. Shares overload the standard
+Shares hold either :class:`GFElement <viff.field.GF>` or
+:class:`~viff.field.GF256` elements and are created from the
+:meth:`~viff.passive.PassiveRuntime.shamir_share` or
+:meth:`~viff.passive.PassiveRuntime.prss_share`
+:class:`~viff.runtime.Runtime` methods. Shares overload the standard
 arithmetic operators, so you can write ``a + b - c * d`` with four
 shares, and it will be translated correctly into the appropriate
-method calls on the :class:`Runtime <viff.runtime.Runtime>` associated
-with the shares.
+method calls on the :class:`~viff.runtime.Runtime` associated with the
+shares.
 
 A field element contain the concrete value on which we do
 calculations. This is just a normal Python (long) integer. The value
--- a/doc/program-counters.txt	Thu Dec 10 13:21:18 2009 +0100
+++ b/doc/program-counters.txt	Thu Dec 10 13:39:00 2009 +0100
@@ -78,10 +78,10 @@
 The solution used now in VIFF has two ingredients. First, callbacks
 that depend on the program counter (like `func`:shamir_share in our
 example above) are not added with :meth:`addCallback` but instead with
-the special :meth:`~viff.runtime.BasicRuntime.schedule_callback`
-method. This method saves the program counter in effect at the time of
-the its call, and ensures that the saved program counter is
-temporarily made active when the callback is called.
+the special :meth:`~viff.runtime.Runtime.schedule_callback` method.
+This method saves the program counter in effect at the time of the its
+call, and ensures that the saved program counter is temporarily made
+active when the callback is called.
 
 Secondly, the program counter is a *list* of counters. This is
 necessary to ensure that we can allocate new fresh counters at any
@@ -92,12 +92,12 @@
 cases:
 
 * when a callback is scheduled using
-  :meth:`~viff.runtime.BasicRuntime.schedule_callback`, a new
-  sub-program counter is allocated. A sub-program counter is simply a
-  program counter with another digit. Because of the asynchronous
-  network, the callback will be invoked at an unknown later time. When
-  invoked, it sees the sub-program counter. This ensures that that the
-  parties agree on any network traffic produced in the callback.
+  :meth:`~viff.runtime.Runtime.schedule_callback`, a new sub-program
+  counter is allocated. A sub-program counter is simply a program
+  counter with another digit. Because of the asynchronous network, the
+  callback will be invoked at an unknown later time. When invoked, it
+  sees the sub-program counter. This ensures that that the parties
+  agree on any network traffic produced in the callback.
 
   When a piece of code like this::
 
--- a/doc/runtime.txt	Thu Dec 10 13:21:18 2009 +0100
+++ b/doc/runtime.txt	Thu Dec 10 13:39:00 2009 +0100
@@ -37,8 +37,9 @@
 
       .. attribute:: Runtime.threshold
 
-         Default threshold used by :meth:`Runtime.shamir_share`,
-         :meth:`Runtime.open`, and others.
+         Default threshold used by
+         :meth:`~viff.passive.PassiveRuntime.shamir_share`,
+         :meth:`~viff.passive.PassiveRuntime.open`, and others.
 
       .. attribute:: Runtime.program_counter
 
--- a/viff/comparison.py	Thu Dec 10 13:21:18 2009 +0100
+++ b/viff/comparison.py	Thu Dec 10 13:39:00 2009 +0100
@@ -16,8 +16,8 @@
 # License along with VIFF. If not, see <http://www.gnu.org/licenses/>.
 
 """Comparison protocols. The mixin classes defined here provide a
-:meth:`greater_than_equal` method to the :class:`Runtime
-<viff.runtime.Runtime>` they are mixed with.
+:meth:`greater_than_equal` method to the
+:class:`~viff.runtime.Runtime` they are mixed with.
 """
 
 import math
@@ -68,10 +68,10 @@
         """Compute ``share_a >= share_b``.
 
         Both arguments must be from the same field. The result is a
-        :class:`GF256 <viff.field.GF256>` share.
+        :class:`~viff.field.GF256` share.
 
         :warning:
-           The result type (:class:`viff.field.GF256`) is different
+           The result type (:class:`~viff.field.GF256`) is different
            from the argument types (general field elements).
 
         """
@@ -137,13 +137,13 @@
 
 
 class Toft05Runtime(ComparisonToft05Mixin, PassiveRuntime):
-    """Default mix of :class:`ComparisonToft05Mixin` and
-    :class:`Runtime <viff.runtime.Runtime>`."""
+    """Default mix of :class:`~viff.comparison.ComparisonToft05Mixin`
+    and :class:`~viff.passive.PassiveRuntime`."""
     pass
 
 class ActiveToft05Runtime(ComparisonToft05Mixin, ActiveRuntime):
-    """Default mix of :class:`ComparisonToft05Mixin` and
-    :class:`ActiveRuntime <viff.runtime.ActiveRuntime>`."""
+    """Default mix of :class:`~viff.comparison.ComparisonToft05Mixin`
+    and :class:`~viff.active.ActiveRuntime`."""
     pass
 
 
@@ -329,12 +329,12 @@
 
 
 class Toft07Runtime(ComparisonToft07Mixin, PassiveRuntime):
-    """Default mix of :class:`ComparisonToft07Mixin` and
-    :class:`Runtime <viff.runtime.Runtime>`.
+    """Default mix of :class:`~viff.comparison.ComparisonToft07Mixin`
+    and :class:`~viff.passive.PassiveRuntime`.
     """
     pass
 
 class ActiveToft07Runtime(ComparisonToft07Mixin, ActiveRuntime):
-    """Default mix of :class:`ComparisonToft07Mixin` and
-    :class:`ActiveRuntime <viff.runtime.ActiveRuntime>`."""
+    """Default mix of :class:`~viff.comparison.ComparisonToft07Mixin` and
+    :class:`~viff.active.ActiveRuntime`."""
     pass
--- a/viff/orlandi.py	Thu Dec 10 13:21:18 2009 +0100
+++ b/viff/orlandi.py	Thu Dec 10 13:39:00 2009 +0100
@@ -86,13 +86,14 @@
     possible to call :meth:`add`, :meth:`mul`, etc. directly if one
     prefers.
 
-    Each player in the protocol uses a :class:`Runtime` object. To
-    create an instance and connect it correctly with the other
-    players, please use the :func:`create_runtime` function instead of
-    instantiating a Runtime directly. The :func:`create_runtime`
-    function will take care of setting up network connections and
-    return a :class:`Deferred` which triggers with the
-    :class:`Runtime` object when it is ready.
+    Each player in the protocol uses a :class:`~viff.runtime.Runtime`
+    object. To create an instance and connect it correctly with the
+    other players, please use the :func:`~viff.runtime.create_runtime`
+    function instead of instantiating a Runtime directly. The
+    :func:`~viff.runtime.create_runtime` function will take care of
+    setting up network connections and return a :class:`Deferred`
+    which triggers with the :class:`~viff.runtime.Runtime` object when
+    it is ready.
     """
 
     def __init__(self, player, threshold=None, options=None):
--- a/viff/passive.py	Thu Dec 10 13:21:18 2009 +0100
+++ b/viff/passive.py	Thu Dec 10 13:39:00 2009 +0100
@@ -34,19 +34,20 @@
     """The VIFF runtime.
 
     The runtime is used for sharing values (:meth:`shamir_share` or
-    :meth:`prss_share`) into :class:`Share` object and opening such
-    shares (:meth:`open`) again. Calculations on shares is normally
-    done through overloaded arithmetic operations, but it is also
-    possible to call :meth:`add`, :meth:`mul`, etc. directly if one
-    prefers.
+    :meth:`prss_share`) into :class:`~viff.runtime.Share` object and
+    opening such shares (:meth:`open`) again. Calculations on shares
+    is normally done through overloaded arithmetic operations, but it
+    is also possible to call :meth:`add`, :meth:`mul`, etc. directly
+    if one prefers.
 
-    Each player in the protocol uses a :class:`Runtime` object. To
-    create an instance and connect it correctly with the other
-    players, please use the :func:`create_runtime` function instead of
-    instantiating a Runtime directly. The :func:`create_runtime`
-    function will take care of setting up network connections and
-    return a :class:`Deferred` which triggers with the
-    :class:`Runtime` object when it is ready.
+    Each player in the protocol uses a :class:`~viff.runtime.Runtime`
+    object. To create an instance and connect it correctly with the
+    other players, please use the :func:`~viff.runtime.create_runtime`
+    function instead of instantiating a :class:`~viff.runtime.Runtime`
+    directly. The :func:`~viff.runtime.create_runtime` function will
+    take care of setting up network connections and return a
+    :class:`Deferred` which triggers with the
+    :class:`~viff.runtime.Runtime` object when it is ready.
     """
 
     def __init__(self, player, threshold, options=None):
--- a/viff/runtime.py	Thu Dec 10 13:21:18 2009 +0100
+++ b/viff/runtime.py	Thu Dec 10 13:39:00 2009 +0100
@@ -800,8 +800,8 @@
           list of Deferreds. Use :meth:`gatherResults` to avoid the
           latter.
 
-        The :meth:`ActiveRuntime.generate_triples` method is an
-        example of a method fulfilling this interface.
+        The :meth:`~viff.active.TriplesPRSSMixin.generate_triples` method
+        is an example of a method fulfilling this interface.
         """
 
         def update(results, program_counters):
@@ -853,16 +853,16 @@
         """Secure addition.
         
         At least one of the arguments must be a :class:`Share`, the
-        other can be a :class:`FieldElement` or a (possible long)
-        Python integer."""
+        other can be a :class:`~viff.field.FieldElement` or a
+        (possible long) Python integer."""
         raise NotImplementedError
 
     def mul(self, share_a, share_b):
         """Secure multiplication.
         
         At least one of the arguments must be a :class:`Share`, the
-        other can be a :class:`FieldElement` or a (possible long)
-        Python integer."""
+        other can be a :class:`~viff.field.FieldElement` or a
+        (possible long) Python integer."""
         raise NotImplementedError
 
     def handle_deferred_data(self, deferred, data):