HardSoftScore

Struct HardSoftScore 

Source
pub struct HardSoftScore { /* private fields */ }
Expand description

A score with separate hard and soft constraint levels.

Hard constraints must be satisfied for a solution to be feasible. Soft constraints are optimization objectives.

When comparing scores:

  1. Hard scores are compared first
  2. Soft scores are only compared when hard scores are equal

§Examples

use solverforge_core::HardSoftScore;

let score1 = HardSoftScore::of(-1, -100);  // 1 hard constraint broken
let score2 = HardSoftScore::of(0, -200);   // Feasible but poor soft score

// Feasible solutions are always better than infeasible ones
assert!(score2 > score1);

let score3 = HardSoftScore::of(0, -50);    // Better soft score
assert!(score3 > score2);

Implementations§

Source§

impl HardSoftScore

Source

pub const ZERO: HardSoftScore

The zero score.

Source

pub const ONE_HARD: HardSoftScore

One hard constraint penalty.

Source

pub const ONE_SOFT: HardSoftScore

One soft constraint penalty.

Source

pub const fn of(hard: i64, soft: i64) -> Self

Creates a new HardSoftScore.

Source

pub const fn of_hard(hard: i64) -> Self

Creates a score with only a hard component.

Source

pub const fn of_soft(soft: i64) -> Self

Creates a score with only a soft component.

Source

pub const fn hard(&self) -> i64

Returns the hard score component.

Source

pub const fn soft(&self) -> i64

Returns the soft score component.

Source

pub const fn hard_score(&self) -> HardSoftScore

Returns the hard score as a new HardSoftScore.

Source

pub const fn soft_score(&self) -> HardSoftScore

Returns the soft score as a new HardSoftScore.

Trait Implementations§

Source§

impl Add for HardSoftScore

Source§

type Output = HardSoftScore

The resulting type after applying the + operator.
Source§

fn add(self, other: Self) -> Self

Performs the + operation. Read more
Source§

impl Clone for HardSoftScore

Source§

fn clone(&self) -> HardSoftScore

Returns a duplicate 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 HardSoftScore

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for HardSoftScore

Source§

fn default() -> HardSoftScore

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

impl Display for HardSoftScore

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Hash for HardSoftScore

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Neg for HardSoftScore

Source§

type Output = HardSoftScore

The resulting type after applying the - operator.
Source§

fn neg(self) -> Self

Performs the unary - operation. Read more
Source§

impl Ord for HardSoftScore

Source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl ParseableScore for HardSoftScore

Source§

fn parse(s: &str) -> Result<Self, ScoreParseError>

Parses a score from a string representation. Read more
Source§

fn to_string_repr(&self) -> String

Returns the string representation of this score.
Source§

impl PartialEq for HardSoftScore

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for HardSoftScore

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Score for HardSoftScore

Source§

fn is_feasible(&self) -> bool

Returns true if this score represents a feasible solution. Read more
Source§

fn zero() -> Self

Returns the zero score (identity element for addition).
Source§

fn levels_count() -> usize

Returns the number of score levels. Read more
Source§

fn to_level_numbers(&self) -> Vec<i64>

Returns the score values as a vector of i64. Read more
Source§

fn from_level_numbers(levels: &[i64]) -> Self

Creates a score from level numbers. Read more
Source§

fn multiply(&self, multiplicand: f64) -> Self

Multiplies this score by a scalar.
Source§

fn divide(&self, divisor: f64) -> Self

Divides this score by a scalar.
Source§

fn abs(&self) -> Self

Returns the absolute value of this score.
Source§

fn compare(&self, other: &Self) -> Ordering

Compares two scores, returning the ordering. Read more
Source§

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

Returns true if this score is better than the other score. Read more
Source§

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

Returns true if this score is worse than the other score.
Source§

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

Returns true if this score is equal to the other score.
Source§

impl Sub for HardSoftScore

Source§

type Output = HardSoftScore

The resulting type after applying the - operator.
Source§

fn sub(self, other: Self) -> Self

Performs the - operation. Read more
Source§

impl Copy for HardSoftScore

Source§

impl Eq for HardSoftScore

Source§

impl StructuralPartialEq for HardSoftScore

Auto Trait Implementations§

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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.

Source§

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

Source§

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)

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

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

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.