Eigen::Rand::MvVecGenBase< DerivedGen, _Scalar, Dim > Class Template Reference

Base class of all multivariate random vector generators. More...

#include <Basic.h>

Inheritance diagram for Eigen::Rand::MvVecGenBase< DerivedGen, _Scalar, Dim >:

Public Member Functions
DerivedGen &	derived ()
	Return a reference to the derived type.
Index	dims () const
	returns the dimensions of vectors to be generated
template<typename Urng >
Matrix< _Scalar, Dim, -1 >	generate (Urng &&urng, Index samples)
	generates multiple samples at once
template<typename Urng >
Matrix< _Scalar, Dim, 1 >	generate (Urng &&urng)
	generates one sample

Detailed Description

template<typename DerivedGen, typename _Scalar, Index Dim>
class Eigen::Rand::MvVecGenBase< DerivedGen, _Scalar, Dim >

Base class of all multivariate random vector generators.

Template Parameters

DerivedGen
_Scalar
Dim

Member Function Documentation

generate() [1/2]

template<typename DerivedGen , typename _Scalar , Index Dim>

template<typename Urng >

Matrix< _Scalar, Dim, 1 > Eigen::Rand::MvVecGenBase< DerivedGen, _Scalar, Dim >::generate ( Urng &&  urng )

inline

generates one sample

Template Parameters

Urng

Parameters

urng	c++11-style random number generator

Returns

a random vector with a shape (dim,)

generate() [2/2]

template<typename DerivedGen , typename _Scalar , Index Dim>

template<typename Urng >

Matrix< _Scalar, Dim, -1 > Eigen::Rand::MvVecGenBase< DerivedGen, _Scalar, Dim >::generate ( Urng &&  urng, Index  samples  )

inline

generates multiple samples at once

Template Parameters

Urng

Parameters

urng	c++11-style random number generator
samples	the number of samples to be generated

Returns

a random matrix with a shape (dim, samples) which is consist of samples random vector columns

---

The documentation for this class was generated from the following file:

• Basic.h