fix rendering part 1
This commit is contained in:
@@ -23,11 +23,11 @@ class Difference(OperationInterface):
|
||||
Initialization of the :class:`Difference` class.
|
||||
|
||||
:param list[DomainInterface] geometries: A list of instances of the
|
||||
:class:`~pina.domain.DomainInterface` class on which the difference
|
||||
operation is performed. The first domain in the list serves as the
|
||||
base from which points are sampled, while the remaining domains
|
||||
define the regions to be excluded from the base domain to compute
|
||||
the difference.
|
||||
:class:`~pina.domain.domain_interface.DomainInterface` class on
|
||||
which the difference operation is performed. The first domain in the
|
||||
list serves as the base from which points are sampled, while the
|
||||
remaining domains define the regions to be excluded from the base
|
||||
domain to compute the difference.
|
||||
|
||||
:Example:
|
||||
>>> # Create two ellipsoid domains
|
||||
|
||||
@@ -26,14 +26,14 @@ class EllipsoidDomain(DomainInterface):
|
||||
.. warning::
|
||||
Sampling for dimensions greater or equal to 10 could result in a
|
||||
shrinkage of the ellipsoid, which degrades the quality of the
|
||||
samples. For dimensions higher than 10, use other sampling
|
||||
algorithms.
|
||||
.. seealso::
|
||||
**Original reference**: Dezert, Jean, and Musso, Christian.
|
||||
*An efficient method for generating points uniformly distributed
|
||||
in hyperellipsoids.*
|
||||
Proceedings of the Workshop on Estimation, Tracking and Fusion:
|
||||
A Tribute to Yaakov Bar-Shalom. 2001.
|
||||
samples. For dimensions higher than 10, see the following reference.
|
||||
|
||||
.. seealso::
|
||||
**Original reference**: Dezert, Jean, and Musso, Christian.
|
||||
*An efficient method for generating points uniformly distributed
|
||||
in hyperellipsoids.*
|
||||
Proceedings of the Workshop on Estimation, Tracking and Fusion:
|
||||
A Tribute to Yaakov Bar-Shalom. 2001.
|
||||
|
||||
:Example:
|
||||
>>> spatial_domain = Ellipsoid({'x':[-1, 1], 'y':[-1,1]})
|
||||
|
||||
@@ -25,8 +25,8 @@ class Exclusion(OperationInterface):
|
||||
Initialization of the :class:`Exclusion` class.
|
||||
|
||||
:param list[DomainInterface] geometries: A list of instances of the
|
||||
:class:`~pina.domain.DomainInterface` class on which the exclusion
|
||||
operation is performed.
|
||||
:class:`~pina.domain.domain_interface.DomainInterface` class on
|
||||
which the exclusion operation is performed.
|
||||
|
||||
:Example:
|
||||
>>> # Create two ellipsoid domains
|
||||
|
||||
@@ -24,8 +24,8 @@ class Intersection(OperationInterface):
|
||||
Initialization of the :class:`Intersection` class.
|
||||
|
||||
:param list[DomainInterface] geometries: A list of instances of the
|
||||
:class:`~pina.domain.DomainInterface` class on which the
|
||||
intersection operation is performed.
|
||||
:class:`~pina.domain.domain_interface.DomainInterface` class on
|
||||
which the intersection operation is performed.
|
||||
|
||||
:Example:
|
||||
>>> # Create two ellipsoid domains
|
||||
|
||||
@@ -15,8 +15,8 @@ class OperationInterface(DomainInterface, metaclass=ABCMeta):
|
||||
Initialization of the :class:`OperationInterface` class.
|
||||
|
||||
:param list[DomainInterface] geometries: A list of instances of the
|
||||
:class:`~pina.domain.DomainInterface` class on which the set
|
||||
operation is performed.
|
||||
:class:`~pina.domain.domain_interface.DomainInterface` class on
|
||||
which the set operation is performed.
|
||||
"""
|
||||
# check consistency geometries
|
||||
check_consistency(geometries, DomainInterface)
|
||||
|
||||
@@ -23,8 +23,8 @@ class Union(OperationInterface):
|
||||
Initialization of the :class:`Union` class.
|
||||
|
||||
:param list[DomainInterface] geometries: A list of instances of the
|
||||
:class:`~pina.domain.DomainInterface` class on which the union
|
||||
operation is performed.
|
||||
:class:`~pina.domain.domain_interface.DomainInterface` class on
|
||||
which the union operation is performed.
|
||||
|
||||
:Example:
|
||||
>>> # Create two ellipsoid domains
|
||||
|
||||
Reference in New Issue
Block a user