Struct RegisteredOptions 

pub struct RegisteredOptions { /* private fields */ }

Mirrors RegisteredOptions. Insertion-ordered registry of options.

Implementations

impl RegisteredOptions

pub fn new() -> Rc<Self>

pub fn set_registering_category(&self, category: impl Into<String>)

pub fn add_number_option( &self, name: &str, short_description: &str, default_value: Number, long_description: &str, ) -> Result<Rc<RegisteredOption>, SolverException>

pub fn add_lower_bounded_number_option( &self, name: &str, short_description: &str, lower: Number, strict: bool, default_value: Number, long_description: &str, ) -> Result<Rc<RegisteredOption>, SolverException>

pub fn add_bounded_number_option( &self, name: &str, short_description: &str, lower: Number, lower_strict: bool, upper: Number, upper_strict: bool, default_value: Number, long_description: &str, ) -> Result<Rc<RegisteredOption>, SolverException>

pub fn add_integer_option( &self, name: &str, short_description: &str, default_value: Index, long_description: &str, ) -> Result<Rc<RegisteredOption>, SolverException>

pub fn add_lower_bounded_integer_option( &self, name: &str, short_description: &str, lower: Index, default_value: Index, long_description: &str, ) -> Result<Rc<RegisteredOption>, SolverException>

pub fn add_bounded_integer_option( &self, name: &str, short_description: &str, lower: Index, upper: Index, default_value: Index, long_description: &str, ) -> Result<Rc<RegisteredOption>, SolverException>

pub fn add_string_option( &self, name: &str, short_description: &str, default_value: &str, valid: &[(&str, &str)], long_description: &str, ) -> Result<Rc<RegisteredOption>, SolverException>

pub fn add_bool_option( &self, name: &str, short_description: &str, default_yes: bool, long_description: &str, ) -> Result<Rc<RegisteredOption>, SolverException>

Convenience: yes/no option, default default_yes ? “yes” : “no”.

pub fn get_option(&self, name: &str) -> Option<Rc<RegisteredOption>>

Mirrors GetOption(name). If name contains a ., only the suffix after the last . is looked up — this is how upstream validates prefixed option-file lines like resto.tol.

pub fn registered_options_in_order(&self) -> Vec<Rc<RegisteredOption>>

Returns options in registration order.

pub fn print_options_documentation( &self, mode: PrintOptionsMode, include_advanced: bool, ) -> String

Render the registry as human-readable text grouped by category. The output mirrors the categories produced by Ipopt’s RegisteredOptions::OutputOptionDocumentation. Options whose short and long descriptions are both empty are dropped from the listing. include_advanced controls whether options flagged advanced appear (none in pounce today, but the gate is honored so the flag stays meaningful for future additions).

Set mode via PrintOptionsMode; Text is the default. Latex / Doxygen are accepted (they prepend a one-line note that they currently fall through to the text formatter) so scripts that pass them through unconditionally still produce readable output.

Trait Implementations

impl Debug for RegisteredOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RegisteredOptions

fn default() -> RegisteredOptions

Returns the “default value” for a type.