Struct HypervolumeCalculator 

pub struct HypervolumeCalculator<T: Float + Debug + Send + Sync + 'static> { /* private fields */ }

Hypervolume calculator

Implementations

impl<T: Float + Debug + Send + Sync + 'static> HypervolumeCalculator<T>

pub const DEFAULT_MONTE_CARLO_SAMPLES: usize = 100_000

Default number of Monte Carlo samples.

pub fn new(method: HypervolumeMethod, reference_point: Vec<T>) -> Self

Create a calculator for method measuring against reference_point (expressed in the pure-minimization convention).

pub fn method(&self) -> HypervolumeMethod

The configured calculation method.

pub fn reference_point(&self) -> &[T]

The reference point currently in use.

pub fn set_reference_point(&mut self, reference_point: Vec<T>)

Replace the reference point. The cache is invalidated because cached values are only meaningful for the reference they were computed against.

pub fn set_monte_carlo_samples(&mut self, samples: usize)

Configure the Monte Carlo sample count (ignored by the exact methods).

pub fn clear_cache(&mut self)

Drop every cached hypervolume.

pub fn calculate(&mut self, points: &[Vec<T>]) -> Result<T>

Compute the hypervolume of points (pure-minimization convention).

Returns an error rather than a fabricated number when the reference point is missing or a point has fewer objectives than the reference.

pub fn contribution(&mut self, points: &[Vec<T>], index: usize) -> Result<T>

Exclusive hypervolume contribution of points[index]: how much hypervolume is lost when that single point is removed. This is the quantity SMS-EMOA’s environmental selection ranks on.

Trait Implementations

impl<T: Debug + Float + Debug + Send + Sync + 'static> Debug for HypervolumeCalculator<T>

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

Formats the value using the given formatter.