IrisZoOptions Class Reference

Detailed Description

IrisZoOptions collects all parameters for the IRIS-ZO algorithm.

Warning

This feature is considered to be experimental and may change or be removed at any time, without any deprecation notice ahead of time.

See also

IrisZo for more details.

#include <drake/planning/iris/iris_zo.h>

Public Member Functions
template<typename Archive >
void	Serialize (Archive *a)
	Passes this object to an Archive. More...
	IrisZoOptions ()=default
Implements CopyConstructible, CopyAssignable, MoveConstructible, MoveAssignable
	IrisZoOptions (const IrisZoOptions &)=default
IrisZoOptions &	operator= (const IrisZoOptions &)=default
	IrisZoOptions (IrisZoOptions &&)=default
IrisZoOptions &	operator= (IrisZoOptions &&)=default

Public Attributes
CommonSampledIrisOptions	sampled_iris_options {}
	Options pertaining to the sampling and termination conditions. More...
int	bisection_steps {10}
	Maximum number of bisection steps. More...
IrisParameterizationFunction	parameterization {}
	Parameterization of the subspace along which to grow the region. More...

Constructor & Destructor Documentation

IrisZoOptions() [1/3]

IrisZoOptions ( const IrisZoOptions &  )

default

IrisZoOptions() [2/3]

IrisZoOptions ( IrisZoOptions &&  )

default

IrisZoOptions() [3/3]

IrisZoOptions ( )

default

Member Function Documentation

operator=() [1/2]

IrisZoOptions& operator= ( const IrisZoOptions &  )

default

operator=() [2/2]

IrisZoOptions& operator= ( IrisZoOptions &&  )

default

Serialize()

void Serialize

(

Archive *

a

)

Passes this object to an Archive.

Refer to YAML Serialization for background. Note: This only serializes options that are YAML built-in types.

Member Data Documentation

bisection_steps

int bisection_steps {10}

Maximum number of bisection steps.

parameterization

IrisParameterizationFunction parameterization {}

Parameterization of the subspace along which to grow the region.

Default is the identity parameterization, corresponding to growing regions in the ordinary configuration space.

sampled_iris_options

CommonSampledIrisOptions sampled_iris_options {}

Options pertaining to the sampling and termination conditions.

---

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

• drake/planning/iris/iris_zo.h