Struct nyx_space::md::objective::Objective

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§

impl Objective

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.

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

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

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

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§

impl Clone for Objective

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

impl Debug for Objective

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

Formats the value using the given formatter. Read more

impl Display for Objective

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

Formats the value using the given formatter. Read more

impl LowerHex for Objective

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

Formats the value using the given formatter.

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 Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for Twhere 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 = mem::align_of::<T>()

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 Twhere T: Display,

fn to_str(self) -> String

Method to serialize. Decorates Vecs with square brackets and tuples with round ones. Implementation code is in printing.rs.

fn to_plainstr(self) -> String

Method to serialize in minimal form (space separated, no brackets) Implementation code is in printing.rs.

fn rd(self) -> String

Printable in red

fn gr(self) -> String

Printable in green

fn bl(self) -> String

Printable in blue

fn yl(self) -> String

Printable in yellow

fn mg(self) -> String

Printable in magenta

fn cy(self) -> String

Printable in cyan

fn wvec(self, f: &mut File) -> Result<(), Error>

Method to write vector(s) to file f (space separated, without brackets). Passes up io errors

fn pvec(self)

Method to print vector(s) to stdout (space separated,without brackets).

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SPwhere 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.

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for Twhere 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<U>>::Error>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · source§

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

Performs the conversion.

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

fn vzip(self) -> V