]> SALOME platform Git repositories - modules/adao.git/commitdiff
Salome HOME
Minor documentation review corrections for bounds
authorJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Sun, 12 Nov 2023 13:43:32 +0000 (14:43 +0100)
committerJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Sun, 12 Nov 2023 13:43:32 +0000 (14:43 +0100)
14 files changed:
doc/en/ref_sampling_requirements.rst
doc/en/snippets/SampleAsExplicitHyperCube.rst
doc/en/snippets/SampleAsIndependantRandomVariables.rst
doc/en/snippets/SampleAsMinMaxLatinHyperCube.rst
doc/en/snippets/SampleAsMinMaxSobolSequence.rst
doc/en/snippets/SampleAsMinMaxStepHyperCube.rst
doc/en/snippets/SampleAsnUplet.rst
doc/fr/ref_sampling_requirements.rst
doc/fr/snippets/SampleAsExplicitHyperCube.rst
doc/fr/snippets/SampleAsIndependantRandomVariables.rst
doc/fr/snippets/SampleAsMinMaxLatinHyperCube.rst
doc/fr/snippets/SampleAsMinMaxSobolSequence.rst
doc/fr/snippets/SampleAsMinMaxStepHyperCube.rst
doc/fr/snippets/SampleAsnUplet.rst

index a9502e4980a94d3976497dd3ec562d0e4e01b41f..3ec4a46d3b1f9a96a55b4ed38de13e1288b547b0 100644 (file)
@@ -51,7 +51,9 @@ command set of an algorithm that requires it.
 
 The sampling of the states :math:`\mathbf{x}` can be provided explicitly or in
 the form of hypercubes, explicit or sampled according to common distributions,
-or using Latin Hypercube Sampling (LHS).
+or using Latin Hypercube Sampling (LHS). Depending on the method, the sample
+will be included in the domain described by its bounds, or will be descriptive
+of the unbounded domain of state variables.
 
 These possible keywords are:
 
index 5e549bfe7edf293c0ede93a0636ef3b078088bcf..8ab2cd02b065210dfd76c416cad999509da30421 100644 (file)
@@ -4,6 +4,7 @@ SampleAsExplicitHyperCube
   *List of list of real values*. This key describes the calculations points as
   an hyper-cube, from a given list of explicit sampling of each variable as a
   list. That is then a list of lists, each of them being potentially of
-  different size.
+  different size. By nature, the points are included in the domain defined by
+  the bounds of the explicit lists for each variable.
 
   Example : ``{"SampleAsExplicitHyperCube":[[0.,0.25,0.5,0.75,1.], [-2,2,1]]}`` for a state space of dimension 2.
index e9a83db113db041a27eab14eef14030c00a5a9d9..34702d51c5f13f4becfa922d2aeb19eca49164f6 100644 (file)
@@ -9,7 +9,9 @@ SampleAsIndependantRandomVariables
   axis. The possible distributions are 'normal' of parameters (mean,std),
   'lognormal' of parameters (mean,sigma), 'uniform' of parameters (low,high),
   or 'weibull' of parameter (shape). That is then a list of the same size than
-  the one of the state.
+  the one of the state. By nature, the points are included in the unbounded or
+  bounded domain, depending on the characteristics of the distributions chosen
+  for each variable.
 
   Example :
   ``{"SampleAsIndependantRandomVariables":[['normal',[0.,1.],3], ['uniform',[-2,2],4]]}`` for a state space of dimension 2.
index 0bb007f0e83cecebb13b4f9c0129a80dfbe2bee2..fbce4856ce9136220ad9c72d559a478d44830cd6 100644 (file)
@@ -8,7 +8,8 @@ SampleAsMinMaxLatinHyperCube
   identical in number to the size of the state space, is augmented by a pair of
   integers *[dim,nbr]* containing the dimension of the state space and the
   desired number of sample points. Sampling is then automatically constructed
-  using the Latin hypercube method (LHS).
+  using the Latin hypercube method (LHS). By nature, the points are included in
+  the domain defined by the explicit bounds.
 
   Example :
   ``{"SampleAsMinMaxLatinHyperCube":[[0.,1.],[-1,3]]+[[2,11]]}`` for a state space of dimension 2 and 11 sampling points.
