Struct OptionsList 

pub struct OptionsList { /* private fields */ }

Mirrors Ipopt::OptionsList.

Implementations

impl OptionsList

pub fn new() -> Self

pub fn with_registered(reg: Rc<RegisteredOptions>) -> Self

pub fn set_registered_options(&mut self, reg: Rc<RegisteredOptions>)

pub fn registered_options(&self) -> Option<Rc<RegisteredOptions>>

pub fn clear(&mut self)

pub fn names(&self) -> impl Iterator<Item = &str>

Every option name present in the list, lowercased, in sorted order.

“Present” means someone called a set_*_value for it — an unset option is absent here even though it reads back as its registered default. That distinction is the whole point of the accessor: it answers “what did this run actually mention?”, which is not a question get_*_value can answer.

pub fn set_string_value( &mut self, tag: &str, value: &str, allow_clobber: bool, dont_print: bool, ) -> Result<bool, SolverException>

Mirrors SetStringValue.

pub fn set_numeric_value( &mut self, tag: &str, value: Number, allow_clobber: bool, dont_print: bool, ) -> Result<bool, SolverException>

Mirrors SetNumericValue.

pub fn set_integer_value( &mut self, tag: &str, value: Index, allow_clobber: bool, dont_print: bool, ) -> Result<bool, SolverException>

Mirrors SetIntegerValue.

pub fn set_bool_value( &mut self, tag: &str, value: bool, allow_clobber: bool, dont_print: bool, ) -> Result<bool, SolverException>

Mirrors SetBoolValue.

pub fn unset_value(&mut self, tag: &str) -> bool

Mirrors UnsetValue. Returns true if the value was removed.

pub fn get_string_value( &self, tag: &str, prefix: &str, ) -> Result<(String, bool), SolverException>

Mirrors GetStringValue. Returns true if found in the list. Falls back to the registered default when not found.

pub fn get_numeric_value( &self, tag: &str, prefix: &str, ) -> Result<(Number, bool), SolverException>

Mirrors GetNumericValue.

pub fn get_integer_value( &self, tag: &str, prefix: &str, ) -> Result<(Index, bool), SolverException>

Mirrors GetIntegerValue.

pub fn get_bool_value( &self, tag: &str, prefix: &str, ) -> Result<(bool, bool), SolverException>

Mirrors GetBoolValue. Accepts "yes"/"no".

pub fn get_enum_value( &self, tag: &str, prefix: &str, ) -> Result<(Index, bool), SolverException>

Mirrors GetEnumValue. Returns the index of the value in the registered string list.

pub fn read_from_stream<R: Read>( &mut self, r: R, allow_clobber: bool, ) -> Result<(), SolverException>

Mirrors ReadFromStream. Parses an ipopt.opt-style file: whitespace-separated tag value pairs, # line comments, double-quoted tokens permitted.

pub fn read_from_str( &mut self, s: &str, allow_clobber: bool, ) -> Result<(), SolverException>

pub fn print_list(&self) -> String

Mirrors PrintList. One option per line: name value # used N times.

pub fn print_user_options(&self) -> String

Mirrors PrintUserOptions.

Trait Implementations

impl Clone for OptionsList

fn clone(&self) -> OptionsList

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OptionsList

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

Formats the value using the given formatter.

impl Default for OptionsList

fn default() -> OptionsList

Returns the “default value” for a type.