Drake
Drake C++ Documentation
Distribution Class Referenceabstract

Detailed Description

Base class for a single distribution, to be used with YAML archives.

(See class DistributionVector for vector-valued distributions.)

See Implementing Serialize for implementation details, especially the unusually public member fields of our subclasses.

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

Public Member Functions

virtual ~Distribution ()
 
virtual double Sample (drake::RandomGenerator *generator) const =0
 
virtual double Mean () const =0
 
virtual drake::symbolic::Expression ToSymbolic () const =0
 

Protected Member Functions

 Distribution ()
 
Implements CopyConstructible, CopyAssignable, MoveConstructible, MoveAssignable
 Distribution (const Distribution &)=default
 
Distributionoperator= (const Distribution &)=default
 
 Distribution (Distribution &&)=default
 
Distributionoperator= (Distribution &&)=default
 

Constructor & Destructor Documentation

◆ ~Distribution()

virtual ~Distribution ( )
virtual

◆ Distribution() [1/3]

Distribution ( const Distribution )
protecteddefault

◆ Distribution() [2/3]

Distribution ( Distribution &&  )
protecteddefault

◆ Distribution() [3/3]

Distribution ( )
protected

Member Function Documentation

◆ Mean()

virtual double Mean ( ) const
pure virtual

◆ operator=() [1/2]

Distribution& operator= ( Distribution &&  )
protecteddefault

◆ operator=() [2/2]

Distribution& operator= ( const Distribution )
protecteddefault

◆ Sample()

virtual double Sample ( drake::RandomGenerator generator) const
pure virtual

◆ ToSymbolic()

virtual drake::symbolic::Expression ToSymbolic ( ) const
pure virtual

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