Skip to main content

SolveStats

Struct SolveStats 

Source
pub struct SolveStats {
    pub iterations: u32,
    pub duration_us: u64,
    pub peak_memory: u64,
}
Expand description

Statistics from a solve operation.

Tracks performance metrics from solver execution including iteration count, timing, and memory usage.

§Builder Pattern

SolveStats supports a builder pattern for convenient construction:

use xlog_solve::SolveStats;

let stats = SolveStats::default()
    .with_iterations(100)
    .with_duration_us(5000)
    .with_peak_memory(1024);

assert_eq!(stats.iterations, 100);
assert_eq!(stats.duration_us, 5000);
assert_eq!(stats.peak_memory, 1024);

Fields§

§iterations: u32

Number of iterations performed by the solver.

For iterative solvers (like CLS), this is the number of gradient descent steps. For CDCL solvers, this might be the number of decisions or conflicts.

§duration_us: u64

Wall-clock time spent solving, in microseconds.

This includes all solver operations but typically excludes instance setup and result extraction.

§peak_memory: u64

Peak memory usage during solving, in bytes.

This tracks the maximum memory allocated by the solver, useful for profiling and resource management.

Implementations§

Source§

impl SolveStats

Source

pub const fn new(iterations: u32, duration_us: u64, peak_memory: u64) -> Self

Creates new statistics with all fields specified.

§Arguments
  • iterations - Number of solver iterations
  • duration_us - Solve time in microseconds
  • peak_memory - Peak memory usage in bytes
§Example
use xlog_solve::SolveStats;

let stats = SolveStats::new(100, 5000, 1024);
assert_eq!(stats.iterations, 100);
Source

pub const fn with_iterations(self, iterations: u32) -> Self

Sets the iteration count, consuming and returning self.

§Example
use xlog_solve::SolveStats;

let stats = SolveStats::default().with_iterations(100);
assert_eq!(stats.iterations, 100);
Source

pub const fn with_duration_us(self, duration_us: u64) -> Self

Sets the duration in microseconds, consuming and returning self.

§Example
use xlog_solve::SolveStats;

let stats = SolveStats::default().with_duration_us(5000);
assert_eq!(stats.duration_us, 5000);
Source

pub const fn with_peak_memory(self, peak_memory: u64) -> Self

Sets the peak memory usage in bytes, consuming and returning self.

§Example
use xlog_solve::SolveStats;

let stats = SolveStats::default().with_peak_memory(1024);
assert_eq!(stats.peak_memory, 1024);
Source

pub const fn duration_ms(&self) -> u64

Returns the duration in milliseconds (rounded down).

§Example
use xlog_solve::SolveStats;

let stats = SolveStats::new(0, 5500, 0);
assert_eq!(stats.duration_ms(), 5);
Source

pub fn duration_secs(&self) -> f64

Returns the duration in seconds as a floating-point value.

§Example
use xlog_solve::SolveStats;

let stats = SolveStats::new(0, 1_500_000, 0);
assert_eq!(stats.duration_secs(), 1.5);
Source

pub fn iterations_per_sec(&self) -> f64

Returns iterations per second (throughput).

Returns 0.0 if duration is zero.

§Example
use xlog_solve::SolveStats;

let stats = SolveStats::new(1000, 1_000_000, 0);
assert_eq!(stats.iterations_per_sec(), 1000.0);

Trait Implementations§

Source§

impl Clone for SolveStats

Source§

fn clone(&self) -> SolveStats

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 SolveStats

Source§

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

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

impl Default for SolveStats

Source§

fn default() -> SolveStats

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

impl PartialEq for SolveStats

Source§

fn eq(&self, other: &SolveStats) -> 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 Copy for SolveStats

Source§

impl Eq for SolveStats

Source§

impl StructuralPartialEq for SolveStats

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
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. 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, 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.
§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,