Struct nyx_space::md::opti::target_variable::Variable

pub struct Variable {
    pub component: Vary,
    pub perturbation: f64,
    pub init_guess: f64,
    pub max_step: f64,
    pub max_value: f64,
    pub min_value: f64,
    pub frame: Option<Frame>,
}

Fields

component: Vary

The component that will be varied in the targeter

perturbation: f64

The perturbation for the finite differencing algorithm

init_guess: f64

The initial guess of this variable

max_step: f64

The maximum step this variable may have between each iteration

max_value: f64

The absolute maximum value this parameter can ever have

min_value: f64

The absolute minimum value this parameter can ever have

frame: Option<Frame>

The frame in which this variable should be applied, must be either a local frame or inertial

Implementations

impl Variable

pub fn valid(&self) -> Result<(), TargetingError>

Returns whether the configuration of this variable is valid

pub fn with_initial_guess(self, guess: f64) -> Self

pub fn with_pert(self, pert: f64) -> Self

pub fn with_min(self, min_val: f64) -> Self

pub fn with_max(self, max_val: f64) -> Self

pub fn apply_bounds(&self, val: f64) -> f64

Ensure that val is within the variable bounds

pub fn ensure_bounds(&self, val: &mut f64)

Ensure that val is within the variable bounds

pub fn check_bounds(&self, val: f64) -> (f64, bool)

Returns the input value unless it is out of bounds, then it returns the bound, and whether the input value was OK

Trait Implementations

impl Clone for Variable

fn clone(&self) -> Variable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Variable

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

Formats the value using the given formatter.

impl Default for Variable

fn default() -> Self

Returns the “default value” for a type.

impl Display for Variable

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

Formats the value using the given formatter.

impl From<Vary> for Variable

fn from(vary: Vary) -> Self

Converts to this type from the input type.

impl PartialEq<Variable> for Variable

fn eq(&self, other: &Variable) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Variable

impl StructuralPartialEq for Variable