index 1afab0eedf7747f43cf3f5134bb27ecc896d8fff..584f2f33915f9f127e4a07bfdd9a54e68e8afff6 100644 (file)
@@ -10,7 +10,8 @@ SampleAsMinMaxSobolSequence
   minimum desired number of sample points (by construction, the number of
   points generated in the Sobol sequence will be the power of 2 immediately
   above this minimum number). Sampling is then automatically constructed using
-  the Latin hypercube method (LHS).
+  the Sobol sequence method. By nature, the points are included in the domain
+  defined by the explicit bounds.
 
   Example :
   ``{"SampleAsMinMaxSobolSequence":[[0.,1.],[-1,3]]+[[2,11]]}`` for a state space of dimension 2 and 11 sampling points (there will be 16 points in practice).
index a2681a6b7f33075256e6901c5b1706a6dec5f13a..c2e3486b09ff6ad2486f0daa5e6d1ee1d504edde 100644 (file)
@@ -4,7 +4,8 @@ SampleAsMinMaxStepHyperCube
   *List of triplets of real values*. This key describes the calculations points
   as an hyper-cube, from a given list of implicit sampling of each variable by
   a triplet *[min,max,step]*. That is then a list of the same size than the one
-  of the state. The bounds are included.
+  of the state. The bounds are included. By nature, the points are included in
+  the domain defined by the explicit bounds.
 
   Example :
   ``{"SampleAsMinMaxStepHyperCube":[[0.,1.,0.25],[-1,3,1]]}`` for a state space of dimension 2.
index 513c4c4a8540220303bb879c55f4d4aa57f27595..d97537c3199b49faac7f56611219517dc037a2a6 100644 (file)
@@ -2,7 +2,9 @@
 
 SampleAsnUplet
   *List of states*. This key describes the calculations points as a list of
-  n-uplets, each n-uplet being a state.
+  n-uplets, each n-uplet being a state. By nature, points are included in the
+  bounded domain defined as the convex envelope of explicitly designated
+  points.
 
   Example :
   ``{"SampleAsnUplet":[[0,1,2,3],[4,3,2,1],[-2,3,-4,5]]}`` for 3 points in a state space of dimension 4.
index 9adc9d28b84cfe37f9f00c08c9a0a670cb2d9418..8fad23b1b34cb8a421e16337e51aabd9543c279e 100644 (file)
@@ -54,7 +54,8 @@ mots-clés dédiés dans le jeu de commandes d'un algorithme qui le nécessite.
 L'échantillonnage des états :math:`\mathbf{x}` peut être fourni explicitement
 ou sous la forme d'hypercubes, explicites ou échantillonnés selon des
 distributions courantes, ou à l'aide d'un échantillonnage par hypercube latin
-(LHS).
+(LHS). Selon la méthode, l'échantillon sera inclus dans le domaine décrit par
+ses bornes ou sera descriptif du domaine non borné des variables d'état.
 
 Ces mots-clés possibles sont les suivants :
 
index 756ad97749a99b4f94bf2aa260d2394946920669..77c8c8f912b7b89ce8212d73a74cf521eb3bbc26 100644 (file)
@@ -4,6 +4,8 @@ SampleAsExplicitHyperCube
   *Liste de liste de valeurs réelles*. Cette clé décrit les points de calcul
   sous la forme d'un hyper-cube, dont on donne la liste des échantillonnages
   explicites de chaque variable comme une liste. C'est donc une liste de
-  listes, chacune étant de taille potentiellement différente.
+  listes, chacune étant de taille potentiellement différente. Par nature, les
+  points sont inclus dans le domaine défini par les bornes des listes
+  explicites de chaque variable.
 
   Exemple : ``{"SampleAsExplicitHyperCube":[[0.,0.25,0.5,0.75,1.], [-2,2,1]]}`` pour un espace d'état de dimension 2.
index 1f46a8325e090d61adde9f7ab576b6b00dcdc9ed..543e46c37e8255e51f142aad7e96831dab6618ae 100644 (file)
@@ -9,7 +9,9 @@ SampleAsIndependantRandomVariables
   [parametres], nombre]`` pour chaque axe. Les distributions possibles sont
   'normal' de paramètres (mean,std), 'lognormal' de paramètres (mean,sigma),
   'uniform' de paramètres (low,high), ou 'weibull' de paramètre (shape). C'est
-  donc une liste de la même taille que celle de l'état.
+  donc une liste de la même taille que celle de l'état. Par nature, les points
+  sont inclus le domaine non borné ou borné selon les caractéristiques des
+  distributions choisies par variable.
 
   Exemple :
   ``{"SampleAsIndependantRandomVariables":[['normal',[0.,1.],3], ['uniform',[-2,2],4]]}`` pour un espace d'état de dimension 2.
index 46101f0cddbc33bf3b7d76597a9758a2c7b84b32..fbe4d483027f6c2cb6f9c498a1ede3c6479edab3 100644 (file)
@@ -10,7 +10,8 @@ SampleAsMinMaxLatinHyperCube
   des états, est complétée par une paire d'entier *[dim,nbr]* comportant la
   dimension de l'espace des états et le nombre souhaité de points
   d'échantillonnage. L'échantillonnage est ensuite construit automatiquement
-  selon la méthode de l'hypercube Latin (LHS).
+  selon la méthode de l'hypercube Latin (LHS). Par nature, les points sont
+  inclus dans le domaine défini par les bornes explicites.
 
   Exemple :
   ``{"SampleAsMinMaxLatinHyperCube":[[0.,1.],[-1,3]]+[[2,11]]}`` pour un espace d'état de dimension 2 et 11 points d'échantillonnage.
index 2d72dc67aff80bd1f4ef6a2aaa861a0f5ad373f5..6882b189988ccaaa62753391d73ee8e4816ebbef 100644 (file)
@@ -12,7 +12,8 @@ SampleAsMinMaxSobolSequence
   d'échantillonnage (par construction, le nombre de points générés dans la
   séquence de Sobol sera la puissance de 2 immédiatement supérieure à ce nombre
   minimum). L'échantillonnage est ensuite construit automatiquement selon la
-  méthode de séquences de Sobol.
+  méthode de séquences de Sobol. Par nature, les points sont inclus dans le
+  domaine défini par les bornes explicites.
 
   Exemple :
   ``{"SampleAsMinMaxSobolSequence":[[0.,1.],[-1,3]]+[[2,11]]}`` pour un espace d'état de dimension 2 et au moins 11 points d'échantillonnage (il y aura 16 points en pratique).
index 711a37b9cf99ae05e6224f0254603aacdf60c5ea..885caf2ffda67874b8099742c1e6e1d850e95104 100644 (file)
@@ -4,7 +4,9 @@ SampleAsMinMaxStepHyperCube
   *Liste de triplets de valeurs réelles*. Cette clé décrit les points de calcul
   sous la forme d'un hyper-cube, dont on donne la liste des échantillonnages
   implicites de chaque variable par un triplet *[min,max,step]*. C'est donc une
-  liste de la même taille que celle de l'état. Les bornes sont incluses.
+  liste de la même taille que celle de l'état. Les bornes sont incluses. Par
+  nature, les points sont inclus dans le domaine défini par les bornes
+  explicites.
 
   Exemple :
   ``{"SampleAsMinMaxStepHyperCube":[[0.,1.,0.25],[-1,3,1]]}`` pour un espace d'état de dimension 2.
index 3bfd5ea0c6fff7691400ba1dfa9652baf147ed4a..87c1271fa8ae7377b5421ef5ab2aa1965280a9ed 100644 (file)
@@ -2,7 +2,9 @@
 
 SampleAsnUplet
   *Liste d'états*. Cette clé décrit les points de calcul sous la forme d'une
-  liste de n-uplets, chaque n-uplet étant un état.
+  liste de n-uplets, chaque n-uplet étant un état. Par nature, les points sont
+  inclus dans le domaine borné défini comme l'enveloppe convexe des points
+  explicitement désignés.
 
   Exemple :
   ``{"SampleAsnUplet":[[0,1,2,3],[4,3,2,1],[-2,3,-4,5]]}`` pour 3 points dans un espace d'état de dimension 4.