Drake
Drake C++ Documentation
Loading...
Searching...
No Matches
GaussianVector< Size > Class Template Referencefinal

Detailed Description

template<int Size>
class drake::schema::GaussianVector< Size >

A gaussian distribution with vector mean and vector or scalar stddev.

When mean and stddev both have the same number of elements, that denotes an elementwise pairing of the 0th mean with 0th stddev, 1st mean with 1st stddev, etc.

Alternatively, stddev can be a vector with a single element, no matter the size of mean; that denotes the same stddev value applied to every element of mean.

Template Parameters
Sizerows at compile time (max 6) or else Eigen::Dynamic.

#include <drake/common/schema/stochastic.h>

Public Member Functions

 GaussianVector ()
 GaussianVector (const drake::Vector< double, Size > &mean, const drake::VectorX< double > &stddev)
 ~GaussianVector () final
Eigen::VectorXd Sample (drake::RandomGenerator *) const final
Eigen::VectorXd Mean () const final
drake::VectorX< drake::symbolic::ExpressionToSymbolic () const final
template<typename Archive>
void Serialize (Archive *a)
Implements CopyConstructible, CopyAssignable, MoveConstructible, MoveAssignable
 GaussianVector (const GaussianVector &)=default
GaussianVectoroperator= (const GaussianVector &)=default
 GaussianVector (GaussianVector &&)=default
GaussianVectoroperator= (GaussianVector &&)=default
Public Member Functions inherited from DistributionVector
virtual ~DistributionVector ()

Public Attributes

drake::Vector< double, Size > mean
drake::VectorX< doublestddev

Additional Inherited Members

Protected Member Functions inherited from DistributionVector
 DistributionVector ()
 DistributionVector (const DistributionVector &)=default
DistributionVectoroperator= (const DistributionVector &)=default
 DistributionVector (DistributionVector &&)=default
DistributionVectoroperator= (DistributionVector &&)=default

Constructor & Destructor Documentation

◆ GaussianVector() [1/4]

template<int Size>
GaussianVector ( const GaussianVector< Size > & )
default

◆ GaussianVector() [2/4]

template<int Size>
GaussianVector ( GaussianVector< Size > && )
default

◆ GaussianVector() [3/4]

template<int Size>
GaussianVector ( )

◆ GaussianVector() [4/4]

template<int Size>
GaussianVector ( const drake::Vector< double, Size > & mean,
const drake::VectorX< double > & stddev )

◆ ~GaussianVector()

template<int Size>
~GaussianVector ( )
final

Member Function Documentation

◆ Mean()

template<int Size>
Eigen::VectorXd Mean ( ) const
finalvirtual

Implements DistributionVector.

◆ operator=() [1/2]

template<int Size>
GaussianVector & operator= ( const GaussianVector< Size > & )
default

◆ operator=() [2/2]

template<int Size>
GaussianVector & operator= ( GaussianVector< Size > && )
default

◆ Sample()

template<int Size>
Eigen::VectorXd Sample ( drake::RandomGenerator * ) const
finalvirtual

Implements DistributionVector.

◆ Serialize()

template<int Size>
template<typename Archive>
void Serialize ( Archive * a)

◆ ToSymbolic()

template<int Size>
drake::VectorX< drake::symbolic::Expression > ToSymbolic ( ) const
finalvirtual

Implements DistributionVector.

Member Data Documentation

◆ mean

template<int Size>
drake::Vector<double, Size> mean

◆ stddev

template<int Size>
drake::VectorX<double> stddev

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