Struct smoothed_online_convex_optimization::algorithms::offline::OfflineOptions[−][src]

pub struct OfflineOptions {
    pub inverted: bool,
    pub alpha: f64,
    pub l: Option<f64>,
}

Expand description

Configuration of offline algorithms.

Fields

inverted: bool

Compute inverted movement costs (SSCO only).

alpha: f64

Compute the $\alpha$-unfair offline optimum.

l: Option<f64>

Compute the $L$-constrained offline optimum (convex_optimization only).

Implementations

[src]

pub fn new(inverted: bool, alpha: f64, l: Option<f64>) -> Self

Trait Implementations

[src]

impl Clone for OfflineOptions

[src]

fn clone(&self) -> OfflineOptions

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

[src]

impl Debug for OfflineOptions

[src]

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

Formats the value using the given formatter. Read more

[src]

impl Default for OfflineOptions

[src]

fn default() -> Self

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

[src]

impl IntoPy<Py<PyAny>> for OfflineOptions

[src]

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

[src]

impl PyClass for OfflineOptions

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict. Read more

[src]

impl PyClassDescriptors<OfflineOptions> for PyClassImplCollector<OfflineOptions>

[src]

fn py_class_descriptors(self) -> &'static [PyMethodDefType ]

[src]

impl PyClassImpl for OfflineOptions

[src]

const DOC: &'static str

Class doc string

[src]

const IS_GC: bool

#[pyclass(gc)]

[src]

const IS_BASETYPE: bool

#[pyclass(subclass)]

[src]

const IS_SUBCLASS: bool

#[pyclass(extends=…)]

type Layout = PyCell<Self>

Layout

type BaseType = PyAny

Base class

type ThreadChecker = ThreadCheckerStub<OfflineOptions>

This handles following two situations: Read more

[src]

fn for_each_method_def(visitor: &mut dyn FnMut(&[PyMethodDefType ]))

[src]

fn get_new() -> Option<newfunc>

[src]

fn get_alloc() -> Option<allocfunc>

[src]

fn get_free() -> Option<freefunc>

[src]

fn get_call() -> Option<PyCFunctionWithKeywords>

[src]

fn for_each_proto_slot(visitor: &mut dyn FnMut(&[PyType_Slot ]))

[src]

fn get_buffer() -> Option<&'static PyBufferProcs>

[src]

impl PyClassNewImpl<OfflineOptions> for PyClassImplCollector<OfflineOptions>

[src]

fn new_impl(self) -> Option<newfunc>

[src]

impl PyMethods<OfflineOptions> for PyClassImplCollector<OfflineOptions>

[src]

fn py_methods(self) -> &'static [PyMethodDefType ]

[src]

impl PyTypeInfo for OfflineOptions

type AsRefTarget = PyCell<Self>

Utility type to make Py::as_ref work.

[src]

const NAME: &'static str

Class name.

[src]

const MODULE: Option<&'static str>

Module name, if any.

[src]

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

PyTypeObject instance for this type.

[src]

fn is_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type or a subclass of this type.

[src]

fn is_exact_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type.

Auto Trait Implementations

impl RefUnwindSafe for OfflineOptions

impl Send for OfflineOptions

impl Sync for OfflineOptions

impl Unpin for OfflineOptions

impl UnwindSafe for OfflineOptions

Blanket Implementations

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

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

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

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

[src]

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

Mutably borrows from an owned value. Read more

[src]

impl<T, P, C, D, U> DefaultGivenOnlineProblem<T, P, C, D> for U where
 C: ModelOutputSuccess,
 P: Problem<T, C, D>,
 D: ModelOutputFailure,
 U: Default,

[src]

pub fn default(&Online) -> U

[src]

impl<T, P, C, D, U> DefaultGivenProblem<T, P, C, D> for U where
 C: ModelOutputSuccess,
 P: Problem<T, C, D>,
 D: ModelOutputFailure,
 U: Default,

[src]

pub fn default(&P) -> U

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<'a, T> FromPyObject<'a> for T where
T: PyClass + Clone,

[src]

