Struct ArgminCheckpoint

pub struct ArgminCheckpoint { /* private fields */ }

Checkpoint

Defines how often and where a checkpoint is saved.

Implementations

impl ArgminCheckpoint

pub fn new(directory: &str, mode: CheckpointMode) -> Result<Self, Error>

Define a new checkpoint

pub fn set_dir(&mut self, dir: &str)

Set directory of checkpoint

pub fn dir(&self) -> String

Get directory of checkpoint

pub fn set_name(&mut self, name: &str)

Set name of checkpoint

pub fn name(&self) -> String

Get name of checkpoint

pub fn set_mode(&mut self, mode: CheckpointMode)

Set mode of checkpoint

pub fn store<T: Serialize>( &self, executor: &T, filename: String, ) -> Result<(), Error>

Write checkpoint to disk

pub fn store_cond<T: Serialize>( &self, executor: &T, iter: u64, ) -> Result<(), Error>

Write checkpoint based on the desired CheckpointMode

Trait Implementations

impl Clone for ArgminCheckpoint

fn clone(&self) -> ArgminCheckpoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ArgminCheckpoint

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

Formats the value using the given formatter.

impl Default for ArgminCheckpoint

fn default() -> ArgminCheckpoint

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ArgminCheckpoint

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for ArgminCheckpoint

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 Ord for ArgminCheckpoint

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ArgminCheckpoint

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for ArgminCheckpoint

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for ArgminCheckpoint

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ArgminCheckpoint

impl StructuralPartialEq for ArgminCheckpoint