Documentation for v0.1 version (#199)

* Adding Equations, solving typos
* improve _code.rst
* the team rst and restuctore index.rst
* fixing errors

---------

Co-authored-by: Dario Coscia <dariocoscia@dhcp-015.eduroam.sissa.it>
This commit is contained in:
Dario Coscia
2023-11-08 14:39:00 +01:00
committed by Nicola Demo
parent 3f9305d475
commit 8b7b61b3bd
144 changed files with 2741 additions and 1766 deletions

View File

@@ -8,6 +8,7 @@ class Location(metaclass=ABCMeta):
Abstract Location class.
Any geometry entity should inherit from this class.
"""
@abstractmethod
def sample(self):
"""
@@ -22,9 +23,9 @@ class Location(metaclass=ABCMeta):
Abstract method for checking if a point is inside the location. To be
implemented in the child class.
:param tensor point: A tensor point to be checked.
:param bool check_border: a boolean that determines whether the border
:param torch.Tensor point: A tensor point to be checked.
:param bool check_border: A boolean that determines whether the border
of the location is considered checked to be considered inside or
not. Defaults to False.
not. Defaults to ``False``.
"""
pass