teqp::iteration::StoppingData Struct Reference

#include <iteration.hpp>

Public Attributes
const int	N
	The number of steps that have been taken so far.
const Eigen::Array2d &	x
	The complete set of independent variables.
const Eigen::Array2d &	dx
	The complete set of steps in independent variables.
const Eigen::Array2d &	r
	The set of residual functions.
const std::vector< int > &	nonconstant_indices
	The indices where the independent variable can be varied (not T or rho)

Detailed Description

A holder class that holds references(!) to the data that is then passed to the stopping condition testing functions.

This approach is used to keep the calling signature of the stopping condition functions more concise

Definition at line 23 of file iteration.hpp.

Member Data Documentation

dx

const Eigen::Array2d& teqp::iteration::StoppingData::dx

The complete set of steps in independent variables.

Definition at line 26 of file iteration.hpp.

N

const int teqp::iteration::StoppingData::N

The number of steps that have been taken so far.

Definition at line 24 of file iteration.hpp.

nonconstant_indices

const std::vector<int>& teqp::iteration::StoppingData::nonconstant_indices

The indices where the independent variable can be varied (not T or rho)

Definition at line 28 of file iteration.hpp.

r

const Eigen::Array2d& teqp::iteration::StoppingData::r

The set of residual functions.

Definition at line 27 of file iteration.hpp.

x

const Eigen::Array2d& teqp::iteration::StoppingData::x

The complete set of independent variables.

Definition at line 25 of file iteration.hpp.

---

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

• include/teqp/algorithms/iteration.hpp