Skip to main content

OptionsList

Struct OptionsList 

Source
pub struct OptionsList { /* private fields */ }
Expand description

Mirrors Ipopt::OptionsList.

Implementations§

Source§

impl OptionsList

Source

pub fn new() -> Self

Source

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

Source

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

Source

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

Source

pub fn clear(&mut self)

Source

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

Mirrors SetStringValue.

Source

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

Mirrors SetNumericValue.

Source

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

Mirrors SetIntegerValue.

Source

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

Mirrors SetBoolValue.

Source

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

Mirrors UnsetValue. Returns true if the value was removed.

Source

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.

Source

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

Mirrors GetNumericValue.

Source

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

Mirrors GetIntegerValue.

Source

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

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

Source

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.

Source

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.

Source

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

Source

pub fn print_list(&self) -> String

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

Source

pub fn print_user_options(&self) -> String

Mirrors PrintUserOptions.

Trait Implementations§

Source§

impl Clone for OptionsList

Source§

fn clone(&self) -> OptionsList

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OptionsList

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for OptionsList

Source§

fn default() -> OptionsList

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.