janus::RootResult< Scalar > Struct Template Reference

Result of a root finding operation. More...

#include <RootFinding.hpp>

Public Attributes
Eigen::Matrix< Scalar, Eigen::Dynamic, 1 >	x
int	iterations = 0
bool	converged = false
RootSolveMethod	method = RootSolveMethod::None
double	residual_norm = std::numeric_limits<double>::infinity()
double	step_norm = 0.0
std::string	message = ""

Detailed Description

template<typename Scalar>
struct janus::RootResult< Scalar >

Result of a root finding operation.

Member Data Documentation

converged

template<typename Scalar>

bool janus::RootResult< Scalar >::converged = false

iterations

template<typename Scalar>

int janus::RootResult< Scalar >::iterations = 0

message

template<typename Scalar>

std::string janus::RootResult< Scalar >::message = ""

method

template<typename Scalar>

RootSolveMethod janus::RootResult< Scalar >::method = RootSolveMethod::None

residual_norm

template<typename Scalar>

double janus::RootResult< Scalar >::residual_norm = std::numeric_limits<double>::infinity()

step_norm

template<typename Scalar>

double janus::RootResult< Scalar >::step_norm = 0.0

x

template<typename Scalar>

Eigen::Matrix<Scalar, Eigen::Dynamic, 1> janus::RootResult< Scalar >::x

---

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

• include/janus/math/RootFinding.hpp