Drake
Drake C++ Documentation
GcsGraphvizOptions Struct Reference

#include <drake/geometry/optimization/graph_of_convex_sets.h>

Public Member Functions

template<typename Archive >
void Serialize (Archive *a)
 Passes this object to an Archive. More...
 

Public Attributes

bool show_slacks {true}
 Determines whether the values of the intermediate (slack) variables are also displayed in the graph. More...
 
bool show_vars {true}
 Determines whether the solution values for decision variables in each set are shown. More...
 
bool show_flows {true}
 Determines whether the flow value results are shown. More...
 
bool show_costs {true}
 Determines whether the cost value results are shown. More...
 
bool scientific {false}
 Sets the floating point formatting to scientific (if true) or fixed (if false). More...
 
int precision {3}
 Sets the floating point precision (how many digits are generated) of the annotations. More...
 

Member Function Documentation

◆ Serialize()

void Serialize ( Archive *  a)

Passes this object to an Archive.

Refer to YAML Serialization for background.

Member Data Documentation

◆ precision

int precision {3}

Sets the floating point precision (how many digits are generated) of the annotations.

◆ scientific

bool scientific {false}

Sets the floating point formatting to scientific (if true) or fixed (if false).

◆ show_costs

bool show_costs {true}

Determines whether the cost value results are shown.

This will show both edge and vertex costs.

◆ show_flows

bool show_flows {true}

Determines whether the flow value results are shown.

The flow values are shown both with a numeric value and through the transparency value on the edge, where a flow of 0.0 will correspond to an (almost) invisible edge, and a flow of 1.0 will display as a fully black edge.

◆ show_slacks

bool show_slacks {true}

Determines whether the values of the intermediate (slack) variables are also displayed in the graph.

◆ show_vars

bool show_vars {true}

Determines whether the solution values for decision variables in each set are shown.


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