Skip to main content

WriteOptions

Struct WriteOptions 

Source
pub struct WriteOptions {
    pub format: NlFormat,
    pub precision: Option<u32>,
    pub comments: bool,
    pub nonfinite_strings: bool,
    pub aux_files: bool,
    pub functions: Vec<ImportedFunction>,
    pub suffixes: Vec<SuffixData>,
    pub defined_vars: Vec<DefinedVar>,
    pub dual_init: Vec<(u32, f64)>,
    pub complementarity: Vec<(usize, Complementarity)>,
}
Expand description

Options for the writer.

Default::default() matches the writer’s original behaviour: ASCII output with trailing \t# ... comments, shortest-round-trip numeric formatting, and an error on NaN/Inf constants.

Fields§

§format: NlFormat§precision: Option<u32>

None -> shortest round-trip (default Rust {} for f64). Some(n) -> n significant digits in scientific notation ({:.*e}, e.g. 3.142e0).

§comments: bool

Emit trailing \t# ... comments in the header and segment introducers (ASCII format only). Ignored in binary mode.

§nonfinite_strings: bool

When true, NaN/Inf numeric constants are emitted as Infinity / -Infinity / NaN strings (matching AMPL NL_LIB_GFMT). When false (default) the writer fails with IoError::InvalidNumber.

§aux_files: bool

When true, a write_nl_files call also emits the sibling <stub>.row (constraint names) and <stub>.col (variable names) files next to the .nl, and populates the header’s max_name_len fields.

§functions: Vec<ImportedFunction>

Imported function declarations (F segments). Empty by default.

§suffixes: Vec<SuffixData>

Suffix entries (S segments). Empty by default.

§defined_vars: Vec<DefinedVar>

Defined variables (V segments). Empty by default.

§dual_init: Vec<(u32, f64)>

Dual seeds (d segment), sparse (constraint_nl_index, value) pairs.

§complementarity: Vec<(usize, Complementarity)>

Complementarity entries for the r segment. Maps a constraint index to its complementarity info. Empty by default.

Implementations§

Source§

impl WriteOptions

Source

pub fn ascii() -> Self

ASCII with comments. Identity with Default::default().

Source

pub fn ascii_lean() -> Self

ASCII, no trailing comments. Slimmer files for production use.

Source

pub fn binary() -> Self

Binary b header. Comments are unused in binary mode.

Trait Implementations§

Source§

impl Clone for WriteOptions

Source§

fn clone(&self) -> WriteOptions

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 WriteOptions

Source§

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

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

impl Default for WriteOptions

Source§

fn default() -> Self

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.