Struct TestSolver

pub struct TestSolver {}

A (non-working) solver useful for testing

Implements the Solver trait.

Implementations

impl TestSolver

pub fn new() -> TestSolver

Create an instance of TestSolver.

Example

use argmin::core::test_utils::TestSolver;

let solver = TestSolver::new();

Trait Implementations

impl Clone for TestSolver

fn clone(&self) -> TestSolver

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TestSolver

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

Formats the value using the given formatter.

impl Default for TestSolver

fn default() -> TestSolver

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TestSolver

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TestSolver

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<O> Solver<O, IterState<Vec<f64>, (), (), (), (), f64>> for TestSolver

fn name(&self) -> &str

Name of the solver. Mainly used in Observers.

fn next_iter( &mut self, _problem: &mut Problem<O>, state: IterState<Vec<f64>, (), (), (), (), f64>, ) -> Result<(IterState<Vec<f64>, (), (), (), (), f64>, Option<KV>), Error>

Computes a single iteration of the algorithm and has access to the optimization problem definition and the internal state of the solver. Returns an updated state and optionally a KV which holds key-value pairs used in Observers.

fn init( &mut self, _problem: &mut Problem<O>, state: I, ) -> Result<(I, Option<KV>), Error>

Initializes the algorithm.

fn terminate_internal(&mut self, state: &I) -> TerminationStatus

Checks whether basic termination reasons apply.

fn terminate(&mut self, _state: &I) -> TerminationStatus

Used to implement stopping criteria, in particular criteria which are not covered by (terminate_internal.

impl Copy for TestSolver

impl Eq for TestSolver

impl StructuralPartialEq for TestSolver