serif::solver::continuation::Result< Report, Count > Struct Template Reference

Retain the last converged physical state separately from the requested endpoint and failed candidates. More...

#include <driver.hpp>

Collaboration diagram for serif::solver::continuation::Result< Report, Count >:

Public Member Functions
bool	converged () const noexcept
	A converged intermediate star does not certify the requested target.
const Report *	last_converged () const noexcept
	Inspect the owning last successful solve even when the target was not reached.
std::uint64_t	total_attempts () const noexcept
	Count starting qualification and every continuation correction, including failed attempts.
std::uint64_t	total_work () const noexcept
	Include all recorded nonlinear work rather than only successful stages.

Public Attributes
Status	status {Status::starting_star_failed}
std::string	message
std::array< double, Count >	target {}
std::optional< std::array< double, Count > >	accepted_coordinates
std::unique_ptr< Report >	accepted
std::unique_ptr< Report >	failed
std::vector< StageRecord< Count > >	stages
CoordinateCounters	counters {}
std::uint64_t	starting_attempts {}
std::uint64_t	starting_work {}
std::uint64_t	omitted_records {}
double	absolute_tolerance {}

Detailed Description

template<typename Report, std::size_t Count>
struct serif::solver::continuation::Result< Report, Count >

Retain the last converged physical state separately from the requested endpoint and failed candidates.

Member Function Documentation

converged()

template<typename Report, std::size_t Count>

bool serif::solver::continuation::Result< Report, Count >::converged ( ) const

inlinenodiscardnoexcept

A converged intermediate star does not certify the requested target.

last_converged()

template<typename Report, std::size_t Count>

const Report * serif::solver::continuation::Result< Report, Count >::last_converged ( ) const

inlinenodiscardnoexcept

Inspect the owning last successful solve even when the target was not reached.

total_attempts()

template<typename Report, std::size_t Count>

std::uint64_t serif::solver::continuation::Result< Report, Count >::total_attempts ( ) const

inlinenodiscardnoexcept

Count starting qualification and every continuation correction, including failed attempts.

total_work()

template<typename Report, std::size_t Count>

std::uint64_t serif::solver::continuation::Result< Report, Count >::total_work ( ) const

inlinenodiscardnoexcept

Include all recorded nonlinear work rather than only successful stages.

Member Data Documentation

absolute_tolerance

template<typename Report, std::size_t Count>

double serif::solver::continuation::Result< Report, Count >::absolute_tolerance {}

accepted

template<typename Report, std::size_t Count>

std::unique_ptr<Report> serif::solver::continuation::Result< Report, Count >::accepted

accepted_coordinates

template<typename Report, std::size_t Count>

std::optional<std::array<double, Count> > serif::solver::continuation::Result< Report, Count >::accepted_coordinates

counters

template<typename Report, std::size_t Count>

CoordinateCounters serif::solver::continuation::Result< Report, Count >::counters {}

failed

template<typename Report, std::size_t Count>

std::unique_ptr<Report> serif::solver::continuation::Result< Report, Count >::failed

message

template<typename Report, std::size_t Count>

std::string serif::solver::continuation::Result< Report, Count >::message

omitted_records

template<typename Report, std::size_t Count>

std::uint64_t serif::solver::continuation::Result< Report, Count >::omitted_records {}

stages

template<typename Report, std::size_t Count>

std::vector<StageRecord<Count> > serif::solver::continuation::Result< Report, Count >::stages

starting_attempts

template<typename Report, std::size_t Count>

std::uint64_t serif::solver::continuation::Result< Report, Count >::starting_attempts {}

starting_work

template<typename Report, std::size_t Count>

std::uint64_t serif::solver::continuation::Result< Report, Count >::starting_work {}

status

template<typename Report, std::size_t Count>

Status serif::solver::continuation::Result< Report, Count >::status {Status::starting_star_failed}

target

template<typename Report, std::size_t Count>

std::array<double, Count> serif::solver::continuation::Result< Report, Count >::target {}

---

The documentation for this struct was generated from the following file:

• src/include/serif/solver/continuation/driver.hpp