pub fn extract(obj: &'a PyAny) -> Result<T, PyErr>

Extracts Self from the source PyObject.

[src]

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

[src]

pub fn into(self) -> U

Performs the conversion.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

[src]

impl<T> PyErrArguments for T where
T: IntoPy<Py<PyAny>> + Send + Sync,

[src]

pub fn arguments(self, py: Python<'_>) -> Py<PyAny>

Arguments for exception

[src]

impl<T> PyTypeObject for T where
T: PyTypeInfo,

[src]

pub fn type_object(py: Python<'_>) -> &PyType

Returns the safe abstraction over the type object.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

pub fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

pub fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

pub fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

pub fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

pub fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

pub fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

pub fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

pub fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

[src]

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

type Owned = T

The resulting type after obtaining ownership.

[src]

pub fn to_owned(&self) -> T

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

[src]

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

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

[src]

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

type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

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

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V

[src]

impl<T, P, C, D, O> Options<T, P, C, D> for O where
 C: ModelOutputSuccess,
 P: Problem<T, C, D>,
 D: ModelOutputFailure,
 O: Clone + DefaultGivenProblem<T, P, C, D> + Send,

Struct smoothed_online_convex_optimization::algorithms::offline::OfflineOptions[−][src]

Fields

Implementations

impl OfflineOptions

pub fn inverted() -> Self

pub fn alpha_unfair(alpha: f64) -> Self

pub fn l_constrained(l: f64) -> Self

impl OfflineOptions

pub fn new(inverted: bool, alpha: f64, l: Option<f64>) -> Self

Trait Implementations

impl Clone for OfflineOptions

fn clone(&self) -> OfflineOptions

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

impl Debug for OfflineOptions

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

impl Default for OfflineOptions

fn default() -> Self

impl IntoPy<Py<PyAny>> for OfflineOptions

fn into_py(self, py: Python<'_>) -> PyObject

impl PyClass for OfflineOptions

type Dict = PyClassDummySlot

type WeakRef = PyClassDummySlot

type BaseNativeType = PyAny

impl PyClassDescriptors<OfflineOptions> for PyClassImplCollector<OfflineOptions>

fn py_class_descriptors(self) -> &'static [PyMethodDefType]

impl PyClassImpl for OfflineOptions

const DOC: &'static str

const IS_GC: bool

const IS_BASETYPE: bool

const IS_SUBCLASS: bool

type Layout = PyCell<Self>

type BaseType = PyAny

type ThreadChecker = ThreadCheckerStub<OfflineOptions>

fn for_each_method_def(visitor: &mut dyn FnMut(&[PyMethodDefType]))

fn get_new() -> Option<newfunc>

fn get_alloc() -> Option<allocfunc>

fn get_free() -> Option<freefunc>

fn get_call() -> Option<PyCFunctionWithKeywords>

fn for_each_proto_slot(visitor: &mut dyn FnMut(&[PyType_Slot]))

fn get_buffer() -> Option<&'static PyBufferProcs>

impl PyClassNewImpl<OfflineOptions> for PyClassImplCollector<OfflineOptions>

fn new_impl(self) -> Option<newfunc>

impl PyMethods<OfflineOptions> for PyClassImplCollector<OfflineOptions>

fn py_methods(self) -> &'static [PyMethodDefType]

impl PyTypeInfo for OfflineOptions

type AsRefTarget = PyCell<Self>

const NAME: &'static str

const MODULE: Option<&'static str>

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

fn is_type_of(object: &PyAny) -> bool

fn is_exact_type_of(object: &PyAny) -> bool

Auto Trait Implementations

impl RefUnwindSafe for OfflineOptions

impl Send for OfflineOptions

impl Sync for OfflineOptions

impl Unpin for OfflineOptions

impl UnwindSafe for OfflineOptions

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T, P, C, D, U> DefaultGivenOnlineProblem<T, P, C, D> for U where C: ModelOutputSuccess, P: Problem<T, C, D>, D: ModelOutputFailure, U: Default,

pub fn default(&Online<P>) -> U

impl<T, P, C, D, U> DefaultGivenProblem<T, P, C, D> for U where C: ModelOutputSuccess, P: Problem<T, C, D>, D: ModelOutputFailure, U: Default,

pub fn default(&P) -> U

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<'a, T> FromPyObject<'a> for T where T: PyClass + Clone,

pub fn extract(obj: &'a PyAny) -> Result<T, PyErr>

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

pub fn into(self) -> U

impl<T> Pointable for T

pub const ALIGN: usize

type Init = T

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

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

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

fn py_class_descriptors(self) -> &'static [PyMethodDefType ]

fn for_each_method_def(visitor: &mut dyn FnMut(&[PyMethodDefType ]))

fn for_each_proto_slot(visitor: &mut dyn FnMut(&[PyType_Slot ]))

fn py_methods(self) -> &'static [PyMethodDefType ]

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

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

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

impl<T, P, C, D, U> DefaultGivenOnlineProblem<T, P, C, D> for U where
C: ModelOutputSuccess,
P: Problem<T, C, D>,
D: ModelOutputFailure,
U: Default,

impl<T, P, C, D, U> DefaultGivenProblem<T, P, C, D> for U where
C: ModelOutputSuccess,
P: Problem<T, C, D>,
D: ModelOutputFailure,
U: Default,

impl<'a, T> FromPyObject<'a> for T where
T: PyClass + Clone,

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

impl<T> PyErrArguments for T where
T: IntoPy<Py<PyAny>> + Send + Sync,

impl<T> PyTypeObject for T where
T: PyTypeInfo,

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

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

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

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

impl<T, P, C, D, O> Options<T, P, C, D> for O where
C: ModelOutputSuccess,
P: Problem<T, C, D>,
D: ModelOutputFailure,
O: Clone + DefaultGivenProblem<T, P, C, D> + Send,