Skip to main content

Nlp

Struct Nlp 

Source
pub struct Nlp<P: Problem> { /* private fields */ }
Expand description

Builder: Nlp::new(problem) then .var_bounds(..) / .x0(..) (which fix the number of variables) and .solve().

Implementations§

Source§

impl<P: Problem + 'static> Nlp<P>

Source

pub fn new(problem: P) -> Self

A new builder for problem. The number of variables is inferred from the first of var_bounds / x0 you set (they must agree); the number of constraints comes from Problem::n_constraints. Variable bounds default to ±∞, constraint bounds to 0, and x0 to the origin.

Source

pub fn var_bounds(self, lo: &[f64], hi: &[f64]) -> Self

Variable bounds x_l ≤ x ≤ x_u (use ±2e19 for ∞). Fixes the number of variables.

Source

pub fn constraint_bounds(self, lo: &[f64], hi: &[f64]) -> Self

Constraint bounds g_l ≤ g(x) ≤ g_u (g_l == g_u is an equality).

Source

pub fn x0(self, x0: &[f64]) -> Self

Initial guess. Fixes the number of variables.

Source

pub fn option_num(self, tag: &str, value: f64) -> Self

A numeric solver option (e.g. ("tol", 1e-8)).

Source

pub fn option_int(self, tag: &str, value: i32) -> Self

An integer solver option (e.g. ("max_iter", 500)).

Source

pub fn option_str(self, tag: &str, value: &str) -> Self

A string solver option (e.g. ("mu_strategy", "adaptive")).

Source

pub fn capture_iterations(self) -> Self

Record the per-iteration trajectory: one IterRecord per Newton iteration into Solution::stats.iterations (empty without this call).

Interior-point solves only, since the per-iteration event is emitted by the IPM engine, so on the active-set SQP engine (solver_selection=qp-active-set/algorithm=active-set-sqp) stats.iterations stays empty even though stats.iteration_count still reports the iterations run.

Source

pub fn solve(self) -> Solution

Build the TNLP adapter and run the interior-point solver.

§Panics

If the number of variables was never fixed (no var_bounds or x0).

Auto Trait Implementations§

§

impl<P> Freeze for Nlp<P>
where P: Freeze,

§

impl<P> RefUnwindSafe for Nlp<P>
where P: RefUnwindSafe,

§

impl<P> Send for Nlp<P>
where P: Send,

§

impl<P> Sync for Nlp<P>
where P: Sync,

§

impl<P> Unpin for Nlp<P>
where P: Unpin,

§

impl<P> UnsafeUnpin for Nlp<P>
where P: UnsafeUnpin,

§

impl<P> UnwindSafe for Nlp<P>
where P: UnwindSafe,

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

Source§

fn by_ref(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more