ClarabelSolver

Struct ClarabelSolver 

Source
pub struct ClarabelSolver<DemandId, PortfolioId, ProductId>(/* private fields */);
Expand description

A solver implementation that uses the Clarabel interior point method for quadratic programming to solve the market clearing problem.

This solver is generally more accurate but can be slower than ADMM-based solvers for large problems. It’s a good choice when high precision is needed.

Implementations§

Source§

impl<A, B, C> ClarabelSolver<A, B, C>

Source

pub fn new(settings: DefaultSettings<f64>) -> Self

create a new solver with the given settings

Trait Implementations§

Source§

impl<A, B, C> Default for ClarabelSolver<A, B, C>

Source§

fn default() -> Self

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

impl<DemandId: Clone + Eq + Hash + Ord + Send + Sync + 'static, PortfolioId: Clone + Eq + Hash + Ord + Send + Sync + 'static, ProductId: Clone + Eq + Hash + Ord + Send + Sync + 'static> Solver<DemandId, PortfolioId, ProductId> for ClarabelSolver<DemandId, PortfolioId, ProductId>

Source§

type Error = JoinError

Error type for solver failures
Source§

type PortfolioOutcome = PortfolioOutcome

A solver will produce outcomes for a portfolio. This should, at a minimum, include the optimal trade rate. It might also include the effective portfolio price, as well as other aggregated statistics.
Source§

type ProductOutcome = ProductOutcome

A solver will produce outcomes for a product. This should, at a minimum, include the clearing price. It might also include the total speed of trade, as well as other aggregated statistics.
Source§

type State = ()

A solver may leverage additional data to generate a solution, such as a previous batch’s prices and trades. Read more
Source§

async fn solve( &self, demand_curves: Map<DemandId, DemandCurve>, portfolios: Map<PortfolioId, (DemandGroup<DemandId>, ProductGroup<ProductId>)>, _state: Self::State, ) -> Result<(Map<PortfolioId, Self::PortfolioOutcome>, Map<ProductId, Self::ProductOutcome>), Self::Error>

Produce a solution given the batch inputs and the solver state. Read more

Auto Trait Implementations§

§

impl<DemandId, PortfolioId, ProductId> Freeze for ClarabelSolver<DemandId, PortfolioId, ProductId>

§

impl<DemandId, PortfolioId, ProductId> RefUnwindSafe for ClarabelSolver<DemandId, PortfolioId, ProductId>
where DemandId: RefUnwindSafe, PortfolioId: RefUnwindSafe, ProductId: RefUnwindSafe,

§

impl<DemandId, PortfolioId, ProductId> Send for ClarabelSolver<DemandId, PortfolioId, ProductId>
where DemandId: Send, PortfolioId: Send, ProductId: Send,

§

impl<DemandId, PortfolioId, ProductId> Sync for ClarabelSolver<DemandId, PortfolioId, ProductId>
where DemandId: Sync, PortfolioId: Sync, ProductId: Sync,

§

impl<DemandId, PortfolioId, ProductId> Unpin for ClarabelSolver<DemandId, PortfolioId, ProductId>
where DemandId: Unpin, PortfolioId: Unpin, ProductId: Unpin,

§

impl<DemandId, PortfolioId, ProductId> UnwindSafe for ClarabelSolver<DemandId, PortfolioId, ProductId>
where DemandId: UnwindSafe, PortfolioId: UnwindSafe, ProductId: 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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