Admin : Page créée avec « NOTOC == Introduction == === Scope === This section describes how dispersions are defined and used in the PATRIUS library. Dispersions are not to be mixed up with rand... »

2022-11-10T08:53:47Z

Page créée avec « __NOTOC__ == Introduction == === Scope === This section describes how dispersions are defined and used in the PATRIUS library. Dispersions are not to be mixed up with rand... »

Nouvelle page

__NOTOC__
== Introduction ==
=== Scope ===
This section describes how dispersions are defined and used in the PATRIUS library.
Dispersions are not to be mixed up with random generation (not detailed in this page). Dispersions always rely on a random generator.

=== Javadoc ===
The dispersions objects are available in the package <code>fr.cnes.sirius.patrius.math.random</code>. This package also handles random generation.

{| class="wikitable"
|-
! scope="col"| Library
! scope="col"| Javadoc
|-
|Patrius
|[{{JavaDoc4.10}}/fr/cnes/sirius/patrius/math/random/package-summary.html Package fr.cnes.sirius.patrius.math.random]
|-
|Patrius
|[{{JavaDoc4.10}}/fr/cnes/sirius/patrius/math/random/package-summary.html Package fr.cnes.sirius.patrius.math.random]
|}

=== Links ===
None as of now.

=== Useful Documents ===
None as of now.

=== Package Overview ===

== Features Description ==
=== Random number generation ===
Distributed random number generation is based on using implementations of interface <code>fr.cnes.sirius.patrius.math.random.NormalizedRandomGenerator</code>.
Each implementation of this interface provides a specific dispersion scheme. For instance, the following code will generate random numbers with Gaussian distribution of mean 0 and unit standard deviation:
<syntaxhighlight lang="java">
final RandomGenerator g = new JDKRandomGenerator();
final NormalizedRandomGenerator generator = new GaussianRandomGenerator(g);
final double value = generator.nextNormalizedDouble();
</syntaxhighlight>

As shown in the above example, building a dispersion object requires a random generator implementing <code>fr.cnes.sirius.patrius.math.random.RandomGenerator</code> interface.

=== Random vector generation ===
Correlated random vector generation is based on using implementations of interface <code>fr.cnes.sirius.patrius.math.random.RandomVectorGenerator</code>.
Each implementation of this interface provides a specific dispersion scheme. For instance, the following code will generate uniformly correlated random vectors according to provided covariance matrix:
<syntaxhighlight lang="java">
final RandomGenerator g = new JDKRandomGenerator();
final RandomVectorGenerator generator = new UniformlyCorrelatedRandomVectorGenerator(mean, covariance, 0, g);
final double[] value = generator.nextVector();
</syntaxhighlight>

As shown in the above example, building a dispersion object requires a random generator implementing <code>fr.cnes.sirius.patrius.math.random.RandomGenerator</code> interface.

=== Correlated random vector generator ===
The user provides a covariance matrix and a random generator.<br>
'''When using Gaussian correlated random vector generator''':
* The covariance matrix root is extracted using a Cholesky decomposition. The number of columns of the root matrix corresponds to the rank of the provided covariance matrix.
* An uncorrelated vector of size the rank of the covariance matrix is generated using the provided random generator
* The final correlated vector is obtained by multiplying the covariance root matrix by this generated vector.

'''When using uniformly correlated random vector generator''', the process is more complex:
* The covariance matrix is converted into a correlation matrix. Standard deviation vector is extracted from the process. Obtained correlation matrix must be positive semi-definite (all eigenvalues must be non negative).
* Spearman correction is applied to the correlation matrix. If corrected correlation matrix is not positive semi-definite, correction is not applied.
[[File:spearmanCorrection.png|center]]
* The correlation matrix root is extracted using a Cholesky decomposition. The number of columns of the root matrix corresponds to the rank of the correlation matrix.
* A uncorrelated vector of size the rank of the covariance matrix is generated using the provided random generator
* The product of correlation matrix root L and uncorrelated vector T is then transformed to get a uniform law:
[[File:uniformCorrection.png|center]]
* The final correlated vector is obtained by linearly multiplying z by the standard deviation vector.

== Getting Started ==
{{specialInclusion prefix=$theme section="GettingStarted"/}}

== Contents ==
=== Interfaces ===
The library defines the following interfaces related to dispersions:

{| class="wikitable"
|-
! scope="col"| Interface
! scope="col"| Summary
! scope="col"| Javadoc
|-
|'''NormalizedRandomGenerator'''
|Interface for normalized random generators
|[{{JavaDoc4.10}}/fr/cnes/sirius/patrius/math/random/NormalizedRandomGenerator.html ...]
|-
|'''RandomVectorGenerator'''
|Interface for random vector generators
|[{{JavaDoc4.10}}/fr/cnes/sirius/patrius/math/random/RandomVectorGenerator.html ...]
|}

Note: interface for random number generators is <code>fr.cnes.sirius.patrius.math.random.RandomGenerator</code>.

=== Classes ===
The library defines the following classes related to dispersions:

{| class="wikitable"
|-
! scope="col"| Class
! scope="col"| Summary
! scope="col"| Javadoc
|-
|'''GaussianRandomGenerator'''
|Generator following Gaussian distribution
|[{{JavaDoc4.10}}/fr/cnes/sirius/patrius/math/random/GaussianRandomGenerator.html ...]
|-
|'''UniformRandomGenerator'''
|Generator following uniform distribution
|[{{JavaDoc4.10}}/fr/cnes/sirius/patrius/math/random/UniformRandomGenerator.html ...]
|-
|'''UncorrelatedRandomVectorGenerator'''
|Generator for Gaussian uncorrelated vectors
|[{{JavaDoc4.10}}/fr/cnes/sirius/patrius/math/random/UncorrelatedRandomVectorGenerator.html ...]
|-
|'''CorrelatedRandomVectorGenerator'''
|Generator for Gaussian correlated vectors
|[{{JavaDoc4.10}}/fr/cnes/sirius/patrius/math/random/CorrelatedRandomVectorGenerator.html ...]
|-
|'''UniformlyCorrelatedRandomVectorGenerator'''
|Generator for uniformly correlated vectors
|[{{JavaDoc4.10}}/fr/cnes/sirius/patrius/math/random/UniformlyCorrelatedRandomVectorGenerator.html ...]
|-
|'''UnitSphereRandomVectorGenerator'''
|Generator for vectors isotropically located on a sphere
|[{{JavaDoc4.10}}/fr/cnes/sirius/patrius/math/random/UnitSphereRandomVectorGenerator.html ...]
|}

[[Category:User_Manual_4.10_Mathematics]]

User Manual 4.10 Dispersions - Historique des versions

Admin : Page créée avec « __NOTOC__ == Introduction == === Scope === This section describes how dispersions are defined and used in the PATRIUS library. Dispersions are not to be mixed up with rand... »

Admin : Page créée avec « NOTOC == Introduction == === Scope === This section describes how dispersions are defined and used in the PATRIUS library. Dispersions are not to be mixed up with rand... »