Struct Provided 

#[non_exhaustive]
pub struct Provided {
    pub gradient: bool,
    pub inequalities: usize,
    pub constraint_jacobian: bool,
}

What a fitness function gives besides the fitness, for every genome: the answer of FitnessFunction::provides.

Nothing by default. More extras (equality constraints, residuals) come in later versions, so the struct is #[non_exhaustive]: build it from Provided::NOTHING or Provided::GRADIENT and the with_ methods.

use genoxide::engine::Provided;

assert!(Provided::NOTHING.is_empty());
assert!(Provided::NOTHING.with_gradient().gradient);
assert_eq!(Provided::default(), Provided::NOTHING);
// a score with its gradient, 2 inequality constraints g(x) <= 0 and their Jacobian
let all = Provided::GRADIENT.with_inequalities(2).with_constraint_jacobian();
assert_eq!(all.inequalities, 2);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

gradient: bool

The gradient of the score, ∂score / ∂xᵢ, one value per gene: of the score as the fitness function returns it, whether it’s minimized or maximized.

inequalities: usize

The number of inequality constraints gᵢ(x) ≤ 0 whose values gᵢ(x) the function gives, in the same order for every genome; 0 for none. The fitness’s violation should then be Σ max(0, gᵢ(x)), as constraint::at_most measures it.

constraint_jacobian: bool

The Jacobian of the inequality constraints: ∂gᵢ / ∂xⱼ, a row of one value per gene for each constraint.

Implementations

impl Provided

pub const NOTHING: Self

Nothing besides the fitness.

pub const GRADIENT: Self

The gradient of the score.

pub const fn with_gradient(self) -> Self

These extras and the gradient.

pub const fn with_inequalities(self, count: usize) -> Self

These extras and the values of count inequality constraints.

pub const fn with_constraint_jacobian(self) -> Self

These extras and the Jacobian of the inequality constraints.

pub const fn is_empty(self) -> bool

Whether nothing is provided besides the fitness.

Trait Implementations

impl Clone for Provided

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Provided

impl Debug for Provided

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

Formats the value using the given formatter.

impl Default for Provided

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Provided

Available on crate feature serde only.

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Provided

impl Hash for Provided

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Provided

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Provided

Available on crate feature serde only.

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Provided