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

@@ -5,25 +5,59 @@ from pina.geometry import Union, EllipsoidDomain, CartesianDomain
def test_constructor_two_CartesianDomains():
Union([CartesianDomain({'x': [0, 1], 'y': [0, 1]}),
CartesianDomain({'x': [0.5, 2], 'y': [-1, 0.1]})])
Union([
CartesianDomain({
'x': [0, 1],
'y': [0, 1]
}),
CartesianDomain({
'x': [0.5, 2],
'y': [-1, 0.1]
})
])
def test_constructor_two_EllipsoidDomains():
Union([EllipsoidDomain({'x': [-1, 1], 'y': [-1, 1], 'z': [-1, 1]}),
EllipsoidDomain({'x': [-0.5, 0.5], 'y': [-0.5, 0.5], 'z': [-0.5, 0.5]})])
Union([
EllipsoidDomain({
'x': [-1, 1],
'y': [-1, 1],
'z': [-1, 1]
}),
EllipsoidDomain({
'x': [-0.5, 0.5],
'y': [-0.5, 0.5],
'z': [-0.5, 0.5]
})
])
def test_constructor_EllipsoidDomain_CartesianDomain():
Union([EllipsoidDomain({'x': [-1, 1], 'y': [-1, 1]}),
CartesianDomain({'x': [-0.5, 0.5], 'y': [-0.5, 0.5]})])
Union([
EllipsoidDomain({
'x': [-1, 1],
'y': [-1, 1]
}),
CartesianDomain({
'x': [-0.5, 0.5],
'y': [-0.5, 0.5]
})
])
def test_is_inside_two_CartesianDomains():
pt_1 = LabelTensor(torch.tensor([[0.5, 0.5]]), ['x', 'y'])
pt_2 = LabelTensor(torch.tensor([[-1, -1]]), ['x', 'y'])
domain = Union([CartesianDomain({'x': [0, 1], 'y': [0, 1]}),
CartesianDomain({'x': [0.5, 2], 'y': [-1, 0.1]})])
domain = Union([
CartesianDomain({
'x': [0, 1],
'y': [0, 1]
}),
CartesianDomain({
'x': [0.5, 2],
'y': [-1, 0.1]
})
])
assert domain.is_inside(pt_1) == True
assert domain.is_inside(pt_2) == False
@@ -31,8 +65,18 @@ def test_is_inside_two_CartesianDomains():
def test_is_inside_two_EllipsoidDomains():
pt_1 = LabelTensor(torch.tensor([[0.5, 0.5, 0.5]]), ['x', 'y', 'z'])
pt_2 = LabelTensor(torch.tensor([[-1, -1, -1]]), ['x', 'y', 'z'])
domain = Union([EllipsoidDomain({'x': [-1, 1], 'y': [-1, 1], 'z': [-1, 1]}),
EllipsoidDomain({'x': [-0.5, 0.5], 'y': [-0.5, 0.5], 'z': [-0.5, 0.5]})])
domain = Union([
EllipsoidDomain({
'x': [-1, 1],
'y': [-1, 1],
'z': [-1, 1]
}),
EllipsoidDomain({
'x': [-0.5, 0.5],
'y': [-0.5, 0.5],
'z': [-0.5, 0.5]
})
])
assert domain.is_inside(pt_1) == True
assert domain.is_inside(pt_2) == False
@@ -40,16 +84,32 @@ def test_is_inside_two_EllipsoidDomains():
def test_is_inside_EllipsoidDomain_CartesianDomain():
pt_1 = LabelTensor(torch.tensor([[0.5, 0.5]]), ['x', 'y'])
pt_2 = LabelTensor(torch.tensor([[-1, -1]]), ['x', 'y'])
domain = Union([EllipsoidDomain({'x': [-1, 1], 'y': [-1, 1], }),
CartesianDomain({'x': [0.6, 1.5], 'y': [-2, 0]})])
domain = Union([
EllipsoidDomain({
'x': [-1, 1],
'y': [-1, 1],
}),
CartesianDomain({
'x': [0.6, 1.5],
'y': [-2, 0]
})
])
assert domain.is_inside(pt_1) == True
assert domain.is_inside(pt_2) == False
def test_sample():
n = 100
domain = Union([EllipsoidDomain({'x': [-1, 1], 'y': [-1, 1]}),
CartesianDomain({'x': [-0.5, 0.5], 'y': [-0.5, 0.5]})])
domain = Union([
EllipsoidDomain({
'x': [-1, 1],
'y': [-1, 1]
}),
CartesianDomain({
'x': [-0.5, 0.5],
'y': [-0.5, 0.5]
})
])
pts = domain.sample(n)
assert isinstance(pts, LabelTensor)
assert pts.shape[0] == n