Struct nyx_space::md::objective::Objective

source · [−]

pub struct Objective {
    pub parameter: StateParameter,
    pub desired_value: f64,
    pub tolerance: f64,
    pub multiplicative_factor: f64,
    pub additive_factor: f64,
}

Expand description

Defines a state parameter event finder

Fields

parameter: StateParameter

The state parameter to target

desired_value: f64

The desired self.desired_value, must be in the same units as the state parameter

tolerance: f64

The precision on the desired value

multiplicative_factor: f64

A multiplicative factor this parameter’s error in the targeting (defaults to 1.0)

additive_factor: f64

An additive factor to this parameters’s error in the targeting (defaults to 0.0)

Implementations

source

impl Objective

source

pub fn new(parameter: StateParameter, desired_value: f64) -> Self

Match a specific value for the parameter. By default, the tolerance on the parameter is 0.1 times whatever unit is the default for that parameter. For example, a radius event will seek the requested value at the decimeter level, and an angle event will seek it at the tenth of a degree.

source

pub fn within_tolerance(
    parameter: StateParameter,
    desired_value: f64,
    tolerance: f64
) -> Self

Match a specific value for the parameter to hit the specified value with the provided tolerance on the value

source

pub fn assess(&self, achieved: OrbitPartial) -> (bool, f64 )

Returns whether this objective has been achieved, and the associated parameter error.

source

pub fn assess_raw(&self, achieved: f64) -> (bool, f64 )

Returns whether this objective has been achieved, and the associated parameter error. Warning: the parameter achieved must be in the same unit as the objective.

Trait Implementations

source

impl Clone for Objective

source

fn clone(&self) -> Objective

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Objective

source

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

Formats the value using the given formatter. Read more

source

impl Display for Objective

source

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

Formats the value using the given formatter. Read more

source

impl LowerHex for Objective

source

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

Formats the value using the given formatter.

source

impl Copy for Objective

Auto Trait Implementations

impl RefUnwindSafe for Objective

impl Send for Objective

impl Sync for Objective

impl Unpin for Objective

impl UnwindSafe for Objective

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

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

impl<T> Printing<T> for T where
T: Display,

fn to_str(self) -> String

Method to serialize generic items, slices, and slices of Vecs. Can be also implemented on any other types. Read more

fn gr(self) -> String

Method to serialize and render the resulting string in bold green. This is the default implementation applicable to all types that trait Printing is implemented for Read more

fn red(self) -> String

Method to serialize and render the resulting string in bold red.

impl<T> Same<T> for T

type Output = T

Should always be Self

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

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

fn from_subset(element: &SS) -> SP

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

source

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

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)

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

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

source

impl<T> ToString for T where
T: Display + ?Sized,

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct nyx_space::md::objective::Objective

Fields

Implementations

impl Objective

pub fn new(parameter: StateParameter, desired_value: f64) -> Self

pub fn within_tolerance( parameter: StateParameter, desired_value: f64, tolerance: f64) -> Self

pub fn assess(&self, achieved: OrbitPartial) -> (bool, f64)

pub fn assess_raw(&self, achieved: f64) -> (bool, f64)

Trait Implementations

impl Clone for Objective

fn clone(&self) -> Objective

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

impl Debug for Objective

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

impl Display for Objective

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

impl LowerHex for Objective

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

impl Copy for Objective

Auto Trait Implementations

impl RefUnwindSafe for Objective

impl Send for Objective

impl Sync for Objective

impl Unpin for Objective

impl UnwindSafe for Objective

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize

type Init = T

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

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

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

unsafe fn drop(ptr: usize)

impl<T> Printing<T> for T where T: Display,

fn to_str(self) -> String

fn gr(self) -> String

fn red(self) -> String

impl<T> Same<T> for T

type Output = T

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

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

fn is_in_subset(&self) -> bool

fn to_subset_unchecked(&self) -> SS

fn from_subset(element: &SS) -> SP

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

type Owned = T

fn to_owned(&self) -> T

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

impl<T> ToString for T where T: Display + ?Sized,

default fn to_string(&self) -> String

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

type Error = Infallible

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

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

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

fn vzip(self) -> V

pub fn within_tolerance(
parameter: StateParameter,
desired_value: f64,
tolerance: f64
) -> Self

pub fn assess(&self, achieved: OrbitPartial) -> (bool, f64 )

pub fn assess_raw(&self, achieved: f64) -> (bool, f64 )

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, U> Into<U> for T where
U: From<T>,

impl<T> Printing<T> for T where
T: Display,

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

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

impl<T> ToString for T where
T: Display + ?Sized,

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