Drake
Drake C++ Documentation
drake::systems::analysis Namespace Reference

Namespaces

 test
 

Classes

struct  RandomSimulationResult
 A snapshot of the generator used to produce the random simulation. More...
 
struct  RegionOfAttractionOptions
 Consolidates the many possible options to be passed to the region of attraction algorithm. More...
 

Typedefs

typedef std::function< std::unique_ptr< Simulator< double > > RandomGenerator *generator)> SimulatorFactory
 
typedef std::function< double(const System< double > &system, const Context< double > &context)> ScalarSystemFunction
 

Functions

Eigen::VectorXd SampleBasedLyapunovAnalysis (const System< double > &system, const Context< double > &context, const std::function< VectorX< AutoDiffXd >(const VectorX< AutoDiffXd > &state)> &basis_functions, const Eigen::Ref< const Eigen::MatrixXd > &state_samples, const Eigen::Ref< const Eigen::VectorXd > &V_zero_state)
 Sets up a linear program to search for the coefficients of a Lyapunov function that satisfies the Lyapunov conditions at a set of sample points. More...
 
double RandomSimulation (const SimulatorFactory &make_simulator, const ScalarSystemFunction &output, double final_time, RandomGenerator *generator)
 Run a deterministic simulation of a (stochastic) System using the generator to instantiate all "random" quantities. More...
 
std::vector< RandomSimulationResultMonteCarloSimulation (const SimulatorFactory &make_simulator, const ScalarSystemFunction &output, double final_time, int num_samples, RandomGenerator *generator=nullptr, Parallelism parallelism=false)
 Generates samples of a scalar random variable output by running many random simulations drawn from independent samples of the distributions governing the stochastic simulation. More...
 
std::vector< RandomSimulationResultMonteCarloSimulation (const SimulatorFactory &make_simulator, const ScalarSystemFunction &output, double final_time, int num_samples, RandomGenerator *generator=nullptr, int num_parallel_executions=1)
 (Deprecated.) More...
 
symbolic::Expression RegionOfAttraction (const System< double > &system, const Context< double > &context, const RegionOfAttractionOptions &options=RegionOfAttractionOptions())
 Estimates the region of attraction of the time-invariant system at the fixed point defined by context. More...
 

Variables

constexpr int kNoConcurrency = 1
 (Deprecated.) More...
 
constexpr int kUseHardwareConcurrency = -1
 (Deprecated.) More...
 

Typedef Documentation

◆ ScalarSystemFunction

typedef std::function<double(const System<double>& system, const Context<double>& context)> ScalarSystemFunction

◆ SimulatorFactory

typedef std::function<std::unique_ptr<Simulator<double> > RandomGenerator* generator)> SimulatorFactory

Function Documentation

◆ MonteCarloSimulation()

std::vector<RandomSimulationResult> drake::systems::analysis::MonteCarloSimulation ( const SimulatorFactory make_simulator,
const ScalarSystemFunction output,
double  final_time,
int  num_samples,
RandomGenerator generator = nullptr,
int  num_parallel_executions = 1 
)

(Deprecated.)

Deprecated:
The `num_parallel_executions` argument is deprecated. Use the `parallelism` argument, instead.
This will be removed from Drake on or after 2024-05-01.

Variable Documentation

◆ kNoConcurrency

constexpr int kNoConcurrency = 1

(Deprecated.)

Deprecated:
Use either `drake::Parallelism::None()` or `false` instead.
This will be removed from Drake on or after 2024-05-01.

◆ kUseHardwareConcurrency

constexpr int kUseHardwareConcurrency = -1

(Deprecated.)

Deprecated:
Use either `drake::Parallelism::Max()` or `true` instead.
This will be removed from Drake on or after 2024-05-01.