The IterativeAlgorithmResult struct. Helper struct to assemble the result of an iterative algorithm. More...

#include <iterative_algorithm_result.h>

Public Member Functions
	IterativeAlgorithmResult ()=default
	IterativeAlgorithmResult.

	IterativeAlgorithmResult (real_t tol, real_t res, uint_t nitrs, std::chrono::duration< real_t > time)
	IterativeAlgorithmResult.

std::ostream &	print (std::ostream &out) const
	print

Public Attributes
real_t	tolerance
	tolerance

real_t	residual
	residual

uint_t	num_iterations
	num_iterations

bool	converged = false
	converged

std::chrono::duration< real_t >	total_time
	total_time

std::vector< real_t >	residuals
	residuals

Detailed Description

The IterativeAlgorithmResult struct. Helper struct to assemble the result of an iterative algorithm.

Constructor & Destructor Documentation

◆ IterativeAlgorithmResult() [1/2]

bitrl::utils::IterativeAlgorithmResult::IterativeAlgorithmResult ( )

default

IterativeAlgorithmResult.

◆ IterativeAlgorithmResult() [2/2]

bitrl::utils::IterativeAlgorithmResult::IterativeAlgorithmResult	(	real_t	tol,
		real_t	res,
		uint_t	nitrs,
		std::chrono::duration< real_t >	time
	)

IterativeAlgorithmResult.

Member Function Documentation

◆ print()

std::ostream & bitrl::utils::IterativeAlgorithmResult::print ( std::ostream & out ) const

print

Member Data Documentation

◆ converged

bool bitrl::utils::IterativeAlgorithmResult::converged = false

converged

◆ num_iterations

uint_t bitrl::utils::IterativeAlgorithmResult::num_iterations

num_iterations

◆ residual

real_t bitrl::utils::IterativeAlgorithmResult::residual

residual

◆ residuals

std::vector<real_t> bitrl::utils::IterativeAlgorithmResult::residuals

residuals

◆ tolerance

real_t bitrl::utils::IterativeAlgorithmResult::tolerance

tolerance

◆ total_time

std::chrono::duration<real_t> bitrl::utils::IterativeAlgorithmResult::total_time

total_time

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

libs/bitrl/src/bitrl/utils/iterative_algorithm_result.h
libs/bitrl/src/bitrl/utils/iterative_algorithm_result.cpp

Public Member Functions

Public Attributes