From: Jean-Philippe ARGAUD Date: Sun, 12 Nov 2023 13:43:32 +0000 (+0100) Subject: Minor documentation review corrections for bounds X-Git-Tag: V9_12_0b1~1 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=4a63d0afe9c9d3f9b66ca8506b61067ecb12c2c8;p=modules%2Fadao.git Minor documentation review corrections for bounds --- diff --git a/doc/en/ref_sampling_requirements.rst b/doc/en/ref_sampling_requirements.rst index a9502e4..3ec4a46 100644 --- a/doc/en/ref_sampling_requirements.rst +++ b/doc/en/ref_sampling_requirements.rst @@ -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: diff --git a/doc/en/snippets/SampleAsExplicitHyperCube.rst b/doc/en/snippets/SampleAsExplicitHyperCube.rst index 5e549bf..8ab2cd0 100644 --- a/doc/en/snippets/SampleAsExplicitHyperCube.rst +++ b/doc/en/snippets/SampleAsExplicitHyperCube.rst @@ -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. diff --git a/doc/en/snippets/SampleAsIndependantRandomVariables.rst b/doc/en/snippets/SampleAsIndependantRandomVariables.rst index e9a83db..34702d5 100644 --- a/doc/en/snippets/SampleAsIndependantRandomVariables.rst +++ b/doc/en/snippets/SampleAsIndependantRandomVariables.rst @@ -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. diff --git a/doc/en/snippets/SampleAsMinMaxLatinHyperCube.rst b/doc/en/snippets/SampleAsMinMaxLatinHyperCube.rst index 0bb007f..fbce485 100644 --- a/doc/en/snippets/SampleAsMinMaxLatinHyperCube.rst +++ b/doc/en/snippets/SampleAsMinMaxLatinHyperCube.rst @@ -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. diff --git a/doc/en/snippets/SampleAsMinMaxSobolSequence.rst b/doc/en/snippets/SampleAsMinMaxSobolSequence.rst index 1afab0e..584f2f3 100644 --- a/doc/en/snippets/SampleAsMinMaxSobolSequence.rst +++ b/doc/en/snippets/SampleAsMinMaxSobolSequence.rst @@ -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). diff --git a/doc/en/snippets/SampleAsMinMaxStepHyperCube.rst b/doc/en/snippets/SampleAsMinMaxStepHyperCube.rst index a2681a6..c2e3486 100644 --- a/doc/en/snippets/SampleAsMinMaxStepHyperCube.rst +++ b/doc/en/snippets/SampleAsMinMaxStepHyperCube.rst @@ -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. diff --git a/doc/en/snippets/SampleAsnUplet.rst b/doc/en/snippets/SampleAsnUplet.rst index 513c4c4..d97537c 100644 --- a/doc/en/snippets/SampleAsnUplet.rst +++ b/doc/en/snippets/SampleAsnUplet.rst @@ -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. diff --git a/doc/fr/ref_sampling_requirements.rst b/doc/fr/ref_sampling_requirements.rst index 9adc9d2..8fad23b 100644 --- a/doc/fr/ref_sampling_requirements.rst +++ b/doc/fr/ref_sampling_requirements.rst @@ -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 : diff --git a/doc/fr/snippets/SampleAsExplicitHyperCube.rst b/doc/fr/snippets/SampleAsExplicitHyperCube.rst index 756ad97..77c8c8f 100644 --- a/doc/fr/snippets/SampleAsExplicitHyperCube.rst +++ b/doc/fr/snippets/SampleAsExplicitHyperCube.rst @@ -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. diff --git a/doc/fr/snippets/SampleAsIndependantRandomVariables.rst b/doc/fr/snippets/SampleAsIndependantRandomVariables.rst index 1f46a83..543e46c 100644 --- a/doc/fr/snippets/SampleAsIndependantRandomVariables.rst +++ b/doc/fr/snippets/SampleAsIndependantRandomVariables.rst @@ -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. diff --git a/doc/fr/snippets/SampleAsMinMaxLatinHyperCube.rst b/doc/fr/snippets/SampleAsMinMaxLatinHyperCube.rst index 46101f0..fbe4d48 100644 --- a/doc/fr/snippets/SampleAsMinMaxLatinHyperCube.rst +++ b/doc/fr/snippets/SampleAsMinMaxLatinHyperCube.rst @@ -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. diff --git a/doc/fr/snippets/SampleAsMinMaxSobolSequence.rst b/doc/fr/snippets/SampleAsMinMaxSobolSequence.rst index 2d72dc6..6882b18 100644 --- a/doc/fr/snippets/SampleAsMinMaxSobolSequence.rst +++ b/doc/fr/snippets/SampleAsMinMaxSobolSequence.rst @@ -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). diff --git a/doc/fr/snippets/SampleAsMinMaxStepHyperCube.rst b/doc/fr/snippets/SampleAsMinMaxStepHyperCube.rst index 711a37b..885caf2 100644 --- a/doc/fr/snippets/SampleAsMinMaxStepHyperCube.rst +++ b/doc/fr/snippets/SampleAsMinMaxStepHyperCube.rst @@ -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. diff --git a/doc/fr/snippets/SampleAsnUplet.rst b/doc/fr/snippets/SampleAsnUplet.rst index 3bfd5ea..87c1271 100644 --- a/doc/fr/snippets/SampleAsnUplet.rst +++ b/doc/fr/snippets/SampleAsnUplet.rst @@ -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.