MultivariateNormalDistributionParam< Vector, Matrix > Class Template Reference#
|
Beluga
|
beluga::MultivariateNormalDistributionParam< Vector, Matrix > Class Template Reference
Multivariate normal distribution parameter set class. More...
#include <multivariate_normal_distribution.hpp>
Public Types | |
| using | scalar_type = typename Vector::Scalar |
| The scalar type. | |
| using | vector_type = Vector |
| The vector type. | |
| using | matrix_type = Matrix |
| The covariance matrix from Vector. | |
Public Member Functions | |
| MultivariateNormalDistributionParam ()=default | |
| Constructs a parameter set instance. | |
| MultivariateNormalDistributionParam (matrix_type covariance) | |
| Constructs a parameter set instance. More... | |
| MultivariateNormalDistributionParam (vector_type mean, matrix_type covariance) | |
| Constructs a parameter set instance. More... | |
| bool | operator== (const MultivariateNormalDistributionParam &other) const |
| Compares this object with other parameter set object. More... | |
| bool | operator!= (const MultivariateNormalDistributionParam &other) const |
| Compares this object with other parameter set object. More... | |
| template<class Generator > | |
| auto | operator() (std::normal_distribution< scalar_type > &distribution, Generator &generator) const |
| Generates a new random object from the distribution. More... | |
Detailed Description
template<class Vector, class Matrix>
class beluga::MultivariateNormalDistributionParam< Vector, Matrix >
Multivariate normal distribution parameter set class.
Constructor & Destructor Documentation
◆ MultivariateNormalDistributionParam() [1/2]
template<class Vector , class Matrix >
|
inlineexplicit |
Constructs a parameter set instance.
- Parameters
-
covariance Real symmetric matrix that represents the covariance of the random variable.
- Exceptions
-
std::runtime_error If the provided covariance is invalid.
◆ MultivariateNormalDistributionParam() [2/2]
template<class Vector , class Matrix >
|
inline |
Constructs a parameter set instance.
- Parameters
-
mean A vector that represents the mean value of the random variable. covariance Real symmetric matrix that represents the covariance of the random variable.
- Exceptions
-
std::runtime_error If the provided covariance is invalid.
Member Function Documentation
◆ operator!=()
template<class Vector , class Matrix >
|
inline |
Compares this object with other parameter set object.
- Parameters
-
other Parameter set object to compare against.
- Returns
- True if the objects are not equal, false otherwise.
◆ operator()()
template<class Vector , class Matrix >
template<class Generator >
|
inline |
Generates a new random object from the distribution.
- Template Parameters
-
Generator The generator type that must meet the requirements of UniformRandomBitGenerator.
- Parameters
-
distribution A reference to a standard normal distribution instance. generator An uniform random bit generator object.
- Returns
- The generated random object.
◆ operator==()
template<class Vector , class Matrix >
|
inline |
Compares this object with other parameter set object.
- Parameters
-
other Parameter set object to compare against.
- Returns
- True if the objects are equal, false otherwise.
The documentation for this class was generated from the following file:
- /home/runner/work/beluga/beluga/beluga/include/beluga/random/multivariate_normal_distribution.hpp
Generated by
1.9.1