X-Git-Url: https://scm.cri.ensmp.fr/git/linpy.git/blobdiff_plain/25ce908cffca380f930182a77c1e5a4491042a1c..7b93cea1daf2889e9ee10ca9c22a1b5124404937:/doc/geometry.rst
diff --git a/doc/geometry.rst b/doc/geometry.rst
index 224fb3a..0058ee9 100644
--- a/doc/geometry.rst
+++ b/doc/geometry.rst
@@ -9,18 +9,60 @@ This class represents points in space.
.. py:method:: isorigin(self)
- Return true is given point is the origin.
+ Return ``True`` if a point is the origin.
- .. py:method::
+ .. py:method:: __eq__(self, other)
+
+ Compares two Points for equality.
+
+ .. py:method:: __add__(self, other)
+
+ Adds a Point to a Vector and returns the result as a Point.
+
+ .. py:method:: __sub__(self, other)
+
+ Returns the difference between two Points as a Vector.
+ .. py:method:: aspolyhedon(self)
+
+ Returns a Point as a polyhedron.
+
+
.. py:class:: Vector
-This class represents displacements in space.
+This class represents displacements in space.
+ .. py:method:: __eq__(self, other)
+
+ Compares two Vectors for equality.
+
+ .. py:method:: __add__(self, other)
+
+ Adds either a Point or Vector to a Vector. The resulting sum is returned as the same structure *other* is.
+
+ .. py:method:: __sub__(self, other)
+
+ Subtract a Point or Vector from a Vector. The resulting difference is returned in the same form as *other*.
+
+ .. py:method:: __mul__(self, other)
+
+ Multiples a Vector by a scalar value and returns the result as a Vector.
+
+ .. py:method:: __neg__(self)
+
+ Negates a Vector.
+
+ .. py:method:: norm(self)
+
+ Normalizes a Vector.
+
+ .. py:method:: isnull(self)
+
+ Tests whether a Vector is null.
+
.. py:method:: angle(self, other)
- Retrieve the angle required to rotate the vector into the vector passed
- in argument. The result is an angle in radians, ranging between -pi and
+ Retrieve the angle required to rotate the vector into the vector passed in argument. The result is an angle in radians, ranging between -pi and
pi.
.. py:method:: cross(self, other)
@@ -33,6 +75,5 @@ This class represents displacements in space.
.. py:method:: __trudiv__(self, other)
- Divide the vector by the specified scalar and returns the result as a
- vector.
+ Divide the vector by the specified scalar and returns the result as a vector.