pub struct OptimizationEngine { /* private fields */ }Expand description
Optimization engine
Implementations§
Source§impl OptimizationEngine
impl OptimizationEngine
Sourcepub fn new() -> Self
pub fn new() -> Self
Creates a OptimizationEngine with empty registries / default configuration.
Sourcepub fn initialize(&mut self) -> Result<(), FinancialError>
pub fn initialize(&mut self) -> Result<(), FinancialError>
Readies the OptimizationEngine sub-components; registers/populates any built-in defaults.
Sourcepub fn add_algorithm(&mut self, algorithm: OptimizationAlgorithm)
pub fn add_algorithm(&mut self, algorithm: OptimizationAlgorithm)
Registers algorithm in the registry (keyed by its id).
Sourcepub fn get_algorithm(
&self,
algorithm_id: &str,
) -> Option<&OptimizationAlgorithm>
pub fn get_algorithm( &self, algorithm_id: &str, ) -> Option<&OptimizationAlgorithm>
Looks up algorithm by id; None if not registered.
Sourcepub fn list_algorithms(&self) -> Vec<String>
pub fn list_algorithms(&self) -> Vec<String>
Iterates over all registered algorithms entries.
Sourcepub fn add_objective_function(&mut self, function: ObjectiveFunction)
pub fn add_objective_function(&mut self, function: ObjectiveFunction)
Registers objective function in the registry (keyed by its id).
Sourcepub fn get_objective_function(
&self,
function_id: &str,
) -> Option<&ObjectiveFunction>
pub fn get_objective_function( &self, function_id: &str, ) -> Option<&ObjectiveFunction>
Looks up objective function by id; None if not registered.
Sourcepub fn list_objective_functions(&self) -> Vec<String>
pub fn list_objective_functions(&self) -> Vec<String>
Iterates over all registered objective functions entries.
Sourcepub fn add_constraint(&mut self, constraint: OptimizationConstraint)
pub fn add_constraint(&mut self, constraint: OptimizationConstraint)
Registers constraint in the registry (keyed by its id).
Sourcepub fn list_constraints(&self) -> &[OptimizationConstraint]
pub fn list_constraints(&self) -> &[OptimizationConstraint]
Iterates over all registered constraints entries.
Auto Trait Implementations§
impl Freeze for OptimizationEngine
impl RefUnwindSafe for OptimizationEngine
impl Send for OptimizationEngine
impl Sync for OptimizationEngine
impl Unpin for OptimizationEngine
impl UnsafeUnpin for OptimizationEngine
impl UnwindSafe for OptimizationEngine
Blanket Implementations§
§impl<S, A> Aggregate<Result<S, Error>> for Awhere
A: Aggregate<S>,
impl<S, A> Aggregate<Result<S, Error>> for Awhere
A: Aggregate<S>,
Aggregate shares in an MPC protocol.
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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