X-Git-Url: https://scm.cri.minesparis.psl.eu/git/linpy.git/blobdiff_plain/454a26a54cc7ff563ab278567f3bbad9c6ff42bb..a08ebc700e22f6aee8147cb5b5323a6c040b12db:/doc/geometry.rst?ds=sidebyside diff --git a/doc/geometry.rst b/doc/geometry.rst deleted file mode 100644 index 838ec6e..0000000 --- a/doc/geometry.rst +++ /dev/null @@ -1,79 +0,0 @@ -Geometry Module -=============== - -The geometry module is used to obtain information about the points and vertices of a ployhedra. - -.. py:class:: Points - -This class represents points in space. - - .. py:method:: isorigin(self) - - Return ``True`` if a point is the origin. - - .. py:method:: __eq__(self, other) - - Compare two Points for equality. - - .. py:method:: __add__(self, other) - - Add a Point to a Vector and return the result as a Point. - - .. py:method:: __sub__(self, other) - - Return the difference between two Points as a Vector. - - .. py:method:: aspolyhedon(self) - - Return a Point as a polyhedron corresponding to the Point, assuming the Point has integer coordinates. - - -.. py:class:: Vector - -This class represents displacements in space. - - .. py:method:: __eq__(self, other) - - Compare two Vectors for equality. - - .. py:method:: __add__(self, other) - - Add 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) - - Multiply a Vector by a scalar value and returns the result as a Vector. - - .. py:method:: __neg__(self) - - Negate 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 - pi. - - .. py:method:: cross(self, other) - - Calculate the cross product of two Vector3D structures. If the vectors are not tridimensional, a _____ error is raised. - - .. py:method:: dot(self, other) - - Calculate the dot product of two vectors. - - .. py:method:: __trudiv__(self, other) - - Divide the vector by the specified scalar and returns the result as a vector